Search for usage in LXR

#include <richtextcomposer.h>

Inheritance diagram for KPIMTextEdit::RichTextComposer:

Public Types

enum  Mode { Plain, Rich }


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::RichTextComposerActionscomposerActions () const
KPIMTextEdit::RichTextComposerControlercomposerControler () const
void createActions (KActionCollection *ac)
void createHighlighter () override
const QString defaultQuoteSign () const
void disableWordWrap ()
void enableWordWrap (int wrapColumn)
KPIMTextEdit::RichTextExternalComposerexternalComposer () 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::SpellCheckDecoratorcreateSpellCheckDecorator () 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.

Laurent Montel

Definition at line 24 of file richtextcomposer.h.

Member Enumeration Documentation

◆ Mode


Plain text mode.


Rich text mode.

Definition at line 31 of file richtextcomposer.h.

Member Function Documentation

◆ columnNumber()

int RichTextComposer::columnNumber ( ) const
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.

wrapColumnthe column where words will be wrapped

Definition at line 169 of file richtextcomposer.cpp.

◆ focusUp

void KPIMTextEdit::RichTextComposer::focusUp ( )

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
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
The current text mode

Definition at line 164 of file richtextcomposer.cpp.

◆ textModeChanged

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

Emitted whenever the text mode is changed.

modeThe new text mode

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Sat Dec 2 2023 04:13:44 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.