KTextEdit

#include <KTextEdit>

Inheritance diagram for KTextEdit:

[legend]

Properties
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

Signals
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	addTextDecorator (Sonnet::SpellCheckDecorator *decorator)

void	checkSpelling ()

void	clearDecorator ()

void	replace ()

void	setSpellCheckingLanguage (const QString &language)

void	showSpellConfigDialog (const QString &windowIcon=QString())

Public Member Functions
	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::Highlighter *	highlighter () const

void	highlightWord (int length, int pos)

virtual QMenu *	mousePopupMenu ()

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

QTextEdit::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< QTextEdit::ExtraSelection >	extraSelections () const const

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

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

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)

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

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

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

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

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)

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

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

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

void	render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::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	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)

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

void	dumpObjectInfo () const const

void	dumpObjectTree ()

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 QRegExp &regExp, 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

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

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

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

QThread *	thread () 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 Slots
void	slotDoFind ()

void	slotDoReplace ()

void	slotFind ()

void	slotFindNext ()

void	slotFindPrevious ()

void	slotReplace ()

void	slotReplaceNext ()

void	slotSpeakText ()

Protected Member Functions
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	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 (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
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

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Additional Inherited Members
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

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)

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)

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

Detailed Description

A KDE'ified QTextEdit.

This is just a little subclass of QTextEdit, implementing some standard KDE features, like cursor auto-hiding, configurable wheelscrolling (fast-scroll or zoom), spell checking and deleting of entire words with Ctrl-Backspace or Ctrl-Delete.

This text edit provides two ways of spell checking: background checking, which will mark incorrectly spelled words red, and a spell check dialog, which lets the user check and correct all incorrectly spelled words.

Basic rule: whenever you want to use QTextEdit, use KTextEdit!

KTextEdit Widget

See also: QTextEdit

Author: Carsten Pfeiffer pfeif[email protected][email protected][email protected]kde.o[email protected]rg

Definition at line 45 of file ktextedit.h.

Constructor & Destructor Documentation

◆ KTextEdit() [1/2]

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

explicit

Constructs a KTextEdit object.

See QTextEdit::QTextEdit for details.

Definition at line 230 of file ktextedit.cpp.

◆ KTextEdit() [2/2]

KTextEdit::KTextEdit ( QWidget * parent = nullptr )

explicit

Constructs a KTextEdit object.

See QTextEdit::QTextEdit for details.

Definition at line 244 of file ktextedit.cpp.

◆ ~KTextEdit()

KTextEdit::~KTextEdit ( )

overridedefault

Destroys the KTextEdit object.

Member Function Documentation

◆ aboutToShowContextMenu

void KTextEdit::aboutToShowContextMenu ( QMenu * menu )

signal

Emitted before the context menu is displayed.

The signal allows you to add your own entries into the the context menu that is created on demand.

NOTE: Do not store the pointer to the QMenu provided through since it is created and deleted on demand.

Parameters

p	the context menu about to be displayed

Since: 4.5

◆ addTextDecorator

void KTextEdit::addTextDecorator ( Sonnet::SpellCheckDecorator * decorator )

slot

Add custom spell checker decorator.

Since: 5.11

Definition at line 629 of file ktextedit.cpp.

◆ checkSpelling

void KTextEdit::checkSpelling ( )

slot

Show a dialog to check the spelling.

The spellCheckStatus() signal will be emitted when the spell checking dialog is closed.

Definition at line 738 of file ktextedit.cpp.

◆ checkSpellingChanged

void KTextEdit::checkSpellingChanged ( bool )

signal

emit signal when we activate or not autospellchecking

Since: 4.1

◆ checkSpellingEnabled()

virtual bool KTextEdit::checkSpellingEnabled ( ) const

virtual

Returns true if background spell checking is enabled for this text edit.

Note that it even returns true if this is a read-only KTextEdit, where spell checking is actually disabled. By default spell checking is disabled.

See also: setCheckSpellingEnabled()

◆ clearDecorator

void KTextEdit::clearDecorator ( )

slot

clearDecorator clear the spellcheckerdecorator

Since: 5.11

Definition at line 618 of file ktextedit.cpp.

◆ clickMessage()

QString KTextEdit::clickMessage ( ) const

inline

Returns: the message set with setClickMessage

Deprecated:: since 5.0, use QTextEdit::placeholderText instead

Definition at line 204 of file ktextedit.h.

◆ contextMenuEvent()

void KTextEdit::contextMenuEvent ( QContextMenuEvent * event )

overrideprotectedvirtual

Reimplemented from QTextEdit to add spelling related items when appropriate.

Reimplemented from QTextEdit.

Definition at line 592 of file ktextedit.cpp.

◆ createHighlighter()

void KTextEdit::createHighlighter ( )

virtual

Allows to create a specific highlighter if reimplemented.

By default, it creates a normal highlighter, based on the config file given to setSpellCheckingConfigFileName().

This highlighter is set each time spell checking is toggled on by calling setCheckSpellingEnabled(), but can later be overridden by calling setHighlighter().

See also: setHighlighter(); highlighter(); setSpellCheckingConfigFileName()

Definition at line 602 of file ktextedit.cpp.

◆ deleteWordBack()

void KTextEdit::deleteWordBack ( )

protectedvirtual

Deletes a word backwards from the current cursor position, if available.

Definition at line 446 of file ktextedit.cpp.

◆ deleteWordForward()

void KTextEdit::deleteWordForward ( )

protectedvirtual

Deletes a word forwards from the current cursor position, if available.

Definition at line 453 of file ktextedit.cpp.

◆ enableFindReplace()

void KTextEdit::enableFindReplace ( bool enabled )

Enable find replace action.

Since: 4.1

Definition at line 977 of file ktextedit.cpp.

◆ event()

bool KTextEdit::event ( QEvent * ev )

overrideprotectedvirtual

Reimplemented to catch "delete word" shortcut events.

Reimplemented from QAbstractScrollArea.

Definition at line 298 of file ktextedit.cpp.

◆ focusInEvent()

void KTextEdit::focusInEvent ( QFocusEvent * event )

overrideprotectedvirtual

Reimplemented to instantiate a KDictSpellingHighlighter, if spellchecking is enabled.

Reimplemented from QTextEdit.

Definition at line 675 of file ktextedit.cpp.

◆ forceSpellChecking()

void KTextEdit::forceSpellChecking ( )

Since: 4.10 create a modal spellcheck dialogbox and spellCheckingFinished signal we sent when we finish spell checking or spellCheckingCanceled signal when we cancel spell checking

Definition at line 745 of file ktextedit.cpp.

◆ highlighter()

Sonnet::Highlighter * KTextEdit::highlighter ( ) const

Returns the current highlighter, which is 0 if spell checking is disabled.

The default highlighter is the one created by createHighlighter(), but might be overridden by setHighlighter().

See also: setHighlighter(); createHighlighter()

Definition at line 607 of file ktextedit.cpp.

◆ highlightWord()

void KTextEdit::highlightWord	(	int	length,
		int	pos
	)

Selects the characters at the specified position.

Any previous selection will be lost. The cursor is moved to the first character of the new selection.

Parameters

length	The length of the selection, in number of characters
pos	The position of the first character of the selection

Definition at line 752 of file ktextedit.cpp.

◆ keyPressEvent()

void KTextEdit::keyPressEvent ( QKeyEvent * event )

overrideprotectedvirtual

Reimplemented for internal reasons.

Reimplemented from QTextEdit.

Definition at line 1041 of file ktextedit.cpp.

◆ languageChanged

void KTextEdit::languageChanged ( const QString & language )

signal

Emitted when the user changes the language in the spellcheck dialog shown by checkSpelling() or when calling setSpellCheckingLanguage().

Parameters

language the new language the user selected

Since: 4.1

◆ mousePopupMenu()

QMenu * KTextEdit::mousePopupMenu ( )

virtual

Return standard KTextEdit popupMenu.

Since: 4.1

Definition at line 460 of file ktextedit.cpp.

◆ replace

void KTextEdit::replace ( )

slot

Create replace dialogbox.

Since: 4.1

Definition at line 761 of file ktextedit.cpp.

◆ setCheckSpellingEnabled()

void KTextEdit::setCheckSpellingEnabled ( bool check )

virtual

Turns background spell checking for this text edit on or off.

Note that spell checking is only available in read-writable KTextEdits.

Enabling spell checking will set back the current highlighter to the one returned by createHighlighter().

See also: checkSpellingEnabled(); isReadOnly(); setReadOnly()

Definition at line 649 of file ktextedit.cpp.

◆ setClickMessage()

void KTextEdit::setClickMessage ( const QString & msg )

inline

This makes the text edit display a grayed-out hinting text as long as the user didn't enter any text.

It is often used as indication about the purpose of the text edit.

Deprecated:: since 5.0, use QTextEdit::setPlaceholderText instead

Definition at line 192 of file ktextedit.h.

◆ setHighlighter()

void KTextEdit::setHighlighter ( Sonnet::Highlighter * _highLighter )

Sets a custom background spell highlighter for this text edit.

Normally, the highlighter returned by createHighlighter() will be used to detect and highlight incorrectly spelled words, but this function allows to set a custom highlighter.

This has to be called after enabling spell checking with setCheckSpellingEnabled(), otherwise it has no effect.

Ownership is transferred to the KTextEdit

See also: highlighter(); createHighlighter()

Parameters

highLighter the new highlighter which will be used now

Definition at line 636 of file ktextedit.cpp.

◆ setReadOnly()

void KTextEdit::setReadOnly ( bool readOnly )

virtual

Reimplemented to set a proper "deactivated" background color.

Definition at line 698 of file ktextedit.cpp.

◆ setSpellCheckingLanguage

void KTextEdit::setSpellCheckingLanguage ( const QString & language )

slot

Set the spell check language which will be used for highlighting spelling mistakes and for the spellcheck dialog.

The languageChanged() signal will be emitted when the new language is different from the old one.

Since: 4.1

Definition at line 267 of file ktextedit.cpp.

◆ shouldBlockBeSpellChecked()

bool KTextEdit::shouldBlockBeSpellChecked ( const QString & block ) const

virtual

Returns true if the given paragraph or block should be spellcheck.

For example, a mail client does not want to check quoted text, and would return false here (by checking whether the block starts with a quote sign).

Always returns true by default.

Definition at line 693 of file ktextedit.cpp.

◆ showAutoCorrectButton()

void KTextEdit::showAutoCorrectButton ( bool show )

Since: 4.10

Definition at line 1052 of file ktextedit.cpp.

◆ showSpellConfigDialog

void KTextEdit::showSpellConfigDialog ( const QString & windowIcon = QString() )

slot

Opens a Sonnet::ConfigDialog for this text edit.

The spellcheck language of the config dialog is set to the current spellcheck language of the textedit. If the user changes the language in that dialog, the languageChanged() signal is emitted.

Parameters

configFileName	The file which is used to store and load the config settings
windowIcon	the icon which is used for the titlebar of the spell dialog window. Can be empty, then no icon is set.

Since: 4.2

Definition at line 282 of file ktextedit.cpp.

◆ showTabAction()

void KTextEdit::showTabAction ( bool show )

Since: 4.10

Definition at line 984 of file ktextedit.cpp.

◆ slotDoReplace

void KTextEdit::slotDoReplace ( )

protectedslot

Since: 4.1

Definition at line 778 of file ktextedit.cpp.

◆ slotFindPrevious

void KTextEdit::slotFindPrevious ( )

protectedslot

Since: 5.11

Definition at line 928 of file ktextedit.cpp.

◆ slotSpeakText

void KTextEdit::slotSpeakText ( )

protectedslot

Since: 4.3

Definition at line 574 of file ktextedit.cpp.

◆ spellCheckerAutoCorrect

void KTextEdit::spellCheckerAutoCorrect	(	const QString &	currentWord,
		const QString &	autoCorrectWord
	)

signal

Since: 4.10

◆ spellCheckingCanceled

void KTextEdit::spellCheckingCanceled ( )

signal

signal spellCheckingCanceled is sent when we cancel spell checking.

Since: 4.10

◆ spellCheckingFinished

void KTextEdit::spellCheckingFinished ( )

signal

signal spellCheckingFinished is sent when we finish spell check or we click on "Terminate" button in sonnet dialogbox

Since: 4.10

◆ spellCheckingLanguage()

const QString& KTextEdit::spellCheckingLanguage ( ) const

Returns: the spell checking language which was set by setSpellCheckingLanguage(), the spellcheck dialog or the spellcheck config dialog, or an empty string if that has never been called.

Since: 4.2

◆ spellCheckStatus

void KTextEdit::spellCheckStatus ( const QString & )

signal

Signal sends when spell checking is finished/stopped/completed.

Since: 4.1

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

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About KTextWidgets

KTextEdit

Properties

Signals

Public Slots

Public Member Functions

Protected Slots

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KTextEdit() [1/2]

◆ KTextEdit() [2/2]

◆ ~KTextEdit()

Member Function Documentation

◆ aboutToShowContextMenu

◆ addTextDecorator

◆ checkSpelling

◆ checkSpellingChanged

◆ checkSpellingEnabled()

◆ clearDecorator

◆ clickMessage()

◆ contextMenuEvent()

◆ createHighlighter()

◆ deleteWordBack()

◆ deleteWordForward()

◆ enableFindReplace()

◆ event()

◆ focusInEvent()

◆ forceSpellChecking()

◆ highlighter()

◆ highlightWord()

◆ keyPressEvent()

◆ languageChanged

◆ mousePopupMenu()

◆ replace

◆ setCheckSpellingEnabled()

◆ setClickMessage()

◆ setHighlighter()

◆ setReadOnly()

◆ setSpellCheckingLanguage

◆ shouldBlockBeSpellChecked()

◆ showAutoCorrectButton()

◆ showSpellConfigDialog

◆ showTabAction()

◆ slotDoReplace

◆ slotFindPrevious

◆ slotSpeakText

◆ spellCheckerAutoCorrect

◆ spellCheckingCanceled

◆ spellCheckingFinished

◆ spellCheckingLanguage()

◆ spellCheckStatus