xiiMenuAction Class Reference

An action that represents a sub-menu. Can be within a menu bar, or the menu of a tool button). More...

#include <BaseActions.h>

Inheritance diagram for xiiMenuAction:

Public Member Functions
	xiiMenuAction (const xiiActionContext &context, xiiStringView sName, xiiStringView sIconPath)
virtual void	Execute (const xiiVariant &value) override
Public Member Functions inherited from xiiNamedAction
	xiiNamedAction (const xiiActionContext &context, xiiStringView sName, xiiStringView sIconPath)
xiiStringView	GetName () const
xiiStringView	GetAdditionalDisplayString ()
void	SetAdditionalDisplayString (xiiStringView sString, bool bTriggerUpdate=true)
xiiStringView	GetIconPath () const
void	SetIconPath (xiiStringView sIconPath)
Public Member Functions inherited from xiiAction
	xiiAction (const xiiActionContext &context)
void	TriggerUpdate ()
const xiiActionContext &	GetContext () const
xiiActionDescriptorHandle	GetDescriptorHandle ()
Public Member Functions inherited from xiiReflectedClass
virtual const xiiRTTI *	GetDynamicRTTI () const
bool	IsInstanceOf (const xiiRTTI *pType) const
	Returns whether the type of this instance is of the given type or derived from it.
template<typename T>
XII_ALWAYS_INLINE bool	IsInstanceOf () const
	Returns whether the type of this instance is of the given type or derived from it.

Additional Inherited Members
Static Public Member Functions inherited from xiiNoBase
static const xiiRTTI *	GetStaticRTTI ()
Public Attributes inherited from xiiAction
xiiEvent< xiiAction * >	m_StatusUpdateEvent
	Fire when the state of the action changes (enabled, value etc...)
Protected Attributes inherited from xiiNamedAction
xiiString	m_sName
xiiString	m_sAdditionalDisplayString
xiiString	m_sIconPath
Protected Attributes inherited from xiiAction
xiiActionContext	m_Context

Detailed Description

An action that represents a sub-menu. Can be within a menu bar, or the menu of a tool button).

This class can be used directly, but then every menu entry has to be mapped individually into the menu. It is often more convenient to use derived types which already set up the content of the menu.

Member Function Documentation

Execute()

virtual void xiiMenuAction::Execute ( const xiiVariant & value )

inlineoverridevirtual

Implements xiiAction.

---

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

• /home/runner/work/XII/XII/Source/Tools/Libs/GuiFoundation/Action/BaseActions.h