![]() |
KiCad PCB EDA Suite
|
Class that groups generic conditions for selected items. More...
#include <selection_conditions.h>
Static Public Member Functions | |
static bool | ShowAlways (const SELECTION &aSelection) |
The default condition function (always returns true). More... | |
static bool | ShowNever (const SELECTION &aSelection) |
Always returns false. More... | |
static bool | NotEmpty (const SELECTION &aSelection) |
Test if there are any items selected. More... | |
static bool | Empty (const SELECTION &aSelection) |
Test if there are no items selected. More... | |
static bool | Idle (const SELECTION &aSelection) |
Test if there no items selected or being edited. More... | |
static bool | IdleSelection (const SELECTION &aSelection) |
Test if all selected items are not being edited. More... | |
static SELECTION_CONDITION | HasType (KICAD_T aType) |
Create a functor that tests if among the selected items there is at least one of a given type. More... | |
static SELECTION_CONDITION | OnlyType (KICAD_T aType) |
Create a functor that tests if the selected items are only of given type. More... | |
static SELECTION_CONDITION | OnlyTypes (const KICAD_T aTypes[]) |
Create a functor that tests if the selected items are only of given types. More... | |
static SELECTION_CONDITION | Count (int aNumber) |
Create a functor that tests if the number of selected items is equal to the value given as parameter. More... | |
static SELECTION_CONDITION | MoreThan (int aNumber) |
Create a functor that tests if the number of selected items is greater than the value given as parameter. More... | |
static SELECTION_CONDITION | LessThan (int aNumber) |
Create a functor that tests if the number of selected items is smaller than the value given as parameter. More... | |
Static Private Member Functions | |
static bool | hasTypeFunc (const SELECTION &aSelection, KICAD_T aType) |
< Helper function used by HasType() More... | |
static bool | onlyTypeFunc (const SELECTION &aSelection, KICAD_T aType) |
Helper function used by OnlyTypes() More... | |
static bool | onlyTypesFunc (const SELECTION &aSelection, const KICAD_T aTypes[]) |
Helper function used by Count() More... | |
static bool | countFunc (const SELECTION &aSelection, int aNumber) |
Helper function used by MoreThan() More... | |
static bool | moreThanFunc (const SELECTION &aSelection, int aNumber) |
Helper function used by LessThan() More... | |
static bool | lessThanFunc (const SELECTION &aSelection, int aNumber) |
Helper function used by operator||. More... | |
static bool | orFunc (const SELECTION_CONDITION &aConditionA, const SELECTION_CONDITION &aConditionB, const SELECTION &aSelection) |
Helper function used by operator&&. More... | |
static bool | andFunc (const SELECTION_CONDITION &aConditionA, const SELECTION_CONDITION &aConditionB, const SELECTION &aSelection) |
Helper function used by operator! More... | |
static bool | notFunc (const SELECTION_CONDITION &aCondition, const SELECTION &aSelection) |
Helper function used by operator||. More... | |
static bool | orBoolFunc (const SELECTION_CONDITION &aConditionA, SELECTION_BOOL &aConditionB, const SELECTION &aSelection) |
Helper function used by operator&&. More... | |
static bool | andBoolFunc (const SELECTION_CONDITION &aConditionA, SELECTION_BOOL &aConditionB, const SELECTION &aSelection) |
Friends | |
SELECTION_CONDITION | operator|| (const SELECTION_CONDITION &aConditionA, const SELECTION_CONDITION &aConditionB) |
SELECTION_CONDITION | operator && (const SELECTION_CONDITION &aConditionA, const SELECTION_CONDITION &aConditionB) |
SELECTION_CONDITION | operator! (const SELECTION_CONDITION &aCondition) |
SELECTION_CONDITION | operator|| (const SELECTION_CONDITION &aConditionA, SELECTION_BOOL aConditionB) |
SELECTION_CONDITION | operator && (const SELECTION_CONDITION &aConditionA, SELECTION_BOOL aConditionB) |
Class that groups generic conditions for selected items.
Definition at line 68 of file selection_conditions.h.
|
inlinestaticprivate |
Definition at line 225 of file selection_conditions.h.
Referenced by operator &&().
|
inlinestaticprivate |
Helper function used by operator!
Definition at line 205 of file selection_conditions.h.
Referenced by operator &&().
|
static |
Create a functor that tests if the number of selected items is equal to the value given as parameter.
aNumber | is the number of expected items. |
Definition at line 77 of file selection_conditions.cpp.
References countFunc().
Referenced by SYMBOL_EDITOR_EDIT_TOOL::Init(), SYMBOL_EDITOR_PIN_TOOL::Init(), SCH_EDIT_TOOL::Init(), PAD_TOOL::Init(), CONVERT_TOOL::Init(), BOARD_INSPECTION_TOOL::Init(), EE_SELECTION_TOOL::Init(), EDIT_TOOL::Init(), and PCB_EDIT_FRAME::setupUIConditions().
|
staticprivate |
Helper function used by MoreThan()
Definition at line 139 of file selection_conditions.cpp.
References SELECTION::Size().
Referenced by Count().
|
static |
Test if there are no items selected.
aSelection | is the selection to be tested. |
Definition at line 41 of file selection_conditions.cpp.
References SELECTION::Empty().
Referenced by PL_SELECTION_TOOL::Init(), and EE_SELECTION_TOOL::Init().
|
static |
Create a functor that tests if among the selected items there is at least one of a given type.
aType | is the type that is searched. |
Definition at line 59 of file selection_conditions.cpp.
References hasTypeFunc().
Referenced by PAD_TOOL::Init().
|
staticprivate |
< Helper function used by HasType()
Helper function used by OnlyType()
Definition at line 95 of file selection_conditions.cpp.
Referenced by HasType().
|
static |
Test if there no items selected or being edited.
aSelection | is the selection to be tested. |
Definition at line 47 of file selection_conditions.cpp.
References SELECTION::Front(), and EDA_ITEM::GetEditFlags().
Referenced by SYMBOL_EDITOR_EDIT_TOOL::Init(), SCH_EDIT_TOOL::Init(), EE_INSPECTION_TOOL::Init(), EE_SELECTION_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), SCH_EDIT_FRAME::setupUIConditions(), PL_EDITOR_FRAME::setupUIConditions(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), SYMBOL_EDIT_FRAME::setupUIConditions(), and PCB_EDIT_FRAME::setupUIConditions().
|
static |
Test if all selected items are not being edited.
aSelection | is the selection to be tested. |
Definition at line 53 of file selection_conditions.cpp.
References SELECTION::Front(), and EDA_ITEM::GetEditFlags().
Referenced by SYMBOL_EDITOR_EDIT_TOOL::Init(), SYMBOL_EDITOR_MOVE_TOOL::Init(), and SCH_EDIT_TOOL::Init().
|
static |
Create a functor that tests if the number of selected items is smaller than the value given as parameter.
aNumber | is the number used for comparison. |
Definition at line 89 of file selection_conditions.cpp.
References lessThanFunc().
Referenced by EE_SELECTION_TOOL::Init().
|
staticprivate |
Helper function used by operator||.
Definition at line 151 of file selection_conditions.cpp.
References SELECTION::Size().
Referenced by LessThan().
|
static |
Create a functor that tests if the number of selected items is greater than the value given as parameter.
aNumber | is the number used for comparison. |
Definition at line 83 of file selection_conditions.cpp.
References moreThanFunc().
Referenced by SCH_EDIT_TOOL::Init(), CONVERT_TOOL::Init(), ALIGN_DISTRIBUTE_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), and PCB_EDIT_FRAME::setupUIConditions().
|
staticprivate |
Helper function used by LessThan()
Definition at line 145 of file selection_conditions.cpp.
References SELECTION::Size().
Referenced by MoreThan().
|
static |
Test if there are any items selected.
aSelection | is the selection to be tested. |
Definition at line 35 of file selection_conditions.cpp.
References SELECTION::Empty().
Referenced by SYMBOL_EDITOR_EDIT_TOOL::Init(), PL_EDIT_TOOL::Init(), SCH_EDIT_TOOL::Init(), GROUP_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), PCB_SELECTION_TOOL::Init(), EDIT_TOOL::Init(), and PL_EDITOR_FRAME::setupUIConditions().
|
inlinestaticprivate |
Helper function used by operator||.
Definition at line 212 of file selection_conditions.h.
Referenced by operator!().
|
static |
Create a functor that tests if the selected items are only of given type.
aType | is the type that is searched. |
Definition at line 65 of file selection_conditions.cpp.
References onlyTypeFunc().
Referenced by SYMBOL_EDITOR_PIN_TOOL::Init(), SCH_EDIT_TOOL::Init(), PAD_TOOL::Init(), CONVERT_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), SCH_MOVE_TOOL::Init(), EE_SELECTION_TOOL::Init(), EDIT_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), and PCB_EDIT_FRAME::setupUIConditions().
|
staticprivate |
Helper function used by OnlyTypes()
Definition at line 107 of file selection_conditions.cpp.
References SELECTION::Empty(), and EOT.
Referenced by OnlyType().
|
static |
Create a functor that tests if the selected items are only of given types.
aTypes | is an array containing types that are searched. It has to be ended with #KICAD_T::EOT as end marker. |
Definition at line 71 of file selection_conditions.cpp.
References onlyTypesFunc().
Referenced by SCH_EDIT_TOOL::Init(), CONVERT_TOOL::Init(), BOARD_INSPECTION_TOOL::Init(), EE_SELECTION_TOOL::Init(), EDIT_TOOL::Init(), EDIT_TOOL::Properties(), PCB_EDIT_FRAME::setupUIConditions(), BOARD_EDITOR_CONTROL::TrackWidthDec(), BOARD_EDITOR_CONTROL::TrackWidthInc(), BOARD_EDITOR_CONTROL::ViaSizeDec(), and BOARD_EDITOR_CONTROL::ViaSizeInc().
|
staticprivate |
Helper function used by Count()
Definition at line 124 of file selection_conditions.cpp.
References SELECTION::Empty().
Referenced by OnlyTypes().
|
inlinestaticprivate |
Helper function used by operator&&.
Definition at line 218 of file selection_conditions.h.
Referenced by operator||().
|
inlinestaticprivate |
Helper function used by operator&&.
Definition at line 198 of file selection_conditions.h.
Referenced by operator||().
|
inlinestatic |
The default condition function (always returns true).
aSelection | is the selection to be tested. |
Definition at line 77 of file selection_conditions.h.
Referenced by ACTION_CONDITIONS::ACTION_CONDITIONS(), CONDITIONAL_MENU::AddSeparator(), EDA_DRAW_FRAME::AddStandardSubMenus(), ROUTER_TOOL::Init(), LENGTH_TUNER_TOOL::Init(), PL_EDIT_TOOL::Init(), PAD_TOOL::Init(), PL_DRAWING_TOOLS::Init(), EDA_3D_CONTROLLER::Init(), DRAWING_TOOL::Init(), EE_TOOL_BASE< SCH_BASE_FRAME >::Init(), PCB_TOOL_BASE::Init(), PICKER_TOOL::Init(), SCH_EDIT_FRAME::setupUIConditions(), PL_EDITOR_FRAME::setupUIConditions(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), SYMBOL_EDIT_FRAME::setupUIConditions(), PCB_EDIT_FRAME::setupUIConditions(), and SPECIAL_TOOLS_CONTEXT_MENU::SPECIAL_TOOLS_CONTEXT_MENU().
|
inlinestatic |
Always returns false.
aSelection | is the selection to be tested. |
Definition at line 88 of file selection_conditions.h.
Referenced by ACTION_CONDITIONS::ACTION_CONDITIONS(), and PL_EDITOR_FRAME::setupUIConditions().
|
friend |
Definition at line 164 of file selection_conditions.cpp.
|
friend |
Definition at line 190 of file selection_conditions.cpp.
|
friend |
Definition at line 171 of file selection_conditions.cpp.
|
friend |
Definition at line 157 of file selection_conditions.cpp.
|
friend |
Definition at line 177 of file selection_conditions.cpp.