#include <qquickaction_p.h>

Inheritance diagram for QQuickAction:

Collaboration diagram for QQuickAction:

Public Slots
void	toggle (QObject *source=nullptr)
	\qmlmethod void QtQuick.Controls::Action::toggle(QtObject source)

void	trigger (QObject *source=nullptr)
	\qmlmethod void QtQuick.Controls::Action::trigger(QtObject source)

Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals
void	textChanged (const QString &text)

void	iconChanged (const QQuickIcon &icon)

void	enabledChanged (bool enabled)

void	checkedChanged (bool checked)

void	checkableChanged (bool checkable)

void	toggled (QObject *source=nullptr)

void	triggered (QObject *source=nullptr)

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
	QQuickAction (QObject *parent=nullptr)

	~QQuickAction ()

QString	text () const
	\qmlproperty string QtQuick.Controls::Action::text

void	setText (const QString &text)

QQuickIcon	icon () const
	\qmlproperty string QtQuick.Controls::Action::icon.name \qmlproperty url QtQuick.Controls::Action::icon.source \qmlproperty int QtQuick.Controls::Action::icon.width \qmlproperty int QtQuick.Controls::Action::icon.height \qmlproperty color QtQuick.Controls::Action::icon.color \qmlproperty bool QtQuick.Controls::Action::icon.cache

void	setIcon (const QQuickIcon &icon)

bool	isEnabled () const
	\qmlproperty bool QtQuick.Controls::Action::enabled

void	setEnabled (bool enabled)

void	resetEnabled ()

bool	isChecked () const
	\qmlproperty bool QtQuick.Controls::Action::checked

void	setChecked (bool checked)

bool	isCheckable () const
	\qmlproperty bool QtQuick.Controls::Action::checkable

void	setCheckable (bool checkable)

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.

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.

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 >
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 >
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 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`.

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

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

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)

Properties
QString	text

QQuickIcon	icon

bool	enabled

bool	checked

bool	checkable

Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
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 Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

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

Definition at line 28 of file qquickaction_p.h.

Constructor & Destructor Documentation

◆ QQuickAction()

QQuickAction::QQuickAction ( QObject * parent = nullptr )

explicit

Definition at line 307 of file qquickaction.cpp.

References d.

◆ ~QQuickAction()

QQuickAction::~QQuickAction ( )

Definition at line 316 of file qquickaction.cpp.

References d, and qDeleteAll().

Here is the call graph for this function:

Member Function Documentation

◆ checkableChanged

void QQuickAction::checkableChanged ( bool checkable )

signal

Referenced by QQuickAbstractButton::setAction(), and setCheckable().

Here is the caller graph for this function:

◆ checkedChanged

void QQuickAction::checkedChanged ( bool checked )

signal

Referenced by QQuickActionGroup::addAction(), QQuickActionGroupPrivate::clear(), QQuickActionGroup::removeAction(), QQuickAbstractButton::setAction(), and setChecked().

Here is the caller graph for this function:

◆ enabledChanged

void QQuickAction::enabledChanged ( bool enabled )

signal

Referenced by QQuickActionGroup::addAction(), QQuickActionGroup::removeAction(), and QQuickAbstractButton::setAction().

Here is the caller graph for this function:

◆ event()

bool QQuickAction::event ( QEvent * e )

overrideprotectedvirtual

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

The event() function can be reimplemented to customize the behavior of an object.

Make sure you call the parent event class implementation for all the events you did not handle.

Example:

class MyClass : public QWidget
{
    Q_OBJECT
 
public:
    MyClass(QWidget *parent = nullptr);
    ~MyClass();
 
    bool event(QEvent* ev) override
    {
        if (ev->type() == QEvent::PolishRequest) {
            // overwrite handling of PolishRequest if any
            doThings();
            return true;
        } else  if (ev->type() == QEvent::Show) {
            // complement handling of Show if any
            doThings2();
            QWidget::event(ev);
            return true;
        }
        // Make sure the rest of events are handled
        return QWidget::event(ev);
    }
};

See also: installEventFilter(), timerEvent(), QCoreApplication::sendEvent(), QCoreApplication::postEvent()

Reimplemented from QObject.

Definition at line 531 of file qquickaction.cpp.

References d, QObject::event(), and QEvent::Shortcut.

Here is the call graph for this function:

◆ eventFilter()

bool QQuickAction::eventFilter	(	QObject *	watched,
		QEvent *	event )

overrideprotectedvirtual

Filters events if this object has been installed as an event filter for the watched object.

In your reimplementation of this function, if you want to filter the event out, i.e. stop it being handled further, return true; otherwise return false.

Example:

class MainWindow : public QMainWindow
{
public:
    MainWindow();
 
protected:
    bool eventFilter(QObject *obj, QEvent *ev) override;
 
private:
    QTextEdit *textEdit;
};
 
MainWindow::MainWindow()
{
    textEdit = new QTextEdit;
    setCentralWidget(textEdit);
 
    textEdit->installEventFilter(this);
}
 
bool MainWindow::eventFilter(QObject *obj, QEvent *event)
{
    if (obj == textEdit) {
        if (event->type() == QEvent::KeyPress) {
            QKeyEvent *keyEvent = static_cast<QKeyEvent*>(event);
            qDebug() << "Ate key press" << keyEvent->key();
            return true;
        } else {
            return false;
        }
    } else {
        // pass the event on to the parent class
        return QMainWindow::eventFilter(obj, event);
    }
}

Notice in the example above that unhandled events are passed to the base class's eventFilter() function, since the base class might have reimplemented eventFilter() for its own internal purposes.

Some events, such as \l QEvent::ShortcutOverride must be explicitly accepted (by calling \l {QEvent::}{accept()} on them) in order to prevent propagation.

Warning: If you delete the receiver object in this function, be sure to return true. Otherwise, Qt will forward the event to the deleted object and the program might crash.

See also: installEventFilter()

Reimplemented from QObject.

Definition at line 541 of file qquickaction.cpp.

References d, Q_UNUSED, and QEvent::Shortcut.

◆ icon()

QQuickIcon QQuickAction::icon ( ) const

\qmlproperty string QtQuick.Controls::Action::icon.name \qmlproperty url QtQuick.Controls::Action::icon.source \qmlproperty int QtQuick.Controls::Action::icon.width \qmlproperty int QtQuick.Controls::Action::icon.height \qmlproperty color QtQuick.Controls::Action::icon.color \qmlproperty bool QtQuick.Controls::Action::icon.cache

grouped-properties

Definition at line 362 of file qquickaction.cpp.

References d.

◆ iconChanged

void QQuickAction::iconChanged ( const QQuickIcon & icon )

signal

Referenced by QQuickAbstractButton::setAction(), and setIcon().

Here is the caller graph for this function:

◆ isCheckable()

bool QQuickAction::isCheckable ( ) const

\qmlproperty bool QtQuick.Controls::Action::checkable

This property holds whether the action is checkable. The default value is false.

A checkable action toggles between checked (on) and unchecked (off) when triggered.

See also: checked

Definition at line 439 of file qquickaction.cpp.

References d.

Referenced by QQuickAbstractButton::setAction().

Here is the caller graph for this function:

◆ isChecked()

bool QQuickAction::isChecked ( ) const

\qmlproperty bool QtQuick.Controls::Action::checked

This property holds whether the action is checked.

See also: checkable

Definition at line 414 of file qquickaction.cpp.

References d.

Referenced by QQuickActionGroupPrivate::_q_updateCurrent(), QQuickActionGroup::addAction(), and QQuickAbstractButton::setAction().

Here is the caller graph for this function:

◆ isEnabled()

bool QQuickAction::isEnabled ( ) const

\qmlproperty bool QtQuick.Controls::Action::enabled

This property holds whether the action is enabled. The default value is true.

Definition at line 384 of file qquickaction.cpp.

References d.

Referenced by QQuickActionGroup::addAction(), QQuickActionGroupPrivate::changeEnabled(), QQuickActionGroup::removeAction(), QQuickAbstractButton::setAction(), and QQuickAbstractButtonPrivate::trigger().

Here is the caller graph for this function:

◆ resetEnabled()

void QQuickAction::resetEnabled ( )

Definition at line 397 of file qquickaction.cpp.

References d.

◆ setCheckable()

void QQuickAction::setCheckable ( bool checkable )

Definition at line 445 of file qquickaction.cpp.

References checkable, checkableChanged(), d, and emit.

Here is the call graph for this function:

◆ setChecked()

void QQuickAction::setChecked ( bool checked )

Definition at line 420 of file qquickaction.cpp.

References checked, checkedChanged(), d, and emit.

Referenced by QQuickActionGroup::setCheckedAction(), and toggle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setEnabled()

void QQuickAction::setEnabled ( bool enabled )

Definition at line 390 of file qquickaction.cpp.

References d.

◆ setIcon()

void QQuickAction::setIcon ( const QQuickIcon & icon )

Definition at line 368 of file qquickaction.cpp.

References d, emit, QQuickIcon::ensureRelativeSourceResolved(), icon, and iconChanged().

Here is the call graph for this function:

◆ setText()

void QQuickAction::setText ( const QString & text )

Definition at line 342 of file qquickaction.cpp.

References d, emit, text, and textChanged().

Here is the call graph for this function:

◆ text()

QString QQuickAction::text ( ) const

\qmlproperty string QtQuick.Controls::Action::text

This property holds a textual description of the action.

Definition at line 336 of file qquickaction.cpp.

References d.

◆ textChanged

void QQuickAction::textChanged ( const QString & text )

signal

Referenced by QQuickAbstractButton::setAction(), and setText().

Here is the caller graph for this function:

◆ toggle

void QQuickAction::toggle ( QObject * source = nullptr )

slot

\qmlmethod void QtQuick.Controls::Action::toggle(QtObject source)

Toggles the action and emits \l toggled() if enabled, with an optional source object defined.

Definition at line 489 of file qquickaction.cpp.

References d, emit, setChecked(), and toggled().

Here is the call graph for this function:

◆ toggled

void QQuickAction::toggled ( QObject * source = nullptr )

signal

Referenced by toggle().

Here is the caller graph for this function:

◆ trigger

void QQuickAction::trigger ( QObject * source = nullptr )

slot

\qmlmethod void QtQuick.Controls::Action::trigger(QtObject source)

Triggers the action and emits \l triggered() if enabled, with an optional source object defined.

Definition at line 506 of file qquickaction.cpp.

References d.

◆ triggered

void QQuickAction::triggered ( QObject * source = nullptr )

signal

Referenced by QQuickActionGroup::addAction(), QQuickActionGroupPrivate::clear(), QQuickActionGroup::removeAction(), and QQuickAbstractButton::setAction().

Here is the caller graph for this function:

Property Documentation

◆ checkable

bool QQuickAction::checkable

readwrite

Definition at line 35 of file qquickaction_p.h.

Referenced by setCheckable().

◆ checked

bool QQuickAction::checked

readwrite

Definition at line 34 of file qquickaction_p.h.

Referenced by setChecked().

◆ enabled

bool QQuickAction::enabled

readwrite

Definition at line 33 of file qquickaction_p.h.

Referenced by QQuickActionGroup::addAction(), and QQuickActionGroup::removeAction().

◆ icon

QQuickIcon QQuickAction::icon

readwrite

Definition at line 32 of file qquickaction_p.h.

Referenced by setIcon(), and QQuickAbstractButtonPrivate::updateEffectiveIcon().

◆ text

QString QQuickAction::text

readwrite

Definition at line 31 of file qquickaction_p.h.

Referenced by setText().

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

qtdeclarative/src/quicktemplates/qquickaction_p.h (6f6a68182b675a8f619f434a2c8052aac61cc788)
qtdeclarative/src/quicktemplates/qquickaction.cpp (5a665bc4740106a7c3932506173229ddc8aec8be)

Public Slots

Signals

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QQuickAction()

◆ ~QQuickAction()

Member Function Documentation

◆ checkableChanged

◆ checkedChanged

◆ enabledChanged

◆ event()

◆ eventFilter()

◆ icon()

◆ iconChanged

◆ isCheckable()

◆ isChecked()

◆ isEnabled()

◆ resetEnabled()

◆ setCheckable()

◆ setChecked()

◆ setEnabled()

◆ setIcon()

◆ setText()

◆ text()

◆ textChanged

◆ toggle

◆ toggled

◆ trigger

◆ triggered

Property Documentation

◆ checkable

◆ checked

◆ enabled

◆ icon

◆ text