ACTION_GROUP Class Reference

A group of actions that will be displayed together on a toolbar palette. More...

#include <action_toolbar.h>

Public Member Functions
	ACTION_GROUP (const std::string_view &aName)
	ACTION_GROUP (const std::string_view &aName, const std::vector< const TOOL_ACTION * > &aActions)
void	SetDefaultAction (const TOOL_ACTION &aDefault)
	Set the default action to use when first creating the toolbar palette icon.
const TOOL_ACTION *	GetDefaultAction () const
	Get the default action to use when first creating this group's toolbar palette icon.
std::string	GetName () const
	Get the name of the group.
int	GetUIId () const
	Get the ID used in the UI to reference this group.
void	SetActions (const std::vector< const TOOL_ACTION * > &aActions)
	Set the actions contained in this group.
const std::vector< const TOOL_ACTION * > &	GetActions () const
	Get a vector of all the actions contained inside this group.

Protected Attributes
int	m_id
	< The action ID for this action group
std::string	m_name
	The default action to display on the toolbar item.
const TOOL_ACTION *	m_defaultAction
	The actions that compose the group. Non-owning.
std::vector< const TOOL_ACTION * >	m_actions

Friends
class	ACTION_TOOLBAR

Detailed Description

A group of actions that will be displayed together on a toolbar palette.

Definition at line 47 of file action_toolbar.h.

Constructor & Destructor Documentation

ACTION_GROUP() [1/2]

ACTION_GROUP::ACTION_GROUP

(

const std::string_view &

aName

)

Definition at line 60 of file action_toolbar.cpp.

References m_defaultAction, m_id, m_name, and ACTION_MANAGER::MakeActionId().

ACTION_GROUP() [2/2]

ACTION_GROUP::ACTION_GROUP	(	const std::string_view &	aName,
		const std::vector< const TOOL_ACTION * > &	aActions )

Definition at line 68 of file action_toolbar.cpp.

References m_id, m_name, ACTION_MANAGER::MakeActionId(), and SetActions().

Member Function Documentation

GetActions()

const std::vector< const TOOL_ACTION * > & ACTION_GROUP::GetActions ( ) const

inline

Get a vector of all the actions contained inside this group.

Definition at line 94 of file action_toolbar.h.

References m_actions.

GetDefaultAction()

const TOOL_ACTION * ACTION_GROUP::GetDefaultAction ( ) const

inline

Get the default action to use when first creating this group's toolbar palette icon.

Definition at line 70 of file action_toolbar.h.

References m_defaultAction.

GetName()

std::string ACTION_GROUP::GetName ( ) const

inline

Get the name of the group.

Definition at line 75 of file action_toolbar.h.

References m_name.

GetUIId()

int ACTION_GROUP::GetUIId

(

)

const

Get the ID used in the UI to reference this group.

Definition at line 87 of file action_toolbar.cpp.

References TOOL_ACTION::GetBaseUIId(), and m_id.

Referenced by ACTION_TOOLBAR::doSelectAction().

SetActions()

void ACTION_GROUP::SetActions

(

const std::vector< const TOOL_ACTION * > &

aActions

)

Set the actions contained in this group.

The first action in the list will be the new default action.

Parameters

aActions

is the new set of actions.

Definition at line 78 of file action_toolbar.cpp.

References m_actions, and m_defaultAction.

Referenced by ACTION_GROUP().

SetDefaultAction()

void ACTION_GROUP::SetDefaultAction

(

const TOOL_ACTION &

aDefault

)

Set the default action to use when first creating the toolbar palette icon.

If no default action is provided, the default will be the first action in the vector.

Parameters

aDefault

is the default action.

Definition at line 93 of file action_toolbar.cpp.

References m_actions, and m_defaultAction.

Friends And Related Symbol Documentation

ACTION_TOOLBAR

friend class ACTION_TOOLBAR

friend

Definition at line 51 of file action_toolbar.h.

References ACTION_TOOLBAR.

Referenced by ACTION_TOOLBAR.

Member Data Documentation

m_actions

std::vector<const TOOL_ACTION*> ACTION_GROUP::m_actions

protected

Definition at line 107 of file action_toolbar.h.

Referenced by GetActions(), ACTION_TOOLBAR::SelectAction(), SetActions(), and SetDefaultAction().

m_defaultAction

const TOOL_ACTION* ACTION_GROUP::m_defaultAction

protected

The actions that compose the group. Non-owning.

Definition at line 104 of file action_toolbar.h.

Referenced by ACTION_GROUP(), GetDefaultAction(), SetActions(), and SetDefaultAction().

m_id

int ACTION_GROUP::m_id

protected

< The action ID for this action group

The name of this action group

Definition at line 98 of file action_toolbar.h.

Referenced by ACTION_GROUP(), ACTION_GROUP(), and GetUIId().

m_name

std::string ACTION_GROUP::m_name

protected

The default action to display on the toolbar item.

Definition at line 101 of file action_toolbar.h.

Referenced by ACTION_GROUP(), ACTION_GROUP(), and GetName().

---

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

• action_toolbar.h
• action_toolbar.cpp