Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
QQuickEnterKeyAttached Class Reference

#include <qquickitem_p.h>

+ Inheritance diagram for QQuickEnterKeyAttached:
+ Collaboration diagram for QQuickEnterKeyAttached:

Signals

void typeChanged ()
 
- 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.
 

Public Member Functions

 QQuickEnterKeyAttached (QObject *parent=nullptr)
 \qmltype EnterKey \instantiates QQuickEnterKeyAttached \inqmlmodule QtQuick
 
Qt::EnterKeyType type () const
 
void setType (Qt::EnterKeyType type)
 
- 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< QStringbindableObjectName ()
 
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).
 
QThreadthread () const
 Returns the thread in which the object lives.
 
bool moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
 Changes the thread affinity for this object and its children and returns true on success.
 
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::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
 
void killTimer (int id)
 Kills the timer with timer identifier, id.
 
void killTimer (Qt::TimerId id)
 
template<typename T >
findChild (QAnyStringView aName, 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 (QAnyStringView 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 >
findChild (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.
 
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 QObjectListchildren () 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< QByteArraydynamicPropertyNames () const
 
QBindingStoragebindingStorage ()
 
const QBindingStoragebindingStorage () const
 
QObjectparent () 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.
 

Static Public Member Functions

static QQuickEnterKeyAttachedqmlAttachedProperties (QObject *)
 
- 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)
 

Properties

Qt::EnterKeyType type
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Friends

class QQuickItemPrivate
 

Additional Inherited Members

- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- Protected Member Functions inherited from QObject
QObjectsender () 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< QObjectDatad_ptr
 

Detailed Description

Definition at line 856 of file qquickitem_p.h.

Constructor & Destructor Documentation

◆ QQuickEnterKeyAttached()

QQuickEnterKeyAttached::QQuickEnterKeyAttached ( QObject * parent = nullptr)
explicit

\qmltype EnterKey \instantiates QQuickEnterKeyAttached \inqmlmodule QtQuick

Since
5.6

Provides a property to manipulate the appearance of Enter key on an on-screen keyboard.

The EnterKey attached property is used to manipulate the appearance and behavior of the Enter key on an on-screen keyboard.

\qmlattachedproperty enumeration QtQuick::EnterKey::type

Holds the type of the Enter key.

Note
Not all of these values are supported on all platforms. For unsupported values the default key is used instead.

\value Qt.EnterKeyDefault The default Enter key. This can be either a button to accept the input and close the keyboard, or a Return button to enter a newline in case of a multi-line input field.

\value Qt.EnterKeyReturn Show a Return button that inserts a newline.

\value Qt.EnterKeyDone Show a {"Done"} button. Typically, the keyboard is expected to close when the button is pressed.

\value Qt.EnterKeyGo Show a {"Go"} button. Typically used in an address bar when entering a URL.

\value Qt.EnterKeySend Show a {"Send"} button.

\value Qt.EnterKeySearch Show a {"Search"} button.

\value Qt.EnterKeyNext Show a {"Next"} button. Typically used in a form to allow navigating to the next input field without the keyboard closing.

\value Qt.EnterKeyPrevious Show a {"Previous"} button.

Definition at line 1637 of file qquickitem.cpp.

References QQuickItemPrivate::extra, QQuickItemPrivate::get(), item, QObject::parent(), qmlWarning(), and tr.

Referenced by qmlAttachedProperties().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Function Documentation

◆ qmlAttachedProperties()

QQuickEnterKeyAttached * QQuickEnterKeyAttached::qmlAttachedProperties ( QObject * object)
static

Definition at line 1647 of file qquickitem.cpp.

References QQuickEnterKeyAttached().

+ Here is the call graph for this function:

◆ setType()

void QQuickEnterKeyAttached::setType ( Qt::EnterKeyType type)

Definition at line 1657 of file qquickitem.cpp.

References QQuickItemPrivate::activeFocus, Qt::ImEnterKeyType, QGuiApplication::inputMethod(), type, and typeChanged().

+ Here is the call graph for this function:

◆ type()

Qt::EnterKeyType QQuickEnterKeyAttached::type ( ) const

Definition at line 1652 of file qquickitem.cpp.

◆ typeChanged

void QQuickEnterKeyAttached::typeChanged ( )
signal

Referenced by setType().

+ Here is the caller graph for this function:

Friends And Related Symbol Documentation

◆ QQuickItemPrivate

friend class QQuickItemPrivate
friend

Definition at line 876 of file qquickitem_p.h.

Property Documentation

◆ type

Qt::EnterKeyType QQuickEnterKeyAttached::type
readwrite

Definition at line 859 of file qquickitem_p.h.

Referenced by setType().


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