KRichTextEdit

#include <KRichTextEdit>

Inheritance diagram for KRichTextEdit:

Public Types

enum  Mode { Plain, Rich }
 
- Public Types inherited from QTextEdit
enum  AutoFormattingFlag
 
enum  LineWrapMode
 
- Public Types inherited from QAbstractScrollArea
enum  SizeAdjustPolicy
 
- Public Types inherited from QFrame
enum  Shadow
 
enum  Shape
 
enum  StyleMask
 
- Public Types inherited from QWidget
enum  RenderFlag
 
- Public Types inherited from QPaintDevice
enum  PaintDeviceMetric
 

Signals

void selectionFinished ()
 
void textModeChanged (KRichTextEdit::Mode mode)
 
- Signals inherited from KTextEdit
void aboutToShowContextMenu (QMenu *menu)
 
void checkSpellingChanged (bool)
 
void languageChanged (const QString &language)
 
void spellCheckerAutoCorrect (const QString &currentWord, const QString &autoCorrectWord)
 
void spellCheckingCanceled ()
 
void spellCheckingFinished ()
 
void spellCheckStatus (const QString &)
 

Public Slots

void alignCenter ()
 
void alignJustify ()
 
void alignLeft ()
 
void alignRight ()
 
void indentListLess ()
 
void indentListMore ()
 
void insertHorizontalRule ()
 
void insertPlainTextImplementation ()
 
void makeLeftToRight ()
 
void makeRightToLeft ()
 
void setFont (const QFont &font)
 
void setFontFamily (const QString &fontFamily)
 
void setFontSize (int size)
 
void setHeadingLevel (int level)
 
void setListStyle (int _styleIndex)
 
void setTextBackgroundColor (const QColor &color)
 
void setTextBold (bool bold)
 
void setTextForegroundColor (const QColor &color)
 
void setTextItalic (bool italic)
 
void setTextStrikeOut (bool strikeOut)
 
void setTextSubScript (bool subscript)
 
void setTextSuperScript (bool superscript)
 
void setTextUnderline (bool underline)
 
void switchToPlainText ()
 
QString toCleanHtml () const
 
- Public Slots inherited from KTextEdit
void addTextDecorator (Sonnet::SpellCheckDecorator *decorator)
 
void checkSpelling ()
 
void clearDecorator ()
 
void replace ()
 
void setSpellCheckingLanguage (const QString &language)
 
void showSpellConfigDialog (const QString &windowIcon=QString())
 

Public Member Functions

 KRichTextEdit (const QString &text, QWidget *parent=nullptr)
 
 KRichTextEdit (QWidget *parent=nullptr)
 
 ~KRichTextEdit () override
 
bool canDedentList () const
 
bool canIndentList () const
 
QString currentLinkText () const
 
QString currentLinkUrl () const
 
void enableRichTextMode ()
 
void selectLinkText (QTextCursor *cursor) const
 
void selectLinkText () const
 
void setTextOrHtml (const QString &text)
 
Mode textMode () const
 
QString textOrHtml () const
 
void updateLink (const QString &linkUrl, const QString &linkText)
 
- Public Member Functions inherited from KTextEdit
 KTextEdit (const QString &text, QWidget *parent=nullptr)
 
 KTextEdit (QWidget *parent=nullptr)
 
 ~KTextEdit () override
 
virtual bool checkSpellingEnabled () const
 
QString clickMessage () const
 
virtual void createHighlighter ()
 
void enableFindReplace (bool enabled)
 
void forceSpellChecking ()
 
Sonnet::Highlighterhighlighter () const
 
void highlightWord (int length, int pos)
 
virtual QMenumousePopupMenu ()
 
virtual void setCheckSpellingEnabled (bool check)
 
void setClickMessage (const QString &msg)
 
void setHighlighter (Sonnet::Highlighter *_highLighter)
 
virtual void setReadOnly (bool readOnly)
 
virtual bool shouldBlockBeSpellChecked (const QString &block) const
 
void showAutoCorrectButton (bool show)
 
void showTabAction (bool show)
 
const QStringspellCheckingLanguage () const
 
- Public Member Functions inherited from QTextEdit
 QTextEdit (QWidget *parent)
 
 QTextEdit (const QString &text, QWidget *parent)
 
bool acceptRichText () const const
 
Qt::Alignment alignment () const const
 
QString anchorAt (const QPoint &pos) const const
 
void append (const QString &text)
 
QTextEdit::AutoFormatting autoFormatting () const const
 
bool canPaste () const const
 
void clear ()
 
void copy ()
 
void copyAvailable (bool yes)
 
QMenucreateStandardContextMenu (const QPoint &position)
 
QMenucreateStandardContextMenu ()
 
QTextCharFormat currentCharFormat () const const
 
void currentCharFormatChanged (const QTextCharFormat &f)
 
QFont currentFont () const const
 
QTextCursor cursorForPosition (const QPoint &pos) const const
 
void cursorPositionChanged ()
 
QRect cursorRect (const QTextCursor &cursor) const const
 
QRect cursorRect () const const
 
int cursorWidth () const const
 
void cut ()
 
QTextDocumentdocument () const const
 
QString documentTitle () const const
 
void ensureCursorVisible ()
 
QList< QTextEdit::ExtraSelectionextraSelections () const const
 
bool find (const QString &exp, QTextDocument::FindFlags options)
 
bool find (const QRegExp &exp, QTextDocument::FindFlags options)
 
bool find (const QRegularExpression &exp, QTextDocument::FindFlags options)
 
QString fontFamily () const const
 
bool fontItalic () const const
 
qreal fontPointSize () const const
 
bool fontUnderline () const const
 
int fontWeight () const const
 
virtual QVariant inputMethodQuery (Qt::InputMethodQuery property) const const override
 
void insertHtml (const QString &text)
 
void insertPlainText (const QString &text)
 
bool isReadOnly () const const
 
bool isUndoRedoEnabled () const const
 
int lineWrapColumnOrWidth () const const
 
QTextEdit::LineWrapMode lineWrapMode () const const
 
virtual QVariant loadResource (int type, const QUrl &name)
 
void mergeCurrentCharFormat (const QTextCharFormat &modifier)
 
void moveCursor (QTextCursor::MoveOperation operation, QTextCursor::MoveMode mode)
 
bool overwriteMode () const const
 
void paste ()
 
QString placeholderText () const const
 
void print (QPagedPaintDevice *printer) const const
 
void redo ()
 
void redoAvailable (bool available)
 
void scrollToAnchor (const QString &name)
 
void selectAll ()
 
void selectionChanged ()
 
void setAcceptRichText (bool accept)
 
void setAlignment (Qt::Alignment a)
 
void setAutoFormatting (QTextEdit::AutoFormatting features)
 
void setCurrentCharFormat (const QTextCharFormat &format)
 
void setCurrentFont (const QFont &f)
 
void setCursorWidth (int width)
 
void setDocument (QTextDocument *document)
 
void setDocumentTitle (const QString &title)
 
void setExtraSelections (const QList< QTextEdit::ExtraSelection > &selections)
 
void setFontFamily (const QString &fontFamily)
 
void setFontItalic (bool italic)
 
void setFontPointSize (qreal s)
 
void setFontUnderline (bool underline)
 
void setFontWeight (int weight)
 
void setHtml (const QString &text)
 
void setLineWrapColumnOrWidth (int w)
 
void setLineWrapMode (QTextEdit::LineWrapMode mode)
 
void setMarkdown (const QString &markdown)
 
void setOverwriteMode (bool overwrite)
 
void setPlaceholderText (const QString &placeholderText)
 
void setPlainText (const QString &text)
 
void setReadOnly (bool ro)
 
void setTabChangesFocus (bool b)
 
void setTabStopDistance (qreal distance)
 
void setTabStopWidth (int width)
 
void setText (const QString &text)
 
void setTextBackgroundColor (const QColor &c)
 
void setTextColor (const QColor &c)
 
void setTextCursor (const QTextCursor &cursor)
 
void setTextInteractionFlags (Qt::TextInteractionFlags flags)
 
void setUndoRedoEnabled (bool enable)
 
void setWordWrapMode (QTextOption::WrapMode policy)
 
bool tabChangesFocus () const const
 
qreal tabStopDistance () const const
 
int tabStopWidth () const const
 
QColor textBackgroundColor () const const
 
void textChanged ()
 
QColor textColor () const const
 
QTextCursor textCursor () const const
 
Qt::TextInteractionFlags textInteractionFlags () const const
 
QString toHtml () const const
 
QString toMarkdown (QTextDocument::MarkdownFeatures features) const const
 
QString toPlainText () const const
 
void undo ()
 
void undoAvailable (bool available)
 
QTextOption::WrapMode wordWrapMode () const const
 
void zoomIn (int range)
 
void zoomOut (int range)
 
- Public Member Functions inherited from QAbstractScrollArea
 QAbstractScrollArea (QWidget *parent)
 
void addScrollBarWidget (QWidget *widget, Qt::Alignment alignment)
 
QWidgetcornerWidget () const const
 
QScrollBarhorizontalScrollBar () const const
 
Qt::ScrollBarPolicy horizontalScrollBarPolicy () const const
 
QSize maximumViewportSize () const const
 
virtual QSize minimumSizeHint () const const override
 
QWidgetList scrollBarWidgets (Qt::Alignment alignment)
 
void setCornerWidget (QWidget *widget)
 
void setHorizontalScrollBar (QScrollBar *scrollBar)
 
void setHorizontalScrollBarPolicy (Qt::ScrollBarPolicy)
 
void setSizeAdjustPolicy (QAbstractScrollArea::SizeAdjustPolicy policy)
 
virtual void setupViewport (QWidget *viewport)
 
void setVerticalScrollBar (QScrollBar *scrollBar)
 
void setVerticalScrollBarPolicy (Qt::ScrollBarPolicy)
 
void setViewport (QWidget *widget)
 
QAbstractScrollArea::SizeAdjustPolicy sizeAdjustPolicy () const const
 
virtual QSize sizeHint () const const override
 
QScrollBarverticalScrollBar () const const
 
Qt::ScrollBarPolicy verticalScrollBarPolicy () const const
 
QWidgetviewport () const const
 
- Public Member Functions inherited from QFrame
 QFrame (QWidget *parent, Qt::WindowFlags f)
 
QRect frameRect () const const
 
QFrame::Shadow frameShadow () const const
 
QFrame::Shape frameShape () const const
 
int frameStyle () const const
 
int frameWidth () const const
 
int lineWidth () const const
 
int midLineWidth () const const
 
void setFrameRect (const QRect &)
 
void setFrameShadow (QFrame::Shadow)
 
void setFrameShape (QFrame::Shape)
 
void setFrameStyle (int style)
 
void setLineWidth (int)
 
void setMidLineWidth (int)
 
- Public Member Functions inherited from QWidget
 QWidget (QWidget *parent, Qt::WindowFlags f)
 
bool acceptDrops () const const
 
QString accessibleDescription () const const
 
QString accessibleName () const const
 
QList< QAction * > actions () const const
 
void activateWindow ()
 
void addAction (QAction *action)
 
void addActions (QList< QAction * > actions)
 
void adjustSize ()
 
bool autoFillBackground () const const
 
QPalette::ColorRole backgroundRole () const const
 
QBackingStorebackingStore () const const
 
QSize baseSize () const const
 
QWidgetchildAt (int x, int y) const const
 
QWidgetchildAt (const QPoint &p) const const
 
QRect childrenRect () const const
 
QRegion childrenRegion () const const
 
void clearFocus ()
 
void clearMask ()
 
bool close ()
 
QMargins contentsMargins () const const
 
QRect contentsRect () const const
 
Qt::ContextMenuPolicy contextMenuPolicy () const const
 
QCursor cursor () const const
 
void customContextMenuRequested (const QPoint &pos)
 
WId effectiveWinId () const const
 
void ensurePolished () const const
 
Qt::FocusPolicy focusPolicy () const const
 
QWidgetfocusProxy () const const
 
QWidgetfocusWidget () const const
 
const QFontfont () const const
 
QFontInfo fontInfo () const const
 
QFontMetrics fontMetrics () const const
 
QPalette::ColorRole foregroundRole () const const
 
QRect frameGeometry () const const
 
QSize frameSize () const const
 
const QRectgeometry () const const
 
void getContentsMargins (int *left, int *top, int *right, int *bottom) const const
 
QPixmap grab (const QRect &rectangle)
 
void grabGesture (Qt::GestureType gesture, Qt::GestureFlags flags)
 
void grabKeyboard ()
 
void grabMouse ()
 
void grabMouse (const QCursor &cursor)
 
int grabShortcut (const QKeySequence &key, Qt::ShortcutContext context)
 
QGraphicsEffectgraphicsEffect () const const
 
QGraphicsProxyWidgetgraphicsProxyWidget () const const
 
bool hasEditFocus () const const
 
bool hasFocus () const const
 
virtual bool hasHeightForWidth () const const
 
bool hasMouseTracking () const const
 
bool hasTabletTracking () const const
 
int height () const const
 
virtual int heightForWidth (int w) const const
 
void hide ()
 
Qt::InputMethodHints inputMethodHints () const const
 
void insertAction (QAction *before, QAction *action)
 
void insertActions (QAction *before, QList< QAction * > actions)
 
bool isActiveWindow () const const
 
bool isAncestorOf (const QWidget *child) const const
 
bool isEnabled () const const
 
bool isEnabledTo (const QWidget *ancestor) const const
 
bool isEnabledToTLW () const const
 
bool isFullScreen () const const
 
bool isHidden () const const
 
bool isMaximized () const const
 
bool isMinimized () const const
 
bool isModal () const const
 
bool isTopLevel () const const
 
bool isVisible () const const
 
bool isVisibleTo (const QWidget *ancestor) const const
 
bool isWindow () const const
 
bool isWindowModified () const const
 
QLayoutlayout () const const
 
Qt::LayoutDirection layoutDirection () const const
 
QLocale locale () const const
 
void lower ()
 
QPoint mapFrom (const QWidget *parent, const QPoint &pos) const const
 
QPoint mapFromGlobal (const QPoint &pos) const const
 
QPoint mapFromParent (const QPoint &pos) const const
 
QPoint mapTo (const QWidget *parent, const QPoint &pos) const const
 
QPoint mapToGlobal (const QPoint &pos) const const
 
QPoint mapToParent (const QPoint &pos) const const
 
QRegion mask () const const
 
int maximumHeight () const const
 
QSize maximumSize () const const
 
int maximumWidth () const const
 
int minimumHeight () const const
 
QSize minimumSize () const const
 
int minimumWidth () const const
 
void move (int x, int y)
 
void move (const QPoint &)
 
QWidgetnativeParentWidget () const const
 
QWidgetnextInFocusChain () const const
 
QRect normalGeometry () const const
 
void overrideWindowFlags (Qt::WindowFlags flags)
 
virtual QPaintEnginepaintEngine () const const override
 
const QPalettepalette () const const
 
QWidgetparentWidget () const const
 
QPoint pos () const const
 
QWidgetpreviousInFocusChain () const const
 
 QWIDGETSIZE_MAX QWIDGETSIZE_MAX
 
void raise ()
 
QRect rect () const const
 
void releaseKeyboard ()
 
void releaseMouse ()
 
void releaseShortcut (int id)
 
void removeAction (QAction *action)
 
void render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::RenderFlags renderFlags)
 
void render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::RenderFlags renderFlags)
 
void repaint ()
 
void repaint (int x, int y, int w, int h)
 
void repaint (const QRect &rect)
 
void repaint (const QRegion &rgn)
 
void resize (int w, int h)
 
void resize (const QSize &)
 
bool restoreGeometry (const QByteArray &geometry)
 
QByteArray saveGeometry () const const
 
QScreenscreen () const const
 
void scroll (int dx, int dy)
 
void scroll (int dx, int dy, const QRect &r)
 
void setAcceptDrops (bool on)
 
void setAccessibleDescription (const QString &description)
 
void setAccessibleName (const QString &name)
 
void setAttribute (Qt::WidgetAttribute attribute, bool on)
 
void setAutoFillBackground (bool enabled)
 
void setBackgroundRole (QPalette::ColorRole role)
 
void setBaseSize (int basew, int baseh)
 
void setBaseSize (const QSize &)
 
void setContentsMargins (const QMargins &margins)
 
void setContentsMargins (int left, int top, int right, int bottom)
 
void setContextMenuPolicy (Qt::ContextMenuPolicy policy)
 
void setCursor (const QCursor &)
 
void setDisabled (bool disable)
 
void setEditFocus (bool enable)
 
void setEnabled (bool)
 
void setFixedHeight (int h)
 
void setFixedSize (const QSize &s)
 
void setFixedSize (int w, int h)
 
void setFixedWidth (int w)
 
void setFocus (Qt::FocusReason reason)
 
void setFocus ()
 
void setFocusPolicy (Qt::FocusPolicy policy)
 
void setFocusProxy (QWidget *w)
 
void setFont (const QFont &)
 
void setForegroundRole (QPalette::ColorRole role)
 
void setGeometry (const QRect &)
 
void setGeometry (int x, int y, int w, int h)
 
void setGraphicsEffect (QGraphicsEffect *effect)
 
void setHidden (bool hidden)
 
void setInputMethodHints (Qt::InputMethodHints hints)
 
void setLayout (QLayout *layout)
 
void setLayoutDirection (Qt::LayoutDirection direction)
 
void setLocale (const QLocale &locale)
 
void setMask (const QBitmap &bitmap)
 
void setMask (const QRegion &region)
 
void setMaximumHeight (int maxh)
 
void setMaximumSize (int maxw, int maxh)
 
void setMaximumSize (const QSize &)
 
void setMaximumWidth (int maxw)
 
void setMinimumHeight (int minh)
 
void setMinimumSize (const QSize &)
 
void setMinimumSize (int minw, int minh)
 
void setMinimumWidth (int minw)
 
void setMouseTracking (bool enable)
 
void setPalette (const QPalette &)
 
void setParent (QWidget *parent, Qt::WindowFlags f)
 
void setParent (QWidget *parent)
 
void setShortcutAutoRepeat (int id, bool enable)
 
void setShortcutEnabled (int id, bool enable)
 
void setSizeIncrement (const QSize &)
 
void setSizeIncrement (int w, int h)
 
void setSizePolicy (QSizePolicy)
 
void setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)
 
void setStatusTip (const QString &)
 
void setStyle (QStyle *style)
 
void setStyleSheet (const QString &styleSheet)
 
void setTabletTracking (bool enable)
 
void setToolTip (const QString &)
 
void setToolTipDuration (int msec)
 
void setUpdatesEnabled (bool enable)
 
void setupUi (QWidget *widget)
 
virtual void setVisible (bool visible)
 
void setWhatsThis (const QString &)
 
void setWindowFilePath (const QString &filePath)
 
void setWindowFlag (Qt::WindowType flag, bool on)
 
void setWindowFlags (Qt::WindowFlags type)
 
void setWindowIcon (const QIcon &icon)
 
void setWindowIconText (const QString &)
 
void setWindowModality (Qt::WindowModality windowModality)
 
void setWindowModified (bool)
 
void setWindowOpacity (qreal level)
 
void setWindowRole (const QString &role)
 
void setWindowState (Qt::WindowStates windowState)
 
void setWindowTitle (const QString &)
 
void show ()
 
void showFullScreen ()
 
void showMaximized ()
 
void showMinimized ()
 
void showNormal ()
 
QSize size () const const
 
QSize sizeIncrement () const const
 
QSizePolicy sizePolicy () const const
 
void stackUnder (QWidget *w)
 
QString statusTip () const const
 
QStylestyle () const const
 
QString styleSheet () const const
 
bool testAttribute (Qt::WidgetAttribute attribute) const const
 
QString toolTip () const const
 
int toolTipDuration () const const
 
QWidgettopLevelWidget () const const
 
bool underMouse () const const
 
void ungrabGesture (Qt::GestureType gesture)
 
void unsetCursor ()
 
void unsetLayoutDirection ()
 
void unsetLocale ()
 
void update (int x, int y, int w, int h)
 
void update (const QRect &rect)
 
void update (const QRegion &rgn)
 
void update ()
 
void updateGeometry ()
 
bool updatesEnabled () const const
 
QRegion visibleRegion () const const
 
QString whatsThis () const const
 
int width () const const
 
QWidgetwindow () const const
 
QString windowFilePath () const const
 
Qt::WindowFlags windowFlags () const const
 
QWindowwindowHandle () const const
 
QIcon windowIcon () const const
 
void windowIconChanged (const QIcon &icon)
 
QString windowIconText () const const
 
void windowIconTextChanged (const QString &iconText)
 
Qt::WindowModality windowModality () const const
 
qreal windowOpacity () const const
 
QString windowRole () const const
 
Qt::WindowStates windowState () const const
 
QString windowTitle () const const
 
void windowTitleChanged (const QString &title)
 
Qt::WindowType windowType () const const
 
WId winId () const const
 
int x () const const
 
int y () const const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 
- Public Member Functions inherited from QPaintDevice
int colorCount () const const
 
int depth () const const
 
int devicePixelRatio () const const
 
qreal devicePixelRatioF () const const
 
int height () const const
 
int heightMM () const const
 
int logicalDpiX () const const
 
int logicalDpiY () const const
 
bool paintingActive () const const
 
int physicalDpiX () const const
 
int physicalDpiY () const const
 
int width () const const
 
int widthMM () const const
 

Protected Member Functions

void keyPressEvent (QKeyEvent *event) override
 
- Protected Member Functions inherited from KTextEdit
void contextMenuEvent (QContextMenuEvent *) override
 
virtual void deleteWordBack ()
 
virtual void deleteWordForward ()
 
bool event (QEvent *) override
 
void focusInEvent (QFocusEvent *) override
 
void keyPressEvent (QKeyEvent *) override
 
- Protected Member Functions inherited from QTextEdit
virtual bool canInsertFromMimeData (const QMimeData *source) const const
 
virtual void changeEvent (QEvent *e) override
 
virtual QMimeDatacreateMimeDataFromSelection () const const
 
virtual void dragEnterEvent (QDragEnterEvent *e) override
 
virtual void dragLeaveEvent (QDragLeaveEvent *e) override
 
virtual void dragMoveEvent (QDragMoveEvent *e) override
 
virtual void dropEvent (QDropEvent *e) override
 
virtual bool focusNextPrevChild (bool next) override
 
virtual void focusOutEvent (QFocusEvent *e) override
 
virtual void inputMethodEvent (QInputMethodEvent *e) override
 
virtual void insertFromMimeData (const QMimeData *source)
 
virtual void keyReleaseEvent (QKeyEvent *e) override
 
virtual void mouseDoubleClickEvent (QMouseEvent *e) override
 
virtual void mouseMoveEvent (QMouseEvent *e) override
 
virtual void mousePressEvent (QMouseEvent *e) override
 
virtual void mouseReleaseEvent (QMouseEvent *e) override
 
virtual void paintEvent (QPaintEvent *event) override
 
virtual void resizeEvent (QResizeEvent *e) override
 
virtual void scrollContentsBy (int dx, int dy) override
 
virtual void showEvent (QShowEvent *) override
 
virtual void wheelEvent (QWheelEvent *e) override
 
- Protected Member Functions inherited from QAbstractScrollArea
void setViewportMargins (int left, int top, int right, int bottom)
 
void setViewportMargins (const QMargins &margins)
 
virtual bool viewportEvent (QEvent *event)
 
QMargins viewportMargins () const const
 
virtual QSize viewportSizeHint () const const
 
- Protected Member Functions inherited from QFrame
void initStyleOption (QStyleOptionFrame *option) const const
 
- Protected Member Functions inherited from QWidget
virtual void actionEvent (QActionEvent *event)
 
virtual void closeEvent (QCloseEvent *event)
 
void create (WId window, bool initializeWindow, bool destroyOldWindow)
 
void destroy (bool destroyWindow, bool destroySubWindows)
 
virtual void enterEvent (QEvent *event)
 
bool focusNextChild ()
 
bool focusPreviousChild ()
 
virtual void hideEvent (QHideEvent *event)
 
virtual void initPainter (QPainter *painter) const const override
 
virtual void leaveEvent (QEvent *event)
 
virtual int metric (QPaintDevice::PaintDeviceMetric m) const const override
 
virtual void moveEvent (QMoveEvent *event)
 
virtual bool nativeEvent (const QByteArray &eventType, void *message, long *result)
 
virtual void tabletEvent (QTabletEvent *event)
 
void updateMicroFocus ()
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Additional Inherited Members

- Properties inherited from KTextEdit
bool checkSpellingEnabled
 
QString clickMessage
 
QString spellCheckingLanguage
 
- Properties inherited from QTextEdit
 acceptRichText
 
 autoFormatting
 
 cursorWidth
 
 document
 
 documentTitle
 
 html
 
 lineWrapColumnOrWidth
 
 lineWrapMode
 
 markdown
 
 overwriteMode
 
 placeholderText
 
 plainText
 
 readOnly
 
 tabChangesFocus
 
 tabStopDistance
 
 tabStopWidth
 
 textInteractionFlags
 
 undoRedoEnabled
 
 wordWrapMode
 
- Properties inherited from QAbstractScrollArea
 horizontalScrollBarPolicy
 
 sizeAdjustPolicy
 
 verticalScrollBarPolicy
 
- Properties inherited from QFrame
 frameRect
 
 frameShadow
 
 frameShape
 
 frameWidth
 
 lineWidth
 
 midLineWidth
 
- Properties inherited from QWidget
 acceptDrops
 
 accessibleDescription
 
 accessibleName
 
 autoFillBackground
 
 baseSize
 
 childrenRect
 
 childrenRegion
 
 contextMenuPolicy
 
 cursor
 
 enabled
 
 focus
 
 focusPolicy
 
 font
 
 frameGeometry
 
 frameSize
 
 fullScreen
 
 geometry
 
 height
 
 inputMethodHints
 
 isActiveWindow
 
 layoutDirection
 
 locale
 
 maximized
 
 maximumHeight
 
 maximumSize
 
 maximumWidth
 
 minimized
 
 minimumHeight
 
 minimumSize
 
 minimumSizeHint
 
 minimumWidth
 
 modal
 
 mouseTracking
 
 normalGeometry
 
 palette
 
 pos
 
 rect
 
 size
 
 sizeHint
 
 sizeIncrement
 
 sizePolicy
 
 statusTip
 
 styleSheet
 
 tabletTracking
 
 toolTip
 
 toolTipDuration
 
 updatesEnabled
 
 visible
 
 whatsThis
 
 width
 
 windowFilePath
 
 windowFlags
 
 windowIcon
 
 windowIconText
 
 windowModality
 
 windowModified
 
 windowOpacity
 
 windowTitle
 
 x
 
 y
 
- Properties inherited from QObject
 objectName
 
- Static Public Member Functions inherited from QWidget
QWidgetcreateWindowContainer (QWindow *window, QWidget *parent, Qt::WindowFlags flags)
 
QWidgetfind (WId id)
 
QWidgetkeyboardGrabber ()
 
QWidgetmouseGrabber ()
 
void setTabOrder (QWidget *first, QWidget *second)
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QTextEdit
 AutoAll
 
 AutoBulletList
 
typedef AutoFormatting
 
 AutoNone
 
 FixedColumnWidth
 
 FixedPixelWidth
 
 NoWrap
 
 WidgetWidth
 
- Public Attributes inherited from QAbstractScrollArea
 AdjustIgnored
 
 AdjustToContents
 
 AdjustToContentsOnFirstShow
 
- Public Attributes inherited from QFrame
 Box
 
 HLine
 
 NoFrame
 
 Panel
 
 Plain
 
 Raised
 
 Shadow_Mask
 
 Shape_Mask
 
 StyledPanel
 
 Sunken
 
 VLine
 
 WinPanel
 
- Public Attributes inherited from QWidget
 DrawChildren
 
 DrawWindowBackground
 
 IgnoreMask
 
typedef RenderFlags
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Public Attributes inherited from QPaintDevice
 PdmDepth
 
 PdmDevicePixelRatio
 
 PdmDevicePixelRatioScaled
 
 PdmDpiX
 
 PdmDpiY
 
 PdmHeight
 
 PdmHeightMM
 
 PdmNumColors
 
 PdmPhysicalDpiX
 
 PdmPhysicalDpiY
 
 PdmWidth
 
 PdmWidthMM
 
- Protected Slots inherited from KTextEdit
void slotDoFind ()
 
void slotDoReplace ()
 
void slotFind ()
 
void slotFindNext ()
 
void slotFindPrevious ()
 
void slotReplace ()
 
void slotReplaceNext ()
 
void slotSpeakText ()
 

Detailed Description

The KRichTextEdit class provides a widget to edit and display rich text.

It offers several additional rich text editing functions to KTextEdit and makes them easier to access including:

  • Changing fonts, sizes.
  • Font formatting, such as bold, underline, italic, foreground and background color.
  • Paragraph alignment
  • Ability to edit and remove hyperlinks
  • Nested list handling
  • Simple actions to insert tables. TODO

The KRichTextEdit can be in two modes: Rich text mode and plain text mode. Calling functions which modify the format/style of the text will automatically enable the rich text mode. Rich text mode is sometimes also referred to as HTML mode.

Do not call setAcceptRichText() or acceptRichText() yourself. Instead simply connect to the slots which insert the rich text, use switchToPlainText() or enableRichTextMode().

krichtextedit.png
KRichTextEdit Widget
Since
4.1

Definition at line 50 of file krichtextedit.h.

Member Enumeration Documentation

The mode the edit widget is in.

Enumerator
Plain 

Plain text mode.

Rich 

Rich text mode.

Definition at line 59 of file krichtextedit.h.

Constructor & Destructor Documentation

KRichTextEdit::KRichTextEdit ( const QString text,
QWidget parent = nullptr 
)
explicit

Constructs a KRichTextEdit object.

Private class that helps to provide binary compatibility between releases.

Parameters
textThe initial text of the text edit, which is interpreted as HTML.
parentThe parent widget

Definition at line 104 of file krichtextedit.cpp.

KRichTextEdit::KRichTextEdit ( QWidget parent = nullptr)
explicit

Constructs a KRichTextEdit object.

Parameters
parentThe parent widget

Definition at line 110 of file krichtextedit.cpp.

KRichTextEdit::~KRichTextEdit ( )
override

Destructor.

Definition at line 116 of file krichtextedit.cpp.

Member Function Documentation

void KRichTextEdit::alignCenter ( )
slot

Sets the alignment of the current block to Centered.

Definition at line 168 of file krichtextedit.cpp.

void KRichTextEdit::alignJustify ( )
slot

Sets the alignment of the current block to Justified.

Definition at line 182 of file krichtextedit.cpp.

void KRichTextEdit::alignLeft ( )
slot

Sets the alignment of the current block to Left Aligned.

Definition at line 161 of file krichtextedit.cpp.

void KRichTextEdit::alignRight ( )
slot

Sets the alignment of the current block to Right Aligned.

Definition at line 175 of file krichtextedit.cpp.

bool KRichTextEdit::canDedentList ( ) const

Returns true if the list item at the current position can be dedented.

See also
canIndentList

Definition at line 579 of file krichtextedit.cpp.

bool KRichTextEdit::canIndentList ( ) const

Returns true if the list item at the current position can be indented.

See also
canDedentList

Definition at line 574 of file krichtextedit.cpp.

QString KRichTextEdit::currentLinkText ( ) const

Returns the text of the link at the current position or an empty string if the cursor is not on a link.

See also
currentLinkUrl
Returns
The link text

Definition at line 400 of file krichtextedit.cpp.

QString KRichTextEdit::currentLinkUrl ( ) const

Returns the URL target (href) of the link at the current position or an empty string if the cursor is not on a link.

See also
currentLinkText
Returns
The link target URL

Definition at line 451 of file krichtextedit.cpp.

void KRichTextEdit::enableRichTextMode ( )

This enables rich text mode.

Nothing is done except changing the internal mode and allowing rich text pastes.

Definition at line 368 of file krichtextedit.cpp.

void KRichTextEdit::indentListLess ( )
slot

Decreases the nesting level of the current block or selected blocks.

See also
canDedentList

Definition at line 142 of file krichtextedit.cpp.

void KRichTextEdit::indentListMore ( )
slot

Increases the nesting level of the current block or selected blocks.

See also
canIndentList

Definition at line 136 of file krichtextedit.cpp.

void KRichTextEdit::insertHorizontalRule ( )
slot

Inserts a horizontal rule below the current block.

Definition at line 147 of file krichtextedit.cpp.

void KRichTextEdit::insertPlainTextImplementation ( )
slot
Since
4.10 Because of binary compatibility constraints, insertPlainText is not virtual. Therefore it must dynamically detect and call this slot.

Definition at line 303 of file krichtextedit.cpp.

void KRichTextEdit::keyPressEvent ( QKeyEvent event)
overrideprotectedvirtual

Reimplemented.

Catches key press events. Used to handle some key presses on lists.

Reimplemented from QTextEdit.

Definition at line 517 of file krichtextedit.cpp.

void KRichTextEdit::makeLeftToRight ( )
slot

Sets the direction of the current block to Left-To-Right.

Since
4.6

Definition at line 200 of file krichtextedit.cpp.

void KRichTextEdit::makeRightToLeft ( )
slot

Sets the direction of the current block to Right-To-Left.

Since
4.6

Definition at line 189 of file krichtextedit.cpp.

void KRichTextEdit::selectionFinished ( )
signal

Emitted whenever the user has finished making a selection.

(on mouse up)

void KRichTextEdit::selectLinkText ( QTextCursor cursor) const

If the cursor is on a link, sets the cursor to a selection of the text of the link.

If the cursor is not on a link, selects the current word or existing selection.

Parameters
cursorThe cursor to use to select the text.
See also
updateLink

Definition at line 414 of file krichtextedit.cpp.

void KRichTextEdit::selectLinkText ( ) const

Convenience function to select the link text using the active cursor.

See also
selectLinkText

Definition at line 407 of file krichtextedit.cpp.

void KRichTextEdit::setFont ( const QFont font)
slot

Sets the current word or selection to the font font.

Parameters
fontthe font of the text will be set to this font

Definition at line 283 of file krichtextedit.cpp.

void KRichTextEdit::setFontFamily ( const QString fontFamily)
slot

Sets the current word or selection to the font family fontFamily.

Parameters
fontFamilyThe text's font family will be changed to this one

Definition at line 265 of file krichtextedit.cpp.

void KRichTextEdit::setFontSize ( int  size)
slot

Sets the current word or selection to the font size size.

Parameters
sizeThe text's font will get this size

Definition at line 274 of file krichtextedit.cpp.

void KRichTextEdit::setHeadingLevel ( int  level)
slot

Sets the heading level of a current block or selection.

Parameters
levelHeading level (value should be between 0 and 6) (0 is "normal text", 1 is the largest heading, 6 is the smallest one)
Since
5.70

Definition at line 326 of file krichtextedit.cpp.

void KRichTextEdit::setListStyle ( int  _styleIndex)
slot

Sets the list style of the current list, or creates a new list using the current block.

The _styleindex corresponds to the QTextListFormat::Style

Parameters
_styleIndexThe list will get this style

Definition at line 129 of file krichtextedit.cpp.

void KRichTextEdit::setTextBackgroundColor ( const QColor color)
slot

Sets the background color of the current word or selection to color.

Parameters
colorThe text will get this foreground color

Definition at line 256 of file krichtextedit.cpp.

void KRichTextEdit::setTextBold ( bool  bold)
slot

Toggles the bold formatting of the current word or selection at the current cursor position.

Parameters
boldIf true, the text will be set to bold

Definition at line 211 of file krichtextedit.cpp.

void KRichTextEdit::setTextForegroundColor ( const QColor color)
slot

Sets the foreground color of the current word or selection to color.

Parameters
colorThe text will get this background color

Definition at line 247 of file krichtextedit.cpp.

void KRichTextEdit::setTextItalic ( bool  italic)
slot

Toggles the italic formatting of the current word or selection at the current cursor position.

Parameters
italicIf true, the text will be set to italic

Definition at line 220 of file krichtextedit.cpp.

void KRichTextEdit::setTextOrHtml ( const QString text)

Replaces all the content of the text edit with the given string.

If the string is in rich text format, the text is inserted as rich text, otherwise it is inserted as plain text.

Parameters
textThe text to insert

Definition at line 387 of file krichtextedit.cpp.

void KRichTextEdit::setTextStrikeOut ( bool  strikeOut)
slot

Toggles the strikeout formatting of the current word or selection at the current cursor position.

Parameters
strikeOutIf true, the text will be struck out

Definition at line 238 of file krichtextedit.cpp.

void KRichTextEdit::setTextSubScript ( bool  subscript)
slot

Toggles the subscript formatting of the current word or selection at the current cursor position.

Parameters
subscriptIf true, the text will be set to subscript

Definition at line 317 of file krichtextedit.cpp.

void KRichTextEdit::setTextSuperScript ( bool  superscript)
slot

Toggles the superscript formatting of the current word or selection at the current cursor position.

Parameters
superscriptIf true, the text will be set to superscript

Definition at line 308 of file krichtextedit.cpp.

void KRichTextEdit::setTextUnderline ( bool  underline)
slot

Toggles the underline formatting of the current word or selection at the current cursor position.

Parameters
underlineIf true, the text will be underlined

Definition at line 229 of file krichtextedit.cpp.

void KRichTextEdit::switchToPlainText ( )
slot

This will switch the editor to plain text mode.

All rich text formatting will be destroyed.

Definition at line 292 of file krichtextedit.cpp.

KRichTextEdit::Mode KRichTextEdit::textMode ( ) const
Returns
The current text mode

Definition at line 373 of file krichtextedit.cpp.

void KRichTextEdit::textModeChanged ( KRichTextEdit::Mode  mode)
signal

Emitted whenever the text mode is changed.

Parameters
modeThe new text mode
QString KRichTextEdit::textOrHtml ( ) const
Returns
The plain text string if in plain text mode or the HTML code if in rich text mode. The text is not word-wrapped.

Definition at line 378 of file krichtextedit.cpp.

QString KRichTextEdit::toCleanHtml ( ) const
slot

This will clean some of the bad html produced by the underlying QTextEdit It walks over all lines and cleans up a bit.

Should be improved to produce our own Html.

Definition at line 584 of file krichtextedit.cpp.

void KRichTextEdit::updateLink ( const QString linkUrl,
const QString linkText 
)

Replaces the current selection with a hyperlink with the link URL linkUrl and the link text linkText.

See also
selectLinkText
currentLinkUrl
currentLinkText
Parameters
linkUrlThe link will get this URL as href (target)
linkTextThe link will get this alternative text, which is the text displayed in the text edit.

Definition at line 456 of file krichtextedit.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Wed Oct 28 2020 22:57:54 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.