Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Friends | List of all members
QWidgetAction Class Reference

The QWidgetAction class extends QAction by an interface for inserting custom widgets into action based containers, such as toolbars. More...

#include <qwidgetaction.h>

+ Inheritance diagram for QWidgetAction:
+ Collaboration diagram for QWidgetAction:

Public Member Functions

 QWidgetAction (QObject *parent)
 Constructs an action with parent.
 
virtual ~QWidgetAction ()
 Destroys the object and frees allocated resources.
 
void setDefaultWidget (QWidget *w)
 Sets widget to be the default widget.
 
QWidget * defaultWidget () const
 Returns the default widget.
 
QWidget * requestWidget (QWidget *parent)
 Returns a widget that represents the action, with the given parent.
 
void releaseWidget (QWidget *widget)
 Releases the specified widget.
 
- Public Member Functions inherited from QAction
 QAction (QObject *parent=nullptr)
 Constructs an action with parent.
 
 QAction (const QString &text, QObject *parent=nullptr)
 Constructs an action with some text and parent.
 
 QAction (const QIcon &icon, const QString &text, QObject *parent=nullptr)
 Constructs an action with an icon and some text and parent.
 
 ~QAction ()
 Destroys the object and frees allocated resources.
 
QList< QObject * > associatedObjects () const
 
void setActionGroup (QActionGroup *group)
 Sets this action group to group.
 
QActionGroup * actionGroup () const
 Returns the action group for this action.
 
void setIcon (const QIcon &icon)
 
QIcon icon () const
 
void setText (const QString &text)
 
QString text () const
 
void setIconText (const QString &text)
 
QString iconText () const
 
void setToolTip (const QString &tip)
 
QString toolTip () const
 
void setStatusTip (const QString &statusTip)
 
QString statusTip () const
 
void setWhatsThis (const QString &what)
 
QString whatsThis () const
 
void setPriority (Priority priority)
 
Priority priority () const
 
void setSeparator (bool b)
 If b is true then this action will be considered a separator.
 
bool isSeparator () const
 Returns true if this action is a separator action; otherwise it returns false.
 
void setFont (const QFont &font)
 
QFont font () const
 
void setCheckable (bool)
 
bool isCheckable () const
 
QVariant data () const
 Returns the user data as set in QAction::setData.
 
void setData (const QVariant &var)
 Sets the action's internal data to the given data.
 
bool isChecked () const
 
bool isEnabled () const
 
bool isVisible () const
 
void activate (ActionEvent event)
 Sends the relevant signals for ActionEvent event.
 
void setMenuRole (MenuRole menuRole)
 
MenuRole menuRole () const
 
template<typename T = QMenu*>
T menu () const
 Returns the menu contained by this action.
 
template<typename T = QMenu*>
void setMenu (T m)
 Sets the menu contained by this action to the specified menu.
 
void setIconVisibleInMenu (bool visible)
 
bool isIconVisibleInMenu () const
 
void setShortcutVisibleInContextMenu (bool show)
 
bool isShortcutVisibleInContextMenu () const
 
bool showStatusText (QObject *object=nullptr)
 Updates the relevant status bar for the UI represented by object by sending a QStatusTipEvent.
 
- 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

virtual bool event (QEvent *) override
 \reimp
 
virtual bool eventFilter (QObject *, QEvent *) override
 \reimp
 
virtual QWidget * createWidget (QWidget *parent)
 This function is called whenever the action is added to a container widget that supports custom widgets.
 
virtual void deleteWidget (QWidget *widget)
 This function is called whenever the action is removed from a container widget that displays the action using a custom widget previously created using createWidget().
 
QList< QWidget * > createdWidgets () const
 Returns the list of widgets that have been using createWidget() and are currently in use by widgets the action has been added to.
 
- Protected Member Functions inherited from QAction
 QAction (QActionPrivate &dd, QObject *parent)
 
- 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)
 

Friends

class QToolBar
 

Additional Inherited Members

- Public Types inherited from QAction
enum  MenuRole {
  NoRole = 0 , TextHeuristicRole , ApplicationSpecificRole , AboutQtRole ,
  AboutRole , PreferencesRole , QuitRole
}
 This enum describes how an action should be moved into the application menu on \macos. More...
 
enum  Priority { LowPriority = 0 , NormalPriority = 128 , HighPriority = 256 }
 This enum defines priorities for actions in user interface. More...
 
enum  ActionEvent { Trigger , Hover }
 This enum type is used when calling QAction::activate() More...
 
- Public Slots inherited from QAction
void trigger ()
 This is a convenience slot that calls activate(Trigger).
 
void hover ()
 This is a convenience slot that calls activate(Hover).
 
void setChecked (bool)
 
void toggle ()
 This is a convenience function for the \l checked property.
 
void setEnabled (bool)
 
void resetEnabled ()
 
void setDisabled (bool b)
 This is a convenience function for the \l enabled property, that is useful for signals–slots connections.
 
void setVisible (bool)
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- Signals inherited from QAction
void changed ()
 This signal is emitted when an action has changed.
 
void enabledChanged (bool enabled)
 
void checkableChanged (bool checkable)
 
void visibleChanged ()
 
void triggered (bool checked=false)
 This signal is emitted when an action is activated by the user; for example, when the user clicks a menu option, toolbar button, or presses an action's shortcut key combination, or when trigger() was called.
 
void hovered ()
 This signal is emitted when an action is highlighted by the user; for example, when the user pauses with the cursor over a menu option, toolbar button, or presses an action's shortcut key combination.
 
void toggled (bool)
 This signal is emitted whenever a checkable action changes its isChecked() status.
 
- 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 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
 
- Properties inherited from QAction
bool checkable
 whether the action is a checkable action
 
bool checked
 whether the action is checked.
 
bool enabled
 whether the action is enabled
 
QIcon icon
 the action's icon
 
QString text
 the action's descriptive text
 
QString iconText
 the action's descriptive icon text
 
QString toolTip
 the action's tooltip
 
QString statusTip
 the action's status tip
 
QString whatsThis
 the action's "What's This?" help text
 
QFont font
 the action's font
 
bool visible
 whether the action can be seen (e.g.
 
MenuRole menuRole
 the action's menu role
 
bool iconVisibleInMenu
 Whether or not an action should show an icon in a menu.
 
bool shortcutVisibleInContextMenu
 Whether or not an action should show a shortcut in a context menu.
 
Priority priority
 the actions's priority in the user interface.
 
- Properties inherited from QObject
QString objectName
 the name of this object
 
- Related Symbols inherited from QObject
 Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
 
 
 
 \macro Q_CLASSINFO(Name, Value)
 

Detailed Description

The QWidgetAction class extends QAction by an interface for inserting custom widgets into action based containers, such as toolbars.

Since
4.2

\inmodule QtWidgets

Most actions in an application are represented as items in menus or buttons in toolbars. However sometimes more complex widgets are necessary. For example a zoom action in a word processor may be realized using a QComboBox in a QToolBar, presenting a range of different zoom levels. QToolBar provides QToolBar::insertWidget() as convenience function for inserting a single widget. However if you want to implement an action that uses custom widgets for visualization in multiple containers then you have to subclass QWidgetAction.

If a QWidgetAction is added for example to a QToolBar then QWidgetAction::createWidget() is called. Reimplementations of that function should create a new custom widget with the specified parent.

If the action is removed from a container widget then QWidgetAction::deleteWidget() is called with the previously created custom widget as argument. The default implementation hides the widget and deletes it using QObject::deleteLater().

If you have only one single custom widget then you can set it as default widget using setDefaultWidget(). That widget will then be used if the action is added to a QToolBar, or in general to an action container that supports QWidgetAction. If a QWidgetAction with only a default widget is added to two toolbars at the same time then the default widget is shown only in the first toolbar the action was added to. QWidgetAction takes over ownership of the default widget.

Note that it is up to the widget to activate the action, for example by reimplementing mouse event handlers and calling QAction::trigger().

{\macos }: If you add a widget to a menu in the application's menu bar on \macos, the widget will be added and it will function but with some limitations: \list 1

  • The widget is reparented away from the QMenu to the native menu view. If you show the menu in some other place (e.g. as a popup menu), the widget will not be there.
  • Focus/Keyboard handling of the widget is not possible.
  • Due to Apple's design, mouse tracking on the widget currently does not work.
  • Connecting the triggered() signal to a slot that opens a modal dialog will cause a crash in \macos 10.4 (known bug acknowledged by Apple), a workaround is to use a QueuedConnection instead of a DirectConnection. \endlist
See also
QAction, QActionGroup, QWidget

Definition at line 16 of file qwidgetaction.h.

Constructor & Destructor Documentation

◆ QWidgetAction()

QWidgetAction::QWidgetAction ( QObject * parent)
explicit

Constructs an action with parent.

Definition at line 76 of file qwidgetaction.cpp.

◆ ~QWidgetAction()

QWidgetAction::~QWidgetAction ( )
virtual

Destroys the object and frees allocated resources.

Definition at line 84 of file qwidgetaction.cpp.

Member Function Documentation

◆ createdWidgets()

QList< QWidget * > QWidgetAction::createdWidgets ( ) const
protected

Returns the list of widgets that have been using createWidget() and are currently in use by widgets the action has been added to.

Definition at line 242 of file qwidgetaction.cpp.

◆ createWidget()

QWidget * QWidgetAction::createWidget ( QWidget * parent)
protectedvirtual

This function is called whenever the action is added to a container widget that supports custom widgets.

If you don't want a custom widget to be used as representation of the action in the specified parent widget then 0 should be returned.

See also
deleteWidget()

Definition at line 217 of file qwidgetaction.cpp.

◆ defaultWidget()

QWidget * QWidgetAction::defaultWidget ( ) const

Returns the default widget.

Definition at line 124 of file qwidgetaction.cpp.

◆ deleteWidget()

void QWidgetAction::deleteWidget ( QWidget * widget)
protectedvirtual

This function is called whenever the action is removed from a container widget that displays the action using a custom widget previously created using createWidget().

The default implementation hides the widget and schedules it for deletion using QObject::deleteLater().

See also
createWidget()

Definition at line 232 of file qwidgetaction.cpp.

◆ event()

bool QWidgetAction::event ( QEvent * event)
overrideprotectedvirtual

\reimp

Reimplemented from QAction.

Definition at line 189 of file qwidgetaction.cpp.

◆ eventFilter()

bool QWidgetAction::eventFilter ( QObject * obj,
QEvent * event )
overrideprotectedvirtual

\reimp

Reimplemented from QObject.

Definition at line 204 of file qwidgetaction.cpp.

◆ releaseWidget()

void QWidgetAction::releaseWidget ( QWidget * widget)

Releases the specified widget.

Container widgets that support actions call this function when a widget action is removed.

See also
requestWidget(), deleteWidget(), defaultWidget()

Definition at line 166 of file qwidgetaction.cpp.

◆ requestWidget()

QWidget * QWidgetAction::requestWidget ( QWidget * parent)

Returns a widget that represents the action, with the given parent.

Container widgets that support actions can call this function to request a widget as visual representation of the action.

See also
releaseWidget(), createWidget(), defaultWidget()

Definition at line 139 of file qwidgetaction.cpp.

◆ setDefaultWidget()

void QWidgetAction::setDefaultWidget ( QWidget * widget)

Sets widget to be the default widget.

The ownership is transferred to QWidgetAction. Unless createWidget() is reimplemented by a subclass to return a new widget the default widget is used when a container widget requests a widget through requestWidget().

Definition at line 103 of file qwidgetaction.cpp.

Friends And Related Symbol Documentation

◆ QToolBar

friend class QToolBar
friend

Definition at line 40 of file qwidgetaction.h.

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