SpellCheckAttached Class Reference

#include <spellcheckattached.h>

Inheritance diagram for SpellCheckAttached:

Properties
QML_ELEMENTbool	enabled
Properties inherited from QObject
	objectName

Signals
void	enabledChanged ()

Public Member Functions
	SpellCheckAttached (QObject *parent=nullptr)
bool	enabled () const
void	setEnabled (bool enabled)
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)
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

Static Public Member Functions
static SpellCheckAttached *	qmlAttachedProperties (QObject *object)
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)

Additional Inherited Members
Public Types inherited from QObject
typedef	QObjectList
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)

Detailed Description

This attached property contains hints for spell checker.

Warning

Kirigami doesn't provide any spell checker per se, this is just a hint for QQC2 style implementation and other downstream components. If you want to add spell checking to your custom application theme checkout Sonnet.

import QtQuick.Controls as QQC2
import org.kde.kirigami as Kirigami
 
QQC2.TextArea {
   Kirigami.SpellCheck.enabled: true
}

Author

Carl Schwan carl@.nosp@m.carl.nosp@m.schwa.nosp@m.n.eu

Since

2.18

Definition at line 32 of file spellcheckattached.h.

Property Documentation

enabled

QML_ELEMENTbool SpellCheckAttached::enabled

readwrite

This property holds whether the spell checking should be enabled on the TextField/TextArea.

Note

By default, false. This might change in KF6, so if you don't want spellcheck in your application, explicitly set it to false.

Since

2.18

Definition at line 49 of file spellcheckattached.h.

Constructor & Destructor Documentation

SpellCheckAttached()

SpellCheckAttached::SpellCheckAttached ( QObject * parent = nullptr )

explicit

Definition at line 7 of file spellcheckattached.cpp.

~SpellCheckAttached()

SpellCheckAttached::~SpellCheckAttached ( )

override

Definition at line 12 of file spellcheckattached.cpp.

Member Function Documentation

enabled()

bool SpellCheckAttached::enabled

(

)

const

Definition at line 26 of file spellcheckattached.cpp.

qmlAttachedProperties()

SpellCheckAttached * SpellCheckAttached::qmlAttachedProperties ( QObject * object )

static

Definition at line 31 of file spellcheckattached.cpp.

setEnabled()

void SpellCheckAttached::setEnabled

(

bool

enabled

)

Definition at line 16 of file spellcheckattached.cpp.

---

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

• spellcheckattached.h
• spellcheckattached.cpp