Sonnet::SpellCheckDecorator Class Reference

#include <Sonnet/SpellCheckDecorator>

Inheritance diagram for Sonnet::SpellCheckDecorator:

Public Member Functions
	SpellCheckDecorator (QPlainTextEdit *textEdit)
	SpellCheckDecorator (QTextEdit *textEdit)
Highlighter *	highlighter () const
void	setHighlighter (Highlighter *highlighter)
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	event (QEvent *e)
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

Protected Member Functions
bool	eventFilter (QObject *obj, QEvent *event) override
virtual bool	isSpellCheckingEnabledForBlock (const QString &textBlock) const
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 QObject
typedef	QObjectList
Properties inherited from QObject
	objectName
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)

Detailed Description

Connects a Sonnet::Highlighter to a QTextEdit extending the context menu of the text edit with spell check suggestions.

Author

Aurélien Gâteau agate.nosp@m.au@k.nosp@m.de.or.nosp@m.g

Since

5.0

Constructor & Destructor Documentation

SpellCheckDecorator() [1/2]

Sonnet::SpellCheckDecorator::SpellCheckDecorator ( QTextEdit * textEdit )

explicit

Creates a spell-check decorator.

Parameters

textEdit

the QTextEdit in need of spell-checking. It also is used as the QObject parent for the decorator.

Definition at line 222 of file spellcheckdecorator.cpp.

SpellCheckDecorator() [2/2]

Sonnet::SpellCheckDecorator::SpellCheckDecorator ( QPlainTextEdit * textEdit )

explicit

Creates a spell-check decorator.

Parameters

textEdit

the QPlainTextEdit in need of spell-checking. It also is used as the QObject parent for the decorator.

Since

5.12

Definition at line 228 of file spellcheckdecorator.cpp.

Member Function Documentation

eventFilter()

bool Sonnet::SpellCheckDecorator::eventFilter ( QObject * obj, QEvent * event )

overrideprotectedvirtual

Reimplemented from QObject.

Definition at line 249 of file spellcheckdecorator.cpp.

highlighter()

Highlighter * Sonnet::SpellCheckDecorator::highlighter

(

)

const

Returns the hightlighter used by the decorator.

Definition at line 241 of file spellcheckdecorator.cpp.

isSpellCheckingEnabledForBlock()

bool Sonnet::SpellCheckDecorator::isSpellCheckingEnabledForBlock ( const QString & textBlock ) const

protectedvirtual

Returns true if the spell checking should be enabled for a given block of text The default implementation always returns true.

Definition at line 257 of file spellcheckdecorator.cpp.

setHighlighter()

void Sonnet::SpellCheckDecorator::setHighlighter

(

Highlighter *

highlighter

)

Set a custom highlighter on the decorator.

SpellCheckDecorator does not take ownership of the new highlighter, and you must manually delete the old highlighter.

Definition at line 236 of file spellcheckdecorator.cpp.

---

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

• spellcheckdecorator.h
• spellcheckdecorator.cpp