ACTION_CONDITIONS Struct Reference

Functors that can be used to figure out how the action controls should be displayed in the UI and if an action should be enabled given the current selection. More...

#include <action_manager.h>

Public Member Functions
	ACTION_CONDITIONS ()
ACTION_CONDITIONS &	Check (const SELECTION_CONDITION &aCondition)
ACTION_CONDITIONS &	Enable (const SELECTION_CONDITION &aCondition)
ACTION_CONDITIONS &	Show (const SELECTION_CONDITION &aCondition)

Public Attributes
SELECTION_CONDITION	checkCondition
	Returns true if the UI control should be checked.
SELECTION_CONDITION	enableCondition
	Returns true if the UI control should be enabled.
SELECTION_CONDITION	showCondition
	Returns true if the UI control should be shown.

Detailed Description

Functors that can be used to figure out how the action controls should be displayed in the UI and if an action should be enabled given the current selection.

Note

checkCondition is also used for determining the state of a toggled toolbar item (the item is toggled when the condition is true).

Definition at line 46 of file action_manager.h.

Constructor & Destructor Documentation

ACTION_CONDITIONS()

ACTION_CONDITIONS::ACTION_CONDITIONS ( )

inline

Definition at line 48 of file action_manager.h.

References checkCondition, enableCondition, SELECTION_CONDITIONS::ShowAlways(), showCondition, and SELECTION_CONDITIONS::ShowNever().

Referenced by Check(), Enable(), and Show().

Member Function Documentation

Check()

ACTION_CONDITIONS & ACTION_CONDITIONS::Check ( const SELECTION_CONDITION & aCondition )

inline

Definition at line 55 of file action_manager.h.

References ACTION_CONDITIONS(), and checkCondition.

Referenced by EDA_BASE_FRAME::setupUIConditions().

Enable()

ACTION_CONDITIONS & ACTION_CONDITIONS::Enable ( const SELECTION_CONDITION & aCondition )

inline

Definition at line 61 of file action_manager.h.

References ACTION_CONDITIONS(), and enableCondition.

Referenced by BITMAP2CMP_FRAME::doReCreateMenuBar(), KICAD_MANAGER_FRAME::doReCreateMenuBar(), PCB_EDIT_FRAME::doReCreateMenuBar(), PL_EDITOR_FRAME::doReCreateMenuBar(), SCH_EDIT_FRAME::doReCreateMenuBar(), and KICAD_MANAGER_FRAME::setupUIConditions().

Show()

ACTION_CONDITIONS & ACTION_CONDITIONS::Show ( const SELECTION_CONDITION & aCondition )

inline

Definition at line 67 of file action_manager.h.

References ACTION_CONDITIONS(), and showCondition.

Member Data Documentation

checkCondition

SELECTION_CONDITION ACTION_CONDITIONS::checkCondition

Returns true if the UI control should be checked.

Definition at line 73 of file action_manager.h.

Referenced by ACTION_CONDITIONS(), Check(), and EDA_BASE_FRAME::HandleUpdateUIEvent().

enableCondition

SELECTION_CONDITION ACTION_CONDITIONS::enableCondition

Returns true if the UI control should be enabled.

Definition at line 74 of file action_manager.h.

Referenced by ACTION_CONDITIONS(), Enable(), EDA_BASE_FRAME::HandleUpdateUIEvent(), NL_GERBVIEW_PLUGIN_IMPL::SetActiveCommand(), and NL_PL_EDITOR_PLUGIN_IMPL::SetActiveCommand().

showCondition

SELECTION_CONDITION ACTION_CONDITIONS::showCondition

Returns true if the UI control should be shown.

Definition at line 75 of file action_manager.h.

Referenced by ACTION_CONDITIONS(), EDA_BASE_FRAME::HandleUpdateUIEvent(), and Show().

---

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

• action_manager.h