ACTION_TOOLBAR_CONTROL Class Reference

Class to hold basic information about controls that can be added to the toolbars. More...

#include <action_toolbar.h>

Public Member Functions
	ACTION_TOOLBAR_CONTROL (const std::string &aName, const wxString &aUiName, const wxString &aDescription, std::vector< FRAME_T > aSupportedContexts)
const std::string &	GetName () const
const wxString &	GetUiName () const
const wxString &	GetDescription () const
bool	SupportedFor (FRAME_T aFrame) const

Protected Attributes
std::string	m_name
	Name of the control - must start with "control.".
wxString	m_uiname
	Short description to show for the control.
wxString	m_description
	User-visible tooltip for the control.
std::vector< FRAME_T >	m_supportedContexts
	List of frame types that support the control.

Detailed Description

Class to hold basic information about controls that can be added to the toolbars.

Definition at line 441 of file action_toolbar.h.

Constructor & Destructor Documentation

ACTION_TOOLBAR_CONTROL()

ACTION_TOOLBAR_CONTROL::ACTION_TOOLBAR_CONTROL ( const std::string & aName, const wxString & aUiName, const wxString & aDescription, std::vector< FRAME_T > aSupportedContexts )

inline

Definition at line 444 of file action_toolbar.h.

References ACTION_TOOLBAR::GetAllCustomControls(), m_description, m_name, m_supportedContexts, and m_uiname.

Member Function Documentation

GetDescription()

const wxString & ACTION_TOOLBAR_CONTROL::GetDescription ( ) const

inline

Definition at line 459 of file action_toolbar.h.

References m_description.

GetName()

const std::string & ACTION_TOOLBAR_CONTROL::GetName ( ) const

inline

Definition at line 457 of file action_toolbar.h.

References m_name.

Referenced by TOOLBAR_CONFIGURATION::AppendControl(), PANEL_TOOLBAR_CUSTOMIZATION::parseToolbarTree(), and EDA_BASE_FRAME::RegisterCustomToolbarControlFactory().

GetUiName()

const wxString & ACTION_TOOLBAR_CONTROL::GetUiName ( ) const

inline

Definition at line 458 of file action_toolbar.h.

References m_uiname.

SupportedFor()

bool ACTION_TOOLBAR_CONTROL::SupportedFor ( FRAME_T aFrame ) const

inline

Definition at line 461 of file action_toolbar.h.

References m_supportedContexts.

Member Data Documentation

m_description

wxString ACTION_TOOLBAR_CONTROL::m_description

protected

User-visible tooltip for the control.

Definition at line 486 of file action_toolbar.h.

Referenced by ACTION_TOOLBAR_CONTROL(), and GetDescription().

m_name

std::string ACTION_TOOLBAR_CONTROL::m_name

protected

Name of the control - must start with "control.".

Definition at line 476 of file action_toolbar.h.

Referenced by ACTION_TOOLBAR_CONTROL(), and GetName().

m_supportedContexts

std::vector<FRAME_T> ACTION_TOOLBAR_CONTROL::m_supportedContexts

protected

List of frame types that support the control.

Definition at line 491 of file action_toolbar.h.

Referenced by ACTION_TOOLBAR_CONTROL(), and SupportedFor().

m_uiname

wxString ACTION_TOOLBAR_CONTROL::m_uiname

protected

Short description to show for the control.

Definition at line 481 of file action_toolbar.h.

Referenced by ACTION_TOOLBAR_CONTROL(), and GetUiName().

---

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

• action_toolbar.h