KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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_CONDITIONSCheck (const SELECTION_CONDITION &aCondition)
 
ACTION_CONDITIONSEnable (const SELECTION_CONDITION &aCondition)
 
ACTION_CONDITIONSShow (const SELECTION_CONDITION &aCondition)
 

Public Attributes

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

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 48 of file action_manager.h.

Constructor & Destructor Documentation

◆ ACTION_CONDITIONS()

ACTION_CONDITIONS::ACTION_CONDITIONS ( )
inline

Member Function Documentation

◆ Check()

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

◆ Enable()

◆ Show()

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

Definition at line 69 of file action_manager.h.

References showCondition.

Member Data Documentation

◆ checkCondition

SELECTION_CONDITION ACTION_CONDITIONS::checkCondition

Returns true if the UI control should be checked.

Definition at line 75 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 76 of file action_manager.h.

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

◆ showCondition

SELECTION_CONDITION ACTION_CONDITIONS::showCondition

Returns true if the UI control should be shown.

Definition at line 77 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: