KiCad PCB EDA Suite
EE_CONDITIONS Class Reference

#include <ee_selection_tool.h>

Inheritance diagram for EE_CONDITIONS:
SELECTION_CONDITIONS

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 HasTypes (const KICAD_T aTypes[])
 Create a functor that tests if among the selected items there is at least one of a given types. 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 Public Attributes

static SELECTION_CONDITION SingleSymbol
 
static SELECTION_CONDITION SingleSymbolOrPower
 
static SELECTION_CONDITION SingleDeMorganSymbol
 
static SELECTION_CONDITION SingleMultiUnitSymbol
 
static SELECTION_CONDITION SingleNonExcludedMarker
 

Static Private Member Functions

static bool hasTypeFunc (const SELECTION &aSelection, KICAD_T aType)
 < Helper function used by HasType() More...
 
static bool hasTypesFunc (const SELECTION &aSelection, const KICAD_T aTypes[])
 Helper function used by OnlyType() 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)
 

Detailed Description

Definition at line 46 of file ee_selection_tool.h.

Member Function Documentation

◆ andBoolFunc()

static bool SELECTION_CONDITIONS::andBoolFunc ( const SELECTION_CONDITION aConditionA,
SELECTION_BOOL aConditionB,
const SELECTION aSelection 
)
inlinestaticprivateinherited

Definition at line 238 of file selection_conditions.h.

240 {
241 return aConditionA( aSelection ) && aConditionB( aSelection );
242 }

◆ andFunc()

static bool SELECTION_CONDITIONS::andFunc ( const SELECTION_CONDITION aConditionA,
const SELECTION_CONDITION aConditionB,
const SELECTION aSelection 
)
inlinestaticprivateinherited

Helper function used by operator!

Definition at line 218 of file selection_conditions.h.

◆ Count()

SELECTION_CONDITION SELECTION_CONDITIONS::Count ( int  aNumber)
staticinherited

Create a functor that tests if the number of selected items is equal to the value given as parameter.

Parameters
aNumberis the number of expected items.
Returns
Functor testing if the number of selected items is equal aNumber.

Definition at line 85 of file selection_conditions.cpp.

86{
87 return std::bind( &SELECTION_CONDITIONS::countFunc, _1, aNumber );
88}
static bool countFunc(const SELECTION &aSelection, int aNumber)
Helper function used by MoreThan()

References SELECTION_CONDITIONS::countFunc().

Referenced by EE_SELECTION_TOOL::Init(), SCH_EDIT_TOOL::Init(), SYMBOL_EDITOR_EDIT_TOOL::Init(), SYMBOL_EDITOR_PIN_TOOL::Init(), BOARD_INSPECTION_TOOL::Init(), CONVERT_TOOL::Init(), EDIT_TOOL::Init(), PAD_TOOL::Init(), and PCB_EDIT_FRAME::setupUIConditions().

◆ countFunc()

bool SELECTION_CONDITIONS::countFunc ( const SELECTION aSelection,
int  aNumber 
)
staticprivateinherited

Helper function used by MoreThan()

Definition at line 165 of file selection_conditions.cpp.

166{
167 return aSelection.Size() == aNumber;
168}
int Size() const
Returns the number of selected parts.
Definition: selection.h:104

References SELECTION::Size().

Referenced by SELECTION_CONDITIONS::Count().

◆ Empty()

bool SELECTION_CONDITIONS::Empty ( const SELECTION aSelection)
staticinherited

Test if there are no items selected.

Parameters
aSelectionis the selection to be tested.
Returns
True if there are no items selected.

Definition at line 41 of file selection_conditions.cpp.

42{
43 return aSelection.Empty();
44}
bool Empty() const
Checks if there is anything selected.
Definition: selection.h:98

References SELECTION::Empty().

Referenced by EE_SELECTION_TOOL::Init(), and PL_SELECTION_TOOL::Init().

◆ HasType()

SELECTION_CONDITION SELECTION_CONDITIONS::HasType ( KICAD_T  aType)
staticinherited

Create a functor that tests if among the selected items there is at least one of a given type.

Parameters
aTypeis the type that is searched.
Returns
Functor testing for presence of items of a given type.

Definition at line 61 of file selection_conditions.cpp.

62{
63 return std::bind( &SELECTION_CONDITIONS::hasTypeFunc, _1, aType );
64}
static bool hasTypeFunc(const SELECTION &aSelection, KICAD_T aType)
< Helper function used by HasType()

References SELECTION_CONDITIONS::hasTypeFunc().

Referenced by PAD_TOOL::Init().

◆ hasTypeFunc()

bool SELECTION_CONDITIONS::hasTypeFunc ( const SELECTION aSelection,
KICAD_T  aType 
)
staticprivateinherited

< Helper function used by HasType()

Helper function used by HasTypes()

Definition at line 103 of file selection_conditions.cpp.

104{
105 if( aSelection.Empty() )
106 return false;
107
108 for( const EDA_ITEM* item : aSelection )
109 {
110 if( item->Type() == aType )
111 return true;
112 }
113
114 return false;
115}
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:100

References SELECTION::Empty().

Referenced by SELECTION_CONDITIONS::HasType().

◆ HasTypes()

SELECTION_CONDITION SELECTION_CONDITIONS::HasTypes ( const KICAD_T  aTypes[])
staticinherited

Create a functor that tests if among the selected items there is at least one of a given types.

Parameters
aTypesis an array containing types that are searched. It has to be ended with #KICAD_T::EOT as end marker.
Returns
Functor testing for presence of items of a given types.

Definition at line 67 of file selection_conditions.cpp.

68{
69 return std::bind( &SELECTION_CONDITIONS::hasTypesFunc, _1, aTypes );
70}
static bool hasTypesFunc(const SELECTION &aSelection, const KICAD_T aTypes[])
Helper function used by OnlyType()

References SELECTION_CONDITIONS::hasTypesFunc().

Referenced by EE_SELECTION_TOOL::Init().

◆ hasTypesFunc()

bool SELECTION_CONDITIONS::hasTypesFunc ( const SELECTION aSelection,
const KICAD_T  aTypes[] 
)
staticprivateinherited

Helper function used by OnlyType()

Definition at line 118 of file selection_conditions.cpp.

119{
120 if( aSelection.Empty() )
121 return false;
122
123 for( const EDA_ITEM* item : aSelection )
124 {
125 if( item->IsType( aTypes ) )
126 return true;
127 }
128
129 return false;
130}

References SELECTION::Empty().

Referenced by SELECTION_CONDITIONS::HasTypes().

◆ Idle()

bool SELECTION_CONDITIONS::Idle ( const SELECTION aSelection)
staticinherited

Test if there no items selected or being edited.

Parameters
aSelectionis the selection to be tested.
Returns
True if there are no items being edited or no items selected.

Definition at line 47 of file selection_conditions.cpp.

48{
49 constexpr int busyMask = ( IS_NEW | IS_PASTED | IS_MOVING | IS_RESIZING | IS_DRAGGING );
50
51 return !aSelection.Front() || ( aSelection.Front()->GetEditFlags() & busyMask ) == 0;
52}
EDA_ITEM_FLAGS GetEditFlags() const
Definition: eda_item.h:157
EDA_ITEM * Front() const
Definition: selection.h:182
#define IS_PASTED
Modifier on IS_NEW which indicates it came from clipboard.
#define IS_NEW
New item, just created.
#define IS_DRAGGING
Item being dragged.
#define IS_MOVING
Item being moved.
#define IS_RESIZING
Item being resized.

References SELECTION::Front(), EDA_ITEM::GetEditFlags(), IS_DRAGGING, IS_MOVING, IS_NEW, IS_PASTED, and IS_RESIZING.

Referenced by EE_INSPECTION_TOOL::Init(), EE_SELECTION_TOOL::Init(), SCH_EDIT_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), SYMBOL_EDITOR_EDIT_TOOL::Init(), SCH_EDIT_FRAME::setupUIConditions(), SYMBOL_EDIT_FRAME::setupUIConditions(), PL_EDITOR_FRAME::setupUIConditions(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), and PCB_EDIT_FRAME::setupUIConditions().

◆ IdleSelection()

bool SELECTION_CONDITIONS::IdleSelection ( const SELECTION aSelection)
staticinherited

Test if all selected items are not being edited.

Parameters
aSelectionis the selection to be tested.
Returns
True if no selected items are being edited.

Definition at line 55 of file selection_conditions.cpp.

56{
57 return ( aSelection.Front() && aSelection.Front()->GetEditFlags() == 0 );
58}

References SELECTION::Front(), and EDA_ITEM::GetEditFlags().

Referenced by SCH_EDIT_TOOL::Init(), SYMBOL_EDITOR_EDIT_TOOL::Init(), and SYMBOL_EDITOR_MOVE_TOOL::Init().

◆ LessThan()

SELECTION_CONDITION SELECTION_CONDITIONS::LessThan ( int  aNumber)
staticinherited

Create a functor that tests if the number of selected items is smaller than the value given as parameter.

Parameters
aNumberis the number used for comparison.
Returns
Functor testing if the number of selected items is smaller than aNumber.

Definition at line 97 of file selection_conditions.cpp.

98{
99 return std::bind( &SELECTION_CONDITIONS::lessThanFunc, _1, aNumber );
100}
static bool lessThanFunc(const SELECTION &aSelection, int aNumber)
Helper function used by operator||.

References SELECTION_CONDITIONS::lessThanFunc().

Referenced by EE_SELECTION_TOOL::Init().

◆ lessThanFunc()

bool SELECTION_CONDITIONS::lessThanFunc ( const SELECTION aSelection,
int  aNumber 
)
staticprivateinherited

Helper function used by operator||.

Definition at line 177 of file selection_conditions.cpp.

178{
179 return aSelection.Size() < aNumber;
180}

References SELECTION::Size().

Referenced by SELECTION_CONDITIONS::LessThan().

◆ MoreThan()

SELECTION_CONDITION SELECTION_CONDITIONS::MoreThan ( int  aNumber)
staticinherited

Create a functor that tests if the number of selected items is greater than the value given as parameter.

Parameters
aNumberis the number used for comparison.
Returns
Functor testing if the number of selected items is greater than aNumber.

Definition at line 91 of file selection_conditions.cpp.

92{
93 return std::bind( &SELECTION_CONDITIONS::moreThanFunc, _1, aNumber );
94}
static bool moreThanFunc(const SELECTION &aSelection, int aNumber)
Helper function used by LessThan()

References SELECTION_CONDITIONS::moreThanFunc().

Referenced by EE_SELECTION_TOOL::Init(), SCH_EDIT_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), CONVERT_TOOL::Init(), ALIGN_DISTRIBUTE_TOOL::Init(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), and PCB_EDIT_FRAME::setupUIConditions().

◆ moreThanFunc()

bool SELECTION_CONDITIONS::moreThanFunc ( const SELECTION aSelection,
int  aNumber 
)
staticprivateinherited

Helper function used by LessThan()

Definition at line 171 of file selection_conditions.cpp.

172{
173 return aSelection.Size() > aNumber;
174}

References SELECTION::Size().

Referenced by SELECTION_CONDITIONS::MoreThan().

◆ NotEmpty()

bool SELECTION_CONDITIONS::NotEmpty ( const SELECTION aSelection)
staticinherited

Test if there are any items selected.

Parameters
aSelectionis the selection to be tested.
Returns
True if there is at least one item selected.

Definition at line 35 of file selection_conditions.cpp.

36{
37 return !aSelection.Empty();
38}

References SELECTION::Empty().

Referenced by SCH_EDIT_TOOL::Init(), SYMBOL_EDITOR_EDIT_TOOL::Init(), PL_EDIT_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), EDIT_TOOL::Init(), GROUP_TOOL::Init(), PCB_SELECTION_TOOL::Init(), and PL_EDITOR_FRAME::setupUIConditions().

◆ notFunc()

static bool SELECTION_CONDITIONS::notFunc ( const SELECTION_CONDITION aCondition,
const SELECTION aSelection 
)
inlinestaticprivateinherited

Helper function used by operator||.

Definition at line 225 of file selection_conditions.h.

◆ OnlyType()

SELECTION_CONDITION SELECTION_CONDITIONS::OnlyType ( KICAD_T  aType)
staticinherited

Create a functor that tests if the selected items are only of given type.

Parameters
aTypeis the type that is searched.
Returns
Functor testing if selected items are exclusively of one type.

Definition at line 73 of file selection_conditions.cpp.

74{
75 return std::bind( &SELECTION_CONDITIONS::onlyTypeFunc, _1, aType );
76}
static bool onlyTypeFunc(const SELECTION &aSelection, KICAD_T aType)
Helper function used by OnlyTypes()

References SELECTION_CONDITIONS::onlyTypeFunc().

Referenced by EE_SELECTION_TOOL::Init(), SCH_EDIT_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), SCH_MOVE_TOOL::Init(), SYMBOL_EDITOR_PIN_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), CONVERT_TOOL::Init(), EDIT_TOOL::Init(), PAD_TOOL::Init(), and PCB_EDIT_FRAME::setupUIConditions().

◆ onlyTypeFunc()

bool SELECTION_CONDITIONS::onlyTypeFunc ( const SELECTION aSelection,
KICAD_T  aType 
)
staticprivateinherited

Helper function used by OnlyTypes()

Definition at line 133 of file selection_conditions.cpp.

134{
135 if( aSelection.Empty() )
136 return false;
137
138 KICAD_T types[] = { aType, EOT };
139
140 for( const EDA_ITEM* item : aSelection )
141 {
142 if( !item->IsType( types ) )
143 return false;
144 }
145
146 return true;
147}
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
Definition: typeinfo.h:78
@ EOT
search types array terminator (End Of Types)
Definition: typeinfo.h:81

References SELECTION::Empty(), and EOT.

Referenced by SELECTION_CONDITIONS::OnlyType().

◆ OnlyTypes()

SELECTION_CONDITION SELECTION_CONDITIONS::OnlyTypes ( const KICAD_T  aTypes[])
staticinherited

Create a functor that tests if the selected items are only of given types.

Parameters
aTypesis an array containing types that are searched. It has to be ended with #KICAD_T::EOT as end marker.
Returns
Functor testing if selected items are exclusively of the requested types.

Definition at line 79 of file selection_conditions.cpp.

80{
81 return std::bind( &SELECTION_CONDITIONS::onlyTypesFunc, _1, aTypes );
82}
static bool onlyTypesFunc(const SELECTION &aSelection, const KICAD_T aTypes[])
Helper function used by Count()

References SELECTION_CONDITIONS::onlyTypesFunc().

Referenced by EE_SELECTION_TOOL::Init(), SCH_EDIT_TOOL::Init(), BOARD_INSPECTION_TOOL::Init(), CONVERT_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().

◆ onlyTypesFunc()

bool SELECTION_CONDITIONS::onlyTypesFunc ( const SELECTION aSelection,
const KICAD_T  aTypes[] 
)
staticprivateinherited

Helper function used by Count()

Definition at line 150 of file selection_conditions.cpp.

151{
152 if( aSelection.Empty() )
153 return false;
154
155 for( const EDA_ITEM* item : aSelection )
156 {
157 if( !item->IsType( aTypes ) )
158 return false;
159 }
160
161 return true;
162}

References SELECTION::Empty().

Referenced by SELECTION_CONDITIONS::OnlyTypes().

◆ orBoolFunc()

static bool SELECTION_CONDITIONS::orBoolFunc ( const SELECTION_CONDITION aConditionA,
SELECTION_BOOL aConditionB,
const SELECTION aSelection 
)
inlinestaticprivateinherited

Helper function used by operator&&.

Definition at line 231 of file selection_conditions.h.

◆ orFunc()

static bool SELECTION_CONDITIONS::orFunc ( const SELECTION_CONDITION aConditionA,
const SELECTION_CONDITION aConditionB,
const SELECTION aSelection 
)
inlinestaticprivateinherited

Helper function used by operator&&.

Definition at line 211 of file selection_conditions.h.

◆ ShowAlways()

◆ ShowNever()

static bool SELECTION_CONDITIONS::ShowNever ( const SELECTION aSelection)
inlinestaticinherited

Always returns false.

Parameters
aSelectionis the selection to be tested.
Returns
Always false.

Definition at line 88 of file selection_conditions.h.

89 {
90 return false;
91 }

Referenced by ACTION_CONDITIONS::ACTION_CONDITIONS(), KICAD_MANAGER_FRAME::setupUIConditions(), and PL_EDITOR_FRAME::setupUIConditions().

Member Data Documentation

◆ SingleDeMorganSymbol

SELECTION_CONDITION EE_CONDITIONS::SingleDeMorganSymbol
static
Initial value:
= []( const SELECTION& aSel )
{
if( aSel.GetSize() == 1 )
{
SCH_SYMBOL* symbol = dynamic_cast<SCH_SYMBOL*>( aSel.Front() );
if( symbol )
return symbol->GetLibSymbolRef() && symbol->GetLibSymbolRef()->HasConversion();
}
return false;
}
Schematic symbol object.
Definition: sch_symbol.h:79
std::unique_ptr< LIB_SYMBOL > & GetLibSymbolRef()
Definition: sch_symbol.h:174

Definition at line 51 of file ee_selection_tool.h.

Referenced by SCH_EDIT_TOOL::Init().

◆ SingleMultiUnitSymbol

SELECTION_CONDITION EE_CONDITIONS::SingleMultiUnitSymbol
static
Initial value:
= []( const SELECTION& aSel )
{
if( aSel.GetSize() == 1 )
{
SCH_SYMBOL* symbol = dynamic_cast<SCH_SYMBOL*>( aSel.Front() );
if( symbol )
return symbol->GetLibSymbolRef() && symbol->GetLibSymbolRef()->GetUnitCount() >= 2;
}
return false;
}

Definition at line 52 of file ee_selection_tool.h.

Referenced by SCH_EDIT_TOOL::Init().

◆ SingleNonExcludedMarker

SELECTION_CONDITION EE_CONDITIONS::SingleNonExcludedMarker
static
Initial value:
= []( const SELECTION& aSel )
{
if( aSel.CountType( SCH_MARKER_T ) != 1 )
return false;
return !static_cast<SCH_MARKER*>( aSel.Front() )->IsExcluded();
}
@ SCH_MARKER_T
Definition: typeinfo.h:132

Definition at line 53 of file ee_selection_tool.h.

Referenced by EE_INSPECTION_TOOL::Init().

◆ SingleSymbol

SELECTION_CONDITION EE_CONDITIONS::SingleSymbol
static
Initial value:
= []( const SELECTION& aSel )
{
if( aSel.GetSize() == 1 )
{
SCH_SYMBOL* symbol = dynamic_cast<SCH_SYMBOL*>( aSel.Front() );
if( symbol )
return !symbol->GetLibSymbolRef() || !symbol->GetLibSymbolRef()->IsPower();
}
return false;
}

Definition at line 49 of file ee_selection_tool.h.

Referenced by EE_INSPECTION_TOOL::Init(), and SCH_EDIT_TOOL::Init().

◆ SingleSymbolOrPower

SELECTION_CONDITION EE_CONDITIONS::SingleSymbolOrPower
static
Initial value:
= []( const SELECTION& aSel )
{
return aSel.GetSize() == 1 && aSel.Front()->Type() == SCH_SYMBOL_T;
}
@ SCH_SYMBOL_T
Definition: typeinfo.h:147

Definition at line 50 of file ee_selection_tool.h.

Referenced by SCH_EDIT_TOOL::Init().


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