KiCad PCB EDA Suite
Loading...
Searching...
No Matches
TOOLBAR_GROUP_CONFIG Class Reference

#include <toolbar_configuration.h>

Public Member Functions

 TOOLBAR_GROUP_CONFIG (const wxString &aName)
 
const wxString & GetName () const
 
TOOLBAR_GROUP_CONFIGAddAction (std::string aActionName)
 
TOOLBAR_GROUP_CONFIGAddAction (const TOOL_ACTION &aAction)
 
TOOLBAR_GROUP_CONFIGAddContextMenu (TOOLBAR_CONTEXT_MENU_REGISTRY::MENU_FACTORY aFactory)
 Associate a context menu factory with this group.
 
std::vector< TOOLBAR_ITEMGetGroupItems () const
 

Public Attributes

wxString m_groupName
 
std::vector< TOOLBAR_ITEMm_groupItems
 

Detailed Description

Definition at line 138 of file toolbar_configuration.h.

Constructor & Destructor Documentation

◆ TOOLBAR_GROUP_CONFIG()

TOOLBAR_GROUP_CONFIG::TOOLBAR_GROUP_CONFIG ( const wxString & aName)
inline

Definition at line 141 of file toolbar_configuration.h.

References m_groupName.

Referenced by AddAction(), AddAction(), and AddContextMenu().

Member Function Documentation

◆ AddAction() [1/2]

TOOLBAR_GROUP_CONFIG & TOOLBAR_GROUP_CONFIG::AddAction ( const TOOL_ACTION & aAction)
inline

◆ AddAction() [2/2]

TOOLBAR_GROUP_CONFIG & TOOLBAR_GROUP_CONFIG::AddAction ( std::string aActionName)
inline

◆ AddContextMenu()

TOOLBAR_GROUP_CONFIG & TOOLBAR_GROUP_CONFIG::AddContextMenu ( TOOLBAR_CONTEXT_MENU_REGISTRY::MENU_FACTORY aFactory)
inline

Associate a context menu factory with this group.

The menu will be available for all actions in the group. The factory is registered globally so JSON-loaded configurations will also get this menu.

Parameters
aFactoryFactory function that creates the context menu
Returns
Reference for continued chaining

Definition at line 174 of file toolbar_configuration.h.

References m_groupName, TOOLBAR_CONTEXT_MENU_REGISTRY::RegisterGroupMenuFactory(), and TOOLBAR_GROUP_CONFIG().

◆ GetGroupItems()

std::vector< TOOLBAR_ITEM > TOOLBAR_GROUP_CONFIG::GetGroupItems ( ) const
inline

Definition at line 183 of file toolbar_configuration.h.

References m_groupItems.

Referenced by TOOLBAR_CONFIGURATION::AppendGroup().

◆ GetName()

const wxString & TOOLBAR_GROUP_CONFIG::GetName ( ) const
inline

Definition at line 146 of file toolbar_configuration.h.

References m_groupName.

Referenced by TOOLBAR_CONFIGURATION::AppendGroup().

Member Data Documentation

◆ m_groupItems

std::vector<TOOLBAR_ITEM> TOOLBAR_GROUP_CONFIG::m_groupItems

Definition at line 192 of file toolbar_configuration.h.

Referenced by AddAction(), AddAction(), and GetGroupItems().

◆ m_groupName

wxString TOOLBAR_GROUP_CONFIG::m_groupName

Definition at line 191 of file toolbar_configuration.h.

Referenced by AddContextMenu(), GetName(), and TOOLBAR_GROUP_CONFIG().


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