KPIMTextEdit::RichTextComposer Class Reference

#include <richtextcomposer.h>

Inheritance diagram for KPIMTextEdit::RichTextComposer:

Public Types
enum	Mode { Plain, Rich }

Signals
void	externalEditorClosed ()
void	externalEditorStarted ()
void	focusUp ()
void	insertEmoticon (const QString &str)
void	insertModeChanged ()
void	textModeChanged (KPIMTextEdit::RichTextComposer::Mode mode)

Public Slots
void	insertPlainTextImplementation ()
void	slotChangeInsertMode ()

Public Member Functions
	RichTextComposer (QWidget *parent=nullptr)
void	activateRichText ()
bool	checkExternalEditorFinished ()
int	columnNumber () const
KPIMTextEdit::RichTextComposerActions *	composerActions () const
KPIMTextEdit::RichTextComposerControler *	composerControler () const
void	createActions (KActionCollection *ac)
void	createHighlighter () override
const QString	defaultQuoteSign () const
void	disableWordWrap ()
void	enableWordWrap (int wrapColumn)
KPIMTextEdit::RichTextExternalComposer *	externalComposer () const
void	forcePlainTextMarkup (bool force)
bool	isLineQuoted (const QString &line) const
void	killExternalEditor ()
int	linePosition () const
virtual bool	processModifyText (QKeyEvent *event)
int	quoteLength (const QString &line, bool oneQuote=false) const
QString	quotePrefixName () const
QList< QAction * >	richTextActionList () const
void	setCursorPositionFromStart (unsigned int pos)
void	setEnableActions (bool state)
void	setExternalEditorPath (const QString &path)
virtual void	setHighlighterColors (KPIMTextEdit::RichTextComposerEmailQuoteHighlighter *highlighter)
void	setQuotePrefixName (const QString &quotePrefix)
void	setTextOrHtml (const QString &text)
void	setUseExternalEditor (bool use)
virtual QString	smartQuote (const QString &msg)
void	switchToPlainText ()
Mode	textMode () const
QString	textOrHtml () const

Protected Member Functions
bool	canInsertFromMimeData (const QMimeData *source) const override
void	clearDecorator () override
Sonnet::SpellCheckDecorator *	createSpellCheckDecorator () override
void	insertFromMimeData (const QMimeData *source) override
void	keyPressEvent (QKeyEvent *event) override
void	mouseReleaseEvent (QMouseEvent *event) override
bool	processKeyEvent (QKeyEvent *e)
void	updateHighLighter () override

Detailed Description

The RichTextComposer class.

Author

Laurent Montel monte.nosp@m.l@kd.nosp@m.e.org

Definition at line 24 of file richtextcomposer.h.

Member Enumeration Documentation

Mode

enum KPIMTextEdit::RichTextComposer::Mode

Enumerator
Plain	Plain text mode.
Rich	Rich text mode.

Definition at line 31 of file richtextcomposer.h.

Member Function Documentation

columnNumber()

int RichTextComposer::columnNumber

(

)

const

Returns

the column number where the cursor is.

Definition at line 230 of file richtextcomposer.cpp.

disableWordWrap()

void RichTextComposer::disableWordWrap

(

)

Disables word wrap.

Note that words are still wrapped at the end of the editor; no scrollbar will appear.

Definition at line 176 of file richtextcomposer.cpp.

enableWordWrap()

void RichTextComposer::enableWordWrap

(

int

wrapColumn

)

Enables word wrap.

Words will be wrapped at the specified column.

Parameters

wrapColumn

the column where words will be wrapped

Definition at line 169 of file richtextcomposer.cpp.

focusUp

void KPIMTextEdit::RichTextComposer::focusUp ( )

signal

Emitted when the user uses the up arrow in the first line.

The application should then put the focus on the widget above the text edit.

linePosition()

int RichTextComposer::linePosition

(

)

const

Returns

the line number where the cursor is. This takes word-wrapping into account. Line numbers start at 0.

Definition at line 181 of file richtextcomposer.cpp.

textMode()

RichTextComposer::Mode RichTextComposer::textMode

(

)

const

Returns

The current text mode

Definition at line 164 of file richtextcomposer.cpp.

textModeChanged

void KPIMTextEdit::RichTextComposer::textModeChanged ( KPIMTextEdit::RichTextComposer::Mode  mode )

signal

Emitted whenever the text mode is changed.

Parameters

mode	The new text mode

---

The documentation for this class was generated from the following files:

• richtextcomposer.h
• richtextcomposer.cpp