Cocoa Input context implementation. More...

#include <qcocoainputcontext.h>

Inheritance diagram for QCocoaInputContext:

Collaboration diagram for QCocoaInputContext:

Public Member Functions
	QCocoaInputContext ()

	~QCocoaInputContext ()

bool	isValid () const override
	Returns input context validity.

void	setFocusObject (QObject *object) override
	This virtual method gets called to notify updated focus to object.

void	commit () override
	Commits the current composition if there is one, by "unmarking" the text in the edit buffer, and informing the system input context of this fact.

void	reset () override
	Cancels a composition.

QLocale	locale () const override

void	updateLocale ()

Public Member Functions inherited from QPlatformInputContext
	QPlatformInputContext ()

	~QPlatformInputContext ()

virtual bool	isValid () const
	Returns input context validity.

virtual bool	hasCapability (Capability capability) const
	Returns whether the implementation supports capability.

virtual void	reset ()
	Method to be called when input method needs to be reset.

virtual void	commit ()

virtual void	update (Qt::InputMethodQueries)
	Notification on editor updates.

virtual void	invokeAction (QInputMethod::Action, int cursorPosition)
	Called when the word currently being composed in the input item is tapped by the user.

virtual bool	filterEvent (const QEvent *event)
	This function can be reimplemented to filter input events.

virtual QRectF	keyboardRect () const
	This function can be reimplemented to return virtual keyboard rectangle in currently active window coordinates.

void	emitKeyboardRectChanged ()
	Active QPlatformInputContext is responsible for providing keyboardRectangle property to QInputMethod.

virtual bool	isAnimating () const
	This function can be reimplemented to return true whenever input method is animating shown or hidden.

void	emitAnimatingChanged ()
	Active QPlatformInputContext is responsible for providing animating property to QInputMethod.

virtual void	showInputPanel ()
	Request to show input panel.

virtual void	hideInputPanel ()
	Request to hide input panel.

virtual bool	isInputPanelVisible () const
	Returns input panel visibility status.

void	emitInputPanelVisibleChanged ()
	Active QPlatformInputContext is responsible for providing visible property to QInputMethod.

virtual QLocale	locale () const

void	emitLocaleChanged ()

virtual Qt::LayoutDirection	inputDirection () const

void	emitInputDirectionChanged (Qt::LayoutDirection newDirection)

virtual void	setFocusObject (QObject *object)
	This virtual method gets called to notify updated focus to object.

bool	inputMethodAccepted () const
	Returns `true` if current focus object supports input method events.

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.

virtual	~QObject ()
	Destroys the object, deleting all its child objects.

virtual bool	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.

virtual bool	eventFilter (QObject watched, QEvent event)
	Filters events if this object has been installed as an event filter for the watched object.

QString	objectName () const

Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.

void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.

bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.

bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.

bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.

bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).

QThread *	thread () const
	Returns the thread in which the object lives.

void	moveToThread (QThread *thread)
	Changes the thread affinity for this object and its children.

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.

int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)
	Kills the timer with timer identifier, id.

template<typename T >
T	findChild (const QString &aName=QString(), Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.

template<typename T >
QList< T >	findChildren (const QString &aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.

template<typename T >
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

const QObjectList &	children () const
	Returns a list of child objects.

void	setParent (QObject *parent)
	Makes the object a child of parent.

void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.

void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const

bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const

bool	disconnect (const QObject receiver, const char member=nullptr) const

void	dumpObjectTree () const
	Dumps a tree of children to the debug output.

void	dumpObjectInfo () const
	Dumps information about signal connections, etc.

bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.

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

QVariant	property (const char *name) const
	Returns the value of the object's name property.

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const
	Returns a pointer to the parent object.

bool	inherits (const char *classname) const
	Returns `true` if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns `false`.

Additional Inherited Members
Public Types inherited from QPlatformInputContext
enum	Capability { HiddenTextCapability = 0x1 }

Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.

void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.

Static Public Member Functions inherited from QPlatformInputContext
static void	setSelectionOnFocusObject (const QPointF &anchorPos, const QPointF &cursorPos)
	QPlatformInputContext::setSelectionOnFocusObject.

static QVariant	queryFocusObject (Qt::InputMethodQuery query, QPointF position)
	QPlatformInputContext::queryFocusObject.

static QRectF	inputItemRectangle ()
	QPlatformInputContext::inputItemRectangle.

static QRectF	inputItemClipRectangle ()
	QPlatformInputContext::inputItemClipRectangle.

static QRectF	cursorRectangle ()
	QPlatformInputContext::cursorRectangle.

static QRectF	anchorRectangle ()
	QPlatformInputContext::anchorRectangle.

static QRectF	keyboardRectangle ()
	QPlatformInputContext::keyboardRectangle.

Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe

static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	\threadsafe

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static bool	disconnect (const QMetaObject::Connection &)
	Disconnect a connection.

template<typename Func1 , typename Func2 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)

template<typename Func1 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)

Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.

int	senderSignalIndex () const

int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.

virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.

virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Properties inherited from QObject
QString	objectName
	the name of this object

Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

Cocoa Input context implementation.

Handles input of languages that support character composition, for example East Asian languages.

Definition at line 15 of file qcocoainputcontext.h.

Constructor & Destructor Documentation

◆ QCocoaInputContext()

QCocoaInputContext::QCocoaInputContext ( )

explicit

Definition at line 45 of file qcocoainputcontext.mm.

References qCDebug, and updateLocale().

Here is the call graph for this function:

◆ ~QCocoaInputContext()

QCocoaInputContext::~QCocoaInputContext ( )

Definition at line 58 of file qcocoainputcontext.mm.

Member Function Documentation

◆ commit()

void QCocoaInputContext::commit ( )

overridevirtual

Commits the current composition if there is one, by "unmarking" the text in the edit buffer, and informing the system input context of this fact.

Reimplemented from QPlatformInputContext.

Definition at line 67 of file qcocoainputcontext.mm.

References qCDebug, qnsview_cast(), and view.

Here is the call graph for this function:

◆ isValid()

bool QCocoaInputContext::isValid ( ) const

inlineoverridevirtual

Returns input context validity.

Deriving implementations should return true.

Reimplemented from QPlatformInputContext.

Definition at line 22 of file qcocoainputcontext.h.

◆ locale()

QLocale QCocoaInputContext::locale ( ) const

inlineoverridevirtual

Reimplemented from QPlatformInputContext.

Definition at line 29 of file qcocoainputcontext.h.

Referenced by updateLocale().

Here is the caller graph for this function:

◆ reset()

void QCocoaInputContext::reset ( )

overridevirtual

Cancels a composition.

Reimplemented from QPlatformInputContext.

Definition at line 99 of file qcocoainputcontext.mm.

References qCDebug, qnsview_cast(), view, and window().

Here is the call graph for this function:

◆ setFocusObject()

void QCocoaInputContext::setFocusObject ( QObject * object )

overridevirtual

This virtual method gets called to notify updated focus to object.

Warning: Input methods must not call this function directly.

Reimplemented from QPlatformInputContext.

Definition at line 117 of file qcocoainputcontext.mm.

References QGuiApplication::focusWindow(), qCDebug, qnsview_cast(), view, and window().

Here is the call graph for this function:

◆ updateLocale()

void QCocoaInputContext::updateLocale ( )

Definition at line 141 of file qcocoainputcontext.mm.

References QPlatformInputContext::emitLocaleChanged(), locale(), and qCDebug.

Referenced by QCocoaInputContext().

Here is the call graph for this function:

Here is the caller graph for this function:

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

qtbase/src/plugins/platforms/cocoa/qcocoainputcontext.h
qtbase/src/plugins/platforms/cocoa/qcocoainputcontext.mm

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QCocoaInputContext()

◆ ~QCocoaInputContext()

Member Function Documentation

◆ commit()

◆ isValid()

◆ locale()

◆ reset()

◆ setFocusObject()

◆ updateLocale()