ActionContainer Class
(Core::ActionContainer)The ActionContainer class represents a menu or menu bar in Qt Creator. More...
Header: | #include <ActionContainer> |
Public Types
enum | OnAllDisabledBehavior { Disable, Hide, Show } |
Public Functions
virtual void | addAction(Core::Command *action, Core::Id group = Id()) = 0 |
virtual void | addMenu(Core::ActionContainer *menu, Core::Id group = Id()) = 0 |
virtual void | addMenu(Core::ActionContainer *before, Core::ActionContainer *menu) = 0 |
Core::Command * | addSeparator(Core::Id group = Id()) |
virtual Core::Command * | addSeparator(const Core::Context &context, Core::Id group = Id(), QAction **outSeparator = nullptr) = 0 |
virtual void | appendGroup(Core::Id group) = 0 |
virtual void | clear() = 0 |
virtual Core::Id | id() const = 0 |
virtual void | insertGroup(Core::Id before, Core::Id group) = 0 |
virtual QAction * | insertLocation(Core::Id group) const = 0 |
virtual QMenu * | menu() const = 0 |
virtual QMenuBar * | menuBar() const = 0 |
virtual ActionContainer::OnAllDisabledBehavior | onAllDisabledBehavior() const = 0 |
virtual void | setOnAllDisabledBehavior(Core::ActionContainer::OnAllDisabledBehavior behavior) = 0 |
virtual Utils::TouchBar * | touchBar() const = 0 |
Detailed Description
The ActionContainer class represents a menu or menu bar in Qt Creator.
You don't create instances of this class directly, but instead use the ActionManager::createMenu(), ActionManager::createMenuBar() and ActionManager::createTouchBar() functions. Retrieve existing action containers for an ID with ActionManager::actionContainer().
Within a menu or menu bar you can group menus and items together by defining groups (the order of the groups is defined by the order of the ActionContainer::appendGroup() calls), and adding menus or actions to these groups. If no custom groups are defined, an action container has three default groups Core::Constants::G_DEFAULT_ONE
, Core::Constants::G_DEFAULT_TWO
and Core::Constants::G_DEFAULT_THREE
.
You can specify whether the menu represented by this action container should be automatically disabled or hidden whenever it only contains disabled items and submenus by setting the corresponding setOnAllDisabledBehavior(). The default is ActionContainer::Disable for menus, and ActionContainer::Show for menu bars.
Member Type Documentation
enum ActionContainer::OnAllDisabledBehavior
Defines what happens when the represented menu is empty or contains only disabled or invisible items.
Constant | Value | Description |
---|---|---|
Core::ActionContainer::Disable | 0 | The menu will be visible but disabled. |
Core::ActionContainer::Hide | 1 | The menu will not be visible until the state of the subitems changes. |
Core::ActionContainer::Show | 2 | The menu will still be visible and active. |
Member Function Documentation
[pure virtual]
void ActionContainer::addAction(Core::Command *action, Core::Id group = Id())
[pure virtual]
void ActionContainer::addMenu(Core::ActionContainer *menu, Core::Id group = Id())
[pure virtual]
void ActionContainer::addMenu(Core::ActionContainer *before, Core::ActionContainer *menu)
Core::Command *ActionContainer::addSeparator(Core::Id group = Id())
Adds a separator to the end of group to the action container.
Returns the created separator.
[pure virtual]
Core::Command *ActionContainer::addSeparator(const Core::Context &context, Core::Id group = Id(), QAction **outSeparator = nullptr)
[pure virtual]
void ActionContainer::appendGroup(Core::Id group)
[pure virtual]
void ActionContainer::clear()
[pure virtual]
Core::Id ActionContainer::id() const
[pure virtual]
void ActionContainer::insertGroup(Core::Id before, Core::Id group)
[pure virtual]
QAction *ActionContainer::insertLocation(Core::Id group) const
[pure virtual]
QMenu *ActionContainer::menu() const
[pure virtual]
QMenuBar *ActionContainer::menuBar() const
[pure virtual]
ActionContainer::OnAllDisabledBehavior ActionContainer::onAllDisabledBehavior() const
See also setOnAllDisabledBehavior().
[pure virtual]
void ActionContainer::setOnAllDisabledBehavior(Core::ActionContainer::OnAllDisabledBehavior behavior)
See also onAllDisabledBehavior().