KRichTextWidget

#include <KRichTextWidget>

Inheritance diagram for KRichTextWidget:

[legend]

Public Types
typedef QFlags< RichTextSupportValues >	RichTextSupport

enum	RichTextSupportValues { DisableRichText = 0x00 , SupportBold = 0x01 , SupportItalic = 0x02 , SupportUnderline = 0x04 , SupportStrikeOut = 0x08 , SupportFontFamily = 0x10 , SupportFontSize = 0x20 , SupportTextForegroundColor = 0x40 , SupportTextBackgroundColor = 0x80 , FullTextFormattingSupport = 0xff , SupportChangeListStyle = 0x100 , SupportIndentLists = 0x200 , SupportDedentLists = 0x400 , FullListSupport = 0xf00 , SupportAlignment = 0x100000 , SupportRuleLine = 0x400000 , SupportHyperlinks = 0x800000 , SupportFormatPainting = 0x1000000 , SupportToPlainText = 0x2000000 , SupportSuperScriptAndSubScript = 0x4000000 , SupportDirection = 0x8000000 , SupportHeading = 0x10000000 , FullSupport = 0xffffffff }

Public Types inherited from KRichTextEdit
enum	Mode { Plain , Rich }

Public Types inherited from QTextEdit
typedef	AutoFormatting

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

typedef	RenderFlags

Public Types inherited from QObject
typedef	QObjectList

Public Types inherited from QPaintDevice
enum	PaintDeviceMetric

Properties
RichTextSupport	richTextSupport

Properties inherited from KTextEdit
bool	checkSpellingEnabled

QString	spellCheckingLanguage

Properties inherited from QTextEdit
	acceptRichText

	autoFormatting

	cursorWidth

	document

	documentTitle

	html

	lineWrapColumnOrWidth

	lineWrapMode

	markdown

	overwriteMode

	placeholderText

	plainText

	readOnly

	tabChangesFocus

	tabStopDistance

	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

Public Slots
void	setActionsEnabled (bool enabled)

Public Slots inherited from KRichTextEdit
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
	KRichTextWidget (const QString &text, QWidget *parent=nullptr)

	KRichTextWidget (QWidget *parent)

	~KRichTextWidget () override

virtual QList< QAction * >	createActions ()

RichTextSupport	richTextSupport () const

void	setRichTextSupport (const KRichTextWidget::RichTextSupport &support)

void	updateActionStates ()

Public Member Functions inherited from KRichTextEdit
	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 () const

void	selectLinkText (QTextCursor *cursor) 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

virtual void	createHighlighter ()

void	enableFindReplace (bool enabled)

void	forceSpellChecking ()

Sonnet::Highlighter *	highlighter () const

void	highlightWord (int length, int pos)

virtual QMenu *	mousePopupMenu ()

virtual void	setCheckSpellingEnabled (bool check)

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 QString &	spellCheckingLanguage () const

Public Member Functions inherited from QTextEdit
	QTextEdit (const QString &text, QWidget *parent)

	QTextEdit (QWidget *parent)

bool	acceptRichText () const const

Qt::Alignment	alignment () const const

QString	anchorAt (const QPoint &pos) const const

void	append (const QString &text)

AutoFormatting	autoFormatting () const const

bool	canPaste () const const

void	clear ()

void	copy ()

void	copyAvailable (bool yes)

QMenu *	createStandardContextMenu ()

QMenu *	createStandardContextMenu (const QPoint &position)

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 const

QRect	cursorRect (const QTextCursor &cursor) const const

int	cursorWidth () const const

void	cut ()

QTextDocument *	document () const const

QString	documentTitle () const const

void	ensureCursorVisible ()

QList< ExtraSelection >	extraSelections () const const

bool	find (const QRegularExpression &exp, QTextDocument::FindFlags options)

bool	find (const QString &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

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 (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< 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 (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	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

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)

QWidget *	cornerWidget () const const

QScrollBar *	horizontalScrollBar () 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 (SizeAdjustPolicy policy)

virtual void	setupViewport (QWidget *viewport)

void	setVerticalScrollBar (QScrollBar *scrollBar)

void	setVerticalScrollBarPolicy (Qt::ScrollBarPolicy)

void	setViewport (QWidget *widget)

SizeAdjustPolicy	sizeAdjustPolicy () const const

virtual QSize	sizeHint () const const override

QScrollBar *	verticalScrollBar () const const

Qt::ScrollBarPolicy	verticalScrollBarPolicy () const const

QWidget *	viewport () const const

Public Member Functions inherited from QFrame
	QFrame (QWidget *parent, Qt::WindowFlags f)

QRect	frameRect () const const

Shadow	frameShadow () const const

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 (Shadow)

void	setFrameShape (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 ()

QAction *	addAction (const QIcon &icon, const QString &text)

QAction *	addAction (const QIcon &icon, const QString &text, Args &&... args)

QAction *	addAction (const QIcon &icon, const QString &text, const QKeySequence &shortcut)

QAction *	addAction (const QIcon &icon, const QString &text, const QKeySequence &shortcut, Args &&... args)

QAction *	addAction (const QIcon &icon, const QString &text, const QKeySequence &shortcut, const QObject receiver, const char member, Qt::ConnectionType type)

QAction *	addAction (const QIcon &icon, const QString &text, const QObject receiver, const char member, Qt::ConnectionType type)

QAction *	addAction (const QString &text)

QAction *	addAction (const QString &text, Args &&... args)

QAction *	addAction (const QString &text, const QKeySequence &shortcut)

QAction *	addAction (const QString &text, const QKeySequence &shortcut, Args &&... args)

QAction *	addAction (const QString &text, const QKeySequence &shortcut, const QObject receiver, const char member, Qt::ConnectionType type)

QAction *	addAction (const QString &text, const QObject receiver, const char member, Qt::ConnectionType type)

void	addAction (QAction *action)

void	addActions (const QList< QAction * > &actions)

void	adjustSize ()

bool	autoFillBackground () const const

QPalette::ColorRole	backgroundRole () const const

QBackingStore *	backingStore () const const

QSize	baseSize () const const

QWidget *	childAt (const QPoint &p) const const

QWidget *	childAt (int x, int y) 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

QWidget *	focusProxy () const const

QWidget *	focusWidget () const const

const QFont &	font () const const

QFontInfo	fontInfo () const const

QFontMetrics	fontMetrics () const const

QPalette::ColorRole	foregroundRole () const const

QRect	frameGeometry () const const

QSize	frameSize () const const

const QRect &	geometry () 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)

QGraphicsEffect *	graphicsEffect () const const

QGraphicsProxyWidget *	graphicsProxyWidget () 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, const 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	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

QLayout *	layout () const const

Qt::LayoutDirection	layoutDirection () const const

QLocale	locale () const const

void	lower ()

QPoint	mapFrom (const QWidget *parent, const QPoint &pos) const const

QPointF	mapFrom (const QWidget *parent, const QPointF &pos) const const

QPoint	mapFromGlobal (const QPoint &pos) const const

QPointF	mapFromGlobal (const QPointF &pos) const const

QPoint	mapFromParent (const QPoint &pos) const const

QPointF	mapFromParent (const QPointF &pos) const const

QPoint	mapTo (const QWidget *parent, const QPoint &pos) const const

QPointF	mapTo (const QWidget *parent, const QPointF &pos) const const

QPoint	mapToGlobal (const QPoint &pos) const const

QPointF	mapToGlobal (const QPointF &pos) const const

QPoint	mapToParent (const QPoint &pos) const const

QPointF	mapToParent (const QPointF &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 (const QPoint &)

void	move (int x, int y)

QWidget *	nativeParentWidget () const const

QWidget *	nextInFocusChain () const const

QRect	normalGeometry () const const

void	overrideWindowFlags (Qt::WindowFlags flags)

virtual QPaintEngine *	paintEngine () const const override

const QPalette &	palette () const const

QWidget *	parentWidget () const const

QPoint	pos () const const

QWidget *	previousInFocusChain () 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, RenderFlags renderFlags)

void	render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, RenderFlags renderFlags)

void	repaint ()

void	repaint (const QRect &rect)

void	repaint (const QRegion &rgn)

void	repaint (int x, int y, int w, int h)

void	resize (const QSize &)

void	resize (int w, int h)

bool	restoreGeometry (const QByteArray &geometry)

QByteArray	saveGeometry () const const

QScreen *	screen () 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 (const QSize &)

void	setBaseSize (int basew, int baseh)

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 ()

void	setFocus (Qt::FocusReason reason)

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 (const QSize &)

void	setMaximumSize (int maxw, int maxh)

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)

void	setParent (QWidget *parent, Qt::WindowFlags f)

void	setScreen (QScreen *screen)

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

QStyle *	style () const const

QString	styleSheet () const const

bool	testAttribute (Qt::WidgetAttribute attribute) const const

QString	toolTip () const const

int	toolTipDuration () const const

QWidget *	topLevelWidget () const const

bool	underMouse () const const

void	ungrabGesture (Qt::GestureType gesture)

void	unsetCursor ()

void	unsetLayoutDirection ()

void	unsetLocale ()

void	update ()

void	update (const QRect &rect)

void	update (const QRegion &rgn)

void	update (int x, int y, int w, int h)

void	updateGeometry ()

bool	updatesEnabled () const const

QRegion	visibleRegion () const const

QString	whatsThis () const const

int	width () const const

QWidget *	window () const const

QString	windowFilePath () const const

Qt::WindowFlags	windowFlags () const const

QWindow *	windowHandle () 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)

QBindable< QString >	bindableObjectName ()

bool	blockSignals (bool block)

const QObjectList &	children () 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 () const const

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isQuickItemType () const const

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_GADGET_EXPORT (EXPORT_MACRO)

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_MOC_INCLUDE Q_MOC_INCLUDE

	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

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setObjectName (QAnyStringView name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	setProperty (const char *name, QVariant &&value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)

QThread *	thread () const const

Public Member Functions inherited from QPaintDevice
int	colorCount () const const

int	depth () const const

qreal	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	mouseReleaseEvent (QMouseEvent *event) override

Protected Member Functions inherited from KRichTextEdit
KTEXTWIDGETS_NO_EXPORT	KRichTextEdit (KRichTextEditPrivate &dd, const QString &text, QWidget *parent)

KTEXTWIDGETS_NO_EXPORT	KRichTextEdit (KRichTextEditPrivate &dd, QWidget *parent)

void	keyPressEvent (QKeyEvent *event) override

Protected Member Functions inherited from KTextEdit
KTEXTWIDGETS_NO_EXPORT	KTextEdit (KTextEditPrivate &dd, const QString &text, QWidget *parent)

KTEXTWIDGETS_NO_EXPORT	KTextEdit (KTextEditPrivate &dd, QWidget *parent)

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 QMimeData *	createMimeDataFromSelection () 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	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 (const QMargins &margins)

void	setViewportMargins (int left, int top, int right, int bottom)

virtual bool	viewportEvent (QEvent *event)

QMargins	viewportMargins () const const

virtual QSize	viewportSizeHint () const const

Protected Member Functions inherited from QFrame
virtual 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 (QEnterEvent *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 (PaintDeviceMetric m) const const override

virtual void	moveEvent (QMoveEvent *event)

virtual bool	nativeEvent (const QByteArray &eventType, void message, qintptr result)

virtual void	tabletEvent (QTabletEvent *event)

void	updateMicroFocus (Qt::InputMethodQuery query)

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

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Protected Member Functions inherited from QPaintDevice

Additional Inherited Members
Signals inherited from KRichTextEdit
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 &)

Static Public Member Functions inherited from QWidget
QWidget *	createWindowContainer (QWindow window, QWidget parent, Qt::WindowFlags flags)

QWidget *	find (WId id)

QWidget *	keyboardGrabber ()

QWidget *	mouseGrabber ()

void	setTabOrder (QWidget first, QWidget second)

void	setTabOrder (std::initializer_list< QWidget * > widgets)

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 context, Functor functor, 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)

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, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (const char sourceText, const char disambiguation, int n)

Public Attributes inherited from QTextEdit
	AutoAll

	AutoBulletList

	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

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 ()

Protected Attributes inherited from KTextEdit
std::unique_ptr< class KTextEditPrivate > const	d_ptr

Detailed Description

A KRichTextEdit with common actions.

This class implements common actions which are often used with KRichTextEdit. All you need to do is to call createActions(), and the actions will be added to your KXMLGUIWindow. Remember to also add the chosen actions to your application ui.rc file.

See the KRichTextWidget::RichTextSupportValues enum for an overview of supported actions.

Author: Stephen Kelly steve.nosp@m.ire@.nosp@m.gmail.nosp@m..com; Thomas McGuire thoma.nosp@m.s.mc.nosp@m.guire.nosp@m.@gmx.nosp@m..net

KRichTextWidget Widget

Since: 4.1

Definition at line 39 of file krichtextwidget.h.

Member Typedef Documentation

◆ RichTextSupport

QFlags< RichTextSupportValues > KRichTextWidget::RichTextSupport

Stores a combination of RichTextSupportValues values.

Definition at line 235 of file krichtextwidget.h.

Member Enumeration Documentation

◆ RichTextSupportValues

enum KRichTextWidget::RichTextSupportValues

These flags describe what actions will be created by createActions() after passing a combination of these flags to setRichTextSupport().

See also: RichTextSupport

Enumerator
DisableRichText	No rich text support at all, no actions will be created. Do not use in combination with other flags.
SupportBold	Action to format the selected text as bold. If no text is selected, the word under the cursor is formatted bold. This is a KToggleAction. The status is automatically updated when the text cursor is moved.
SupportItalic	Action to format the selected text as italic. If no text is selected, the word under the cursor is formatted italic. This is a KToggleAction. The status is automatically updated when the text cursor is moved.
SupportUnderline	Action to underline the selected text. If no text is selected, the word under the cursor is underlined. This is a KToggleAction. The status is automatically updated when the text cursor is moved.
SupportStrikeOut	Action to strike out the selected text. If no text is selected, the word under the cursor is struck out. This is a KToggleAction. The status is automatically updated when the text cursor is moved.
SupportFontFamily	Action to change the font family of the currently selected text. If no text is selected, the font family of the word under the cursor is changed. Displayed as a combobox when inserted into the toolbar. This is a KFontAction. The status is automatically updated when the text cursor is moved.
SupportFontSize	Action to change the font size of the currently selected text. If no text is selected, the font size of the word under the cursor is changed. Displayed as a combobox when inserted into the toolbar. This is a KFontSizeAction. The status is automatically updated when the text cursor is moved.
SupportTextForegroundColor	Action to change the text color of the currently selected text. If no text is selected, the text color of the word under the cursor is changed. Opens a QColorDialog to select the color.
SupportTextBackgroundColor	Action to change the background color of the currently selected text. If no text is selected, the background color of the word under the cursor is changed. Opens a QColorDialog to select the color.
FullTextFormattingSupport	A combination of all the flags above. Includes all actions that change the format of the text.
SupportChangeListStyle	Action to make the current line a list element, change the list style or remove list formatting. Displayed as a combobox when inserted into a toolbar. This is a KSelectAction. The status is automatically updated when the text cursor is moved.
SupportIndentLists	Action to increase the current list nesting level. This makes it possible to create nested lists.
SupportDedentLists	Action to decrease the current list nesting level.
FullListSupport	All of the three list actions above. Includes all list-related actions.
SupportAlignment	Actions to align the current paragraph left, righ, center or justify. These actions are KToogleActions. The status is automatically updated when the text cursor is moved.
SupportRuleLine	Action to insert a horizontal line.
SupportHyperlinks	Action to convert the current text to a hyperlink. If no text is selected, the word under the cursor is converted. This action opens a dialog where the user can enter the link target.
SupportFormatPainting	Action to make the mouse cursor a format painter. The user can select text with that painter. The selected text gets the same format as the text that was previously selected.
SupportToPlainText	Action to change the text of the whole text edit to plain text. All rich text formatting will get lost.
SupportSuperScriptAndSubScript	Actions to format text as superscript or subscript. If no text is selected, the word under the cursor is formatted as selected. This is a KToggleAction. The status is automatically updated when the text cursor is moved.
SupportDirection	Action to change direction of text to Right-To-Left or Left-To-Right.
SupportHeading	Action to make the current line a heading (up to six levels, corresponding to HTML h1...h6 tags) Displayed as a combobox when inserted into a toolbar. This is a KSelectAction. The status is automatically updated when the text cursor is moved. Since 5.70
FullSupport	Includes all above actions for full rich text support.

Definition at line 49 of file krichtextwidget.h.

Property Documentation

◆ richTextSupport

RichTextSupport KRichTextWidget::richTextSupport

readwrite

Definition at line 42 of file krichtextwidget.h.

Constructor & Destructor Documentation

◆ KRichTextWidget() [1/2]

KRichTextWidget::KRichTextWidget ( QWidget * parent )

explicit

Constructor.

Parameters

parent the parent widget

◆ KRichTextWidget() [2/2]

KRichTextWidget::KRichTextWidget	(	const QString &	text,
		QWidget *	parent = nullptr )

explicit

Constructs a KRichTextWidget object.

Parameters

text	The initial text of the text edit, which is interpreted as HTML.
parent	The parent widget

◆ ~KRichTextWidget()

KRichTextWidget::~KRichTextWidget ( )

override

Destructor.

Member Function Documentation

◆ createActions()

virtual QList< QAction * > KRichTextWidget::createActions ( )

virtual

Creates the actions and adds them to the given action collection.

Call this before calling setupGUI() in your application, but after calling setRichTextSupport().

The XML file of your KXmlGuiWindow needs to have the action names in them, so that the actions actually appear in the menu and in the toolbars.

Below is a list of actions that are created,depending on the supported rich text subset set by setRichTextSupport(). The list contains action names. Those names need to be the same in your XML file.

See the KRichTextWidget::RichTextSupportValues enum documentation for a detailed explanation of each action.

XML Name	RichTextSupportValues flag
format_text_foreground_color	SupportTextForegroundColor
format_text_background_color	SupportTextBackgroundColor
format_font_family	SupportFontFamily
format_font_size	SupportFontSize
format_text_bold	SupportBold
format_text_italic	SupportItalic
format_text_underline	SupportUnderline
format_text_strikeout	SupportStrikeOut
format_align_left	SupportAlignment
format_align_center	SupportAlignment
format_align_right	SupportAlignment
format_align_justify	SupportAlignment
direction_ltr	SupportDirection
direction_rtl	SupportDirection
format_list_style	SupportChangeListStyle
format_list_indent_more	SupportIndentLists
format_list_indent_less	SupportDedentLists
insert_horizontal_rule	SupportRuleLine
manage_link	SupportHyperlinks
format_painter	SupportFormatPainting
action_to_plain_text	SupportToPlainText
format_text_subscript & format_text_superscript	SupportSuperScriptAndSubScript
format_heading_level	SupportHeading

Since: 5.0

◆ mouseReleaseEvent()

void KRichTextWidget::mouseReleaseEvent ( QMouseEvent * event )

overrideprotectedvirtual

Reimplemented.

Catches mouse release events. Used to know when a selection has been completed.

Reimplemented from QTextEdit.

Definition at line 681 of file krichtextwidget.cpp.

◆ richTextSupport()

RichTextSupport KRichTextWidget::richTextSupport ( ) const

Returns the supported rich text subset available.

Returns: The supported subset.

◆ setActionsEnabled

void KRichTextWidget::setActionsEnabled ( bool enabled )

slot

Disables or enables all of the actions created by createActions().

This may be useful in cases where rich text mode may be set on or off.

Parameters

enabled Whether to enable or disable the actions.

Definition at line 516 of file krichtextwidget.cpp.

◆ setRichTextSupport()

void KRichTextWidget::setRichTextSupport ( const KRichTextWidget::RichTextSupport & support )

Sets the supported rich text subset available.

The default is KRichTextWidget::FullSupport and will be set in the constructor.

You need to call createActions() afterwards.

Parameters

support The supported subset.

◆ updateActionStates()

void KRichTextWidget::updateActionStates ( )

Tells KRichTextWidget to update the state of the actions created by createActions().

This is normally automatically done, but there might be a few cases where you'll need to manually call this function.

Call this function only after calling createActions().

Definition at line 714 of file krichtextwidget.cpp.

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

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About KTextWidgets

KRichTextWidget

Public Types

Properties

Public Slots

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ RichTextSupport

Member Enumeration Documentation

◆ RichTextSupportValues

Property Documentation

◆ richTextSupport

Constructor & Destructor Documentation

◆ KRichTextWidget() [1/2]

◆ KRichTextWidget() [2/2]

◆ ~KRichTextWidget()

Member Function Documentation

◆ createActions()

◆ mouseReleaseEvent()

◆ richTextSupport()

◆ setActionsEnabled

◆ setRichTextSupport()

◆ updateActionStates()