EDITOR_CONDITIONS Class Reference

Class that groups generic conditions for editor states. More...

#include <editor_conditions.h>

Inheritance diagram for EDITOR_CONDITIONS:

Public Member Functions
	EDITOR_CONDITIONS (EDA_BASE_FRAME *aFrame)
	Create an object to define conditions dependent upon a specific frame.
SELECTION_CONDITION	ContentModified ()
	Create a functor that tests if the content of the frame is modified.
virtual SELECTION_CONDITION	UndoAvailable ()
	Create a functor that tests if there are any items in the undo queue.
SELECTION_CONDITION	RedoAvailable ()
	Create a functor that tests if there are any items in the redo queue.
SELECTION_CONDITION	Units (EDA_UNITS aUnit)
	Create a functor that tests if the frame has the specified units.
SELECTION_CONDITION	CurrentTool (const TOOL_ACTION &aTool)
	Create a functor testing if the specified tool is the current active tool in the frame.
SELECTION_CONDITION	NoActiveTool ()
	Create a functor testing if there are no tools active in the frame.
SELECTION_CONDITION	GridVisible ()
	Create a functor testing if the grid is visible in a frame.
SELECTION_CONDITION	GridOverrides ()
	Create a functor testing if the grid overrides wires is enabled in a frame.
SELECTION_CONDITION	PolarCoordinates ()
	Create a functor testing if polar coordinates are current being used.
SELECTION_CONDITION	FullscreenCursor ()
	Create a functor testing if the cursor is full screen in a frame.
SELECTION_CONDITION	BoundingBoxes ()
SELECTION_CONDITION	ScriptingConsoleVisible ()
	Create a functor testing if the python scripting console window is visible.

Static Public Member Functions
static bool	ShowAlways (const SELECTION &aSelection)
	The default condition function (always returns true).
static bool	ShowNever (const SELECTION &aSelection)
	Always returns false.
static bool	NotEmpty (const SELECTION &aSelection)
	Test if there are any items selected.
static bool	Empty (const SELECTION &aSelection)
	Test if there are no items selected.
static bool	Idle (const SELECTION &aSelection)
	Test if there no items selected or being edited.
static bool	IdleSelection (const SELECTION &aSelection)
	Test if all selected items are not being edited.
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.
static SELECTION_CONDITION	HasTypes (std::vector< KICAD_T > aTypes)
	Create a functor that tests if among the selected items there is at least one of a given types.
static SELECTION_CONDITION	OnlyTypes (std::vector< KICAD_T > aTypes)
	Create a functor that tests if the selected items are only of given types.
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.
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.
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.

Static Protected Member Functions
static bool	contentModifiedFunc (const SELECTION &aSelection, EDA_BASE_FRAME *aFrame)
	< Helper function used by ContentModified().
static bool	undoFunc (const SELECTION &aSelection, EDA_BASE_FRAME *aFrame)
	Helper function used by RedoAvailable().
static bool	redoFunc (const SELECTION &aSelection, EDA_BASE_FRAME *aFrame)
	Helper function used by Units().
static bool	unitsFunc (const SELECTION &aSelection, EDA_BASE_FRAME *aFrame, EDA_UNITS aUnits)
	Helper function used by CurrentTool().
static bool	toolFunc (const SELECTION &aSelection, EDA_BASE_FRAME *aFrame, const TOOL_ACTION &aTool)
	Helper function used by NoActiveTool().
static bool	noToolFunc (const SELECTION &aSelection, EDA_BASE_FRAME *aFrame)
	Helper function used by GridVisible().
static bool	gridFunc (const SELECTION &aSelection, EDA_DRAW_FRAME *aFrame)
	Helper function used by GridOverrides().
static bool	gridOverridesFunc (const SELECTION &aSelection, EDA_DRAW_FRAME *aFrame)
	Helper function used by PolarCoordinates().
static bool	polarCoordFunc (const SELECTION &aSelection, EDA_DRAW_FRAME *aFrame)
	Helper function used by FullscreenCursor().
static bool	cursorFunc (const SELECTION &aSelection, EDA_DRAW_FRAME *aFrame)
	Helper function used by DrawBoundingBoxes().
static bool	bboxesFunc (const SELECTION &aSelection, EDA_DRAW_FRAME *aFrame)
	Helper function used by ScriptingConsoleVisible().
static bool	consoleVisibleFunc (const SELECTION &aSelection, EDA_DRAW_FRAME *aFrame)
	The frame to apply the conditions to.

Protected Attributes
EDA_BASE_FRAME *	m_frame

Static Private Member Functions
static bool	hasTypeFunc (const SELECTION &aSelection, KICAD_T aType)
	< Helper function used by HasType()
static bool	hasTypesFunc (const SELECTION &aSelection, std::vector< KICAD_T > aTypes)
	Helper function used by OnlyTypes()
static bool	onlyTypesFunc (const SELECTION &aSelection, std::vector< KICAD_T > aTypes)
	Helper function used by Count()
static bool	countFunc (const SELECTION &aSelection, int aNumber)
	Helper function used by MoreThan()
static bool	moreThanFunc (const SELECTION &aSelection, int aNumber)
	Helper function used by LessThan()
static bool	lessThanFunc (const SELECTION &aSelection, int aNumber)
	Helper function used by operator||.
static bool	orFunc (const SELECTION_CONDITION &aConditionA, const SELECTION_CONDITION &aConditionB, const SELECTION &aSelection)
	Helper function used by operator&&.
static bool	andFunc (const SELECTION_CONDITION &aConditionA, const SELECTION_CONDITION &aConditionB, const SELECTION &aSelection)
	Helper function used by operator!
static bool	notFunc (const SELECTION_CONDITION &aCondition, const SELECTION &aSelection)
	Helper function used by operator||.
static bool	orBoolFunc (const SELECTION_CONDITION &aConditionA, SELECTION_BOOL &aConditionB, const SELECTION &aSelection)
	Helper function used by operator&&.
static bool	andBoolFunc (const SELECTION_CONDITION &aConditionA, SELECTION_BOOL &aConditionB, const SELECTION &aSelection)

Detailed Description

Class that groups generic conditions for editor states.

Definition at line 40 of file editor_conditions.h.

Constructor & Destructor Documentation

EDITOR_CONDITIONS()

EDITOR_CONDITIONS::EDITOR_CONDITIONS ( EDA_BASE_FRAME *  aFrame )

inline

Create an object to define conditions dependent upon a specific frame.

Parameters

aFrame

is the frame to query for the conditions

Definition at line 48 of file editor_conditions.h.

Member Function Documentation

andBoolFunc()

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

inlinestaticprivateinherited

Definition at line 202 of file selection_conditions.h.

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 182 of file selection_conditions.h.

bboxesFunc()

bool EDITOR_CONDITIONS::bboxesFunc ( const SELECTION &  aSelection, EDA_DRAW_FRAME *  aFrame  )

staticprotected

Helper function used by ScriptingConsoleVisible().

Definition at line 202 of file editor_conditions.cpp.

References EDA_DRAW_FRAME::GetCanvas(), KIGFX::RENDER_SETTINGS::GetDrawBoundingBoxes(), KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), and EDA_DRAW_PANEL_GAL::GetView().

Referenced by BoundingBoxes().

BoundingBoxes()

SELECTION_CONDITION EDITOR_CONDITIONS::BoundingBoxes

(

)

Definition at line 120 of file editor_conditions.cpp.

References bboxesFunc(), and m_frame.

Referenced by SCH_EDIT_FRAME::setupUIConditions(), SYMBOL_EDIT_FRAME::setupUIConditions(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), FOOTPRINT_VIEWER_FRAME::setupUIConditions(), and PCB_EDIT_FRAME::setupUIConditions().

consoleVisibleFunc()

bool EDITOR_CONDITIONS::consoleVisibleFunc ( const SELECTION &  aSelection, EDA_DRAW_FRAME *  aFrame  )

staticprotected

The frame to apply the conditions to.

Definition at line 208 of file editor_conditions.cpp.

References EDA_DRAW_FRAME::IsScriptingConsoleVisible().

Referenced by ScriptingConsoleVisible().

ContentModified()

SELECTION_CONDITION EDITOR_CONDITIONS::ContentModified

(

)

Create a functor that tests if the content of the frame is modified.

Returns

Functor testing for modified content.

Definition at line 40 of file editor_conditions.cpp.

References contentModifiedFunc(), and m_frame.

Referenced by CVPCB_MAINFRAME::setupUIConditions(), and FOOTPRINT_EDIT_FRAME::setupUIConditions().

contentModifiedFunc()

bool EDITOR_CONDITIONS::contentModifiedFunc ( const SELECTION &  aSelection, EDA_BASE_FRAME *  aFrame  )

staticprotected

< Helper function used by ContentModified().

Helper function used by UndoAvailable().

Definition at line 140 of file editor_conditions.cpp.

References EDA_BASE_FRAME::IsContentModified().

Referenced by ContentModified().

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

aNumber

is the number of expected items.

Returns

Functor testing if the number of selected items is equal aNumber.

Definition at line 79 of file selection_conditions.cpp.

References SELECTION_CONDITIONS::countFunc().

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

countFunc()

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

staticprivateinherited

Helper function used by MoreThan()

Definition at line 142 of file selection_conditions.cpp.

References SELECTION::Size().

Referenced by SELECTION_CONDITIONS::Count().

CurrentTool()

SELECTION_CONDITION EDITOR_CONDITIONS::CurrentTool

(

const TOOL_ACTION &

aTool

)

Create a functor testing if the specified tool is the current active tool in the frame.

Returns

Functor testing the current tool of a frame.

Definition at line 64 of file editor_conditions.cpp.

References m_frame, and toolFunc().

Referenced by DISPLAY_FOOTPRINTS_FRAME::setupUIConditions(), SCH_EDIT_FRAME::setupUIConditions(), SYMBOL_EDIT_FRAME::setupUIConditions(), GERBVIEW_FRAME::setupUIConditions(), PL_EDITOR_FRAME::setupUIConditions(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), and FOOTPRINT_VIEWER_FRAME::setupUIConditions().

cursorFunc()

bool EDITOR_CONDITIONS::cursorFunc ( const SELECTION &  aSelection, EDA_DRAW_FRAME *  aFrame  )

staticprotected

Helper function used by DrawBoundingBoxes().

Definition at line 196 of file editor_conditions.cpp.

References EDA_DRAW_FRAME::GetGalDisplayOptions(), and KIGFX::GAL_DISPLAY_OPTIONS::m_fullscreenCursor.

Referenced by FullscreenCursor().

Empty()

bool SELECTION_CONDITIONS::Empty ( const SELECTION &  aSelection )

staticinherited

Test if there are no items selected.

Definition at line 41 of file selection_conditions.cpp.

References SELECTION::Empty().

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

FullscreenCursor()

SELECTION_CONDITION EDITOR_CONDITIONS::FullscreenCursor

(

)

Create a functor testing if the cursor is full screen in a frame.

Note

This requires the frame passed into the constructor be be derived from EDA_DRAW_FRAME.

Returns

Functor testing if the cursor is full screen

Definition at line 109 of file editor_conditions.cpp.

References cursorFunc(), and m_frame.

Referenced by DISPLAY_FOOTPRINTS_FRAME::setupUIConditions(), SCH_EDIT_FRAME::setupUIConditions(), SYMBOL_EDIT_FRAME::setupUIConditions(), GERBVIEW_FRAME::setupUIConditions(), PL_EDITOR_FRAME::setupUIConditions(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), FOOTPRINT_VIEWER_FRAME::setupUIConditions(), and PCB_EDIT_FRAME::setupUIConditions().

gridFunc()

bool EDITOR_CONDITIONS::gridFunc ( const SELECTION &  aSelection, EDA_DRAW_FRAME *  aFrame  )

staticprotected

Helper function used by GridOverrides().

Definition at line 178 of file editor_conditions.cpp.

References EDA_DRAW_FRAME::IsGridVisible().

Referenced by GridVisible().

GridOverrides()

SELECTION_CONDITION EDITOR_CONDITIONS::GridOverrides

(

)

Create a functor testing if the grid overrides wires is enabled in a frame.

Note

This requires the frame passed into the constructor be be derived from EDA_DRAW_FRAME.

Returns

Functor testing if grid overrides are enabled

Definition at line 87 of file editor_conditions.cpp.

References gridOverridesFunc(), and m_frame.

Referenced by SCH_EDIT_FRAME::setupUIConditions(), SYMBOL_EDIT_FRAME::setupUIConditions(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), and PCB_EDIT_FRAME::setupUIConditions().

gridOverridesFunc()

bool EDITOR_CONDITIONS::gridOverridesFunc ( const SELECTION &  aSelection, EDA_DRAW_FRAME *  aFrame  )

staticprotected

Helper function used by PolarCoordinates().

Definition at line 184 of file editor_conditions.cpp.

References EDA_DRAW_FRAME::IsGridOverridden().

Referenced by GridOverrides().

GridVisible()

SELECTION_CONDITION EDITOR_CONDITIONS::GridVisible

(

)

Create a functor testing if the grid is visible in a frame.

Note

This requires the frame passed into the constructor be be derived from EDA_DRAW_FRAME.

Returns

Functor testing if the grid is visible

Definition at line 76 of file editor_conditions.cpp.

References gridFunc(), and m_frame.

Referenced by DISPLAY_FOOTPRINTS_FRAME::setupUIConditions(), SCH_EDIT_FRAME::setupUIConditions(), SYMBOL_EDIT_FRAME::setupUIConditions(), SYMBOL_VIEWER_FRAME::setupUIConditions(), GERBVIEW_FRAME::setupUIConditions(), PL_EDITOR_FRAME::setupUIConditions(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), FOOTPRINT_VIEWER_FRAME::setupUIConditions(), and PCB_EDIT_FRAME::setupUIConditions().

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

aType

is 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.

References SELECTION_CONDITIONS::hasTypeFunc().

Referenced by SCH_EDIT_TOOL::Init(), EDIT_TOOL::Init(), PAD_TOOL::Init(), PCB_SELECTION_TOOL::Init(), and FOOTPRINT_EDIT_FRAME::setupUIConditions().

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 97 of file selection_conditions.cpp.

References SELECTION::Empty().

Referenced by SELECTION_CONDITIONS::HasType().

HasTypes()

SELECTION_CONDITION SELECTION_CONDITIONS::HasTypes ( std::vector< KICAD_T >  aTypes )

staticinherited

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

Parameters

aTypes

is an array containing types that are searched.

Returns

Functor testing for presence of items of a given types.

Definition at line 67 of file selection_conditions.cpp.

References SELECTION_CONDITIONS::hasTypesFunc().

Referenced by EE_SELECTION_TOOL::Init(), SCH_EDIT_TOOL::Init(), EDIT_TOOL::Init(), makeShapeModificationMenu(), and PCB_EDIT_FRAME::setupUIConditions().

hasTypesFunc()

bool SELECTION_CONDITIONS::hasTypesFunc ( const SELECTION &  aSelection, std::vector< KICAD_T >  aTypes  )

staticprivateinherited

Helper function used by OnlyTypes()

Definition at line 112 of file selection_conditions.cpp.

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.

Definition at line 47 of file selection_conditions.cpp.

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

Referenced by EDIT_TABLE_TOOL_BASE< T_TABLE, T_TABLECELL, T_COMMIT >::addMenus(), 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.

Definition at line 55 of file selection_conditions.cpp.

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

aNumber

is the number used for comparison.

Returns

Functor testing if the number of selected items is smaller than aNumber.

Definition at line 91 of file selection_conditions.cpp.

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 154 of file selection_conditions.cpp.

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

aNumber

is the number used for comparison.

Returns

Functor testing if the number of selected items is greater than aNumber.

Definition at line 85 of file selection_conditions.cpp.

References SELECTION_CONDITIONS::moreThanFunc().

Referenced by EDIT_TABLE_TOOL_BASE< T_TABLE, T_TABLECELL, T_COMMIT >::addMenus(), EE_SELECTION_TOOL::Init(), SCH_EDIT_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), SYMBOL_EDITOR_EDIT_TOOL::Init(), CONVERT_TOOL::Init(), EDIT_TOOL::Init(), PCB_SELECTION_TOOL::Init(), ALIGN_DISTRIBUTE_TOOL::Init(), makeShapeModificationMenu(), and PCB_EDIT_FRAME::setupUIConditions().

moreThanFunc()

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

staticprivateinherited

Helper function used by LessThan()

Definition at line 148 of file selection_conditions.cpp.

References SELECTION::Size().

Referenced by SELECTION_CONDITIONS::MoreThan().

NoActiveTool()

SELECTION_CONDITION EDITOR_CONDITIONS::NoActiveTool

(

)

Create a functor testing if there are no tools active in the frame.

Returns

Functor testing the frame has no tools running.

Definition at line 70 of file editor_conditions.cpp.

References m_frame, and noToolFunc().

Referenced by SCH_EDIT_FRAME::setupUIConditions(), SYMBOL_EDIT_FRAME::setupUIConditions(), PL_EDITOR_FRAME::setupUIConditions(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), and PCB_EDIT_FRAME::setupUIConditions().

NotEmpty()

bool SELECTION_CONDITIONS::NotEmpty ( const SELECTION &  aSelection )

staticinherited

Test if there are any items selected.

Definition at line 35 of file selection_conditions.cpp.

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(), makePositioningToolsMenu(), SCH_EDIT_FRAME::setupUIConditions(), PL_EDITOR_FRAME::setupUIConditions(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), and PCB_EDIT_FRAME::setupUIConditions().

notFunc()

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

inlinestaticprivateinherited

Helper function used by operator||.

Definition at line 189 of file selection_conditions.h.

noToolFunc()

bool EDITOR_CONDITIONS::noToolFunc ( const SELECTION &  aSelection, EDA_BASE_FRAME *  aFrame  )

staticprotected

Helper function used by GridVisible().

Definition at line 172 of file editor_conditions.cpp.

References TOOLS_HOLDER::ToolStackIsEmpty().

Referenced by NoActiveTool().

OnlyTypes()

SELECTION_CONDITION SELECTION_CONDITIONS::OnlyTypes ( std::vector< KICAD_T >  aTypes )

staticinherited

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

Parameters

aTypes

is an array containing types that are searched.

Returns

Functor testing if selected items are exclusively of the requested types.

Definition at line 73 of file selection_conditions.cpp.

References SELECTION_CONDITIONS::onlyTypesFunc().

Referenced by EDIT_TABLE_TOOL_BASE< T_TABLE, T_TABLECELL, T_COMMIT >::addMenus(), EE_SELECTION_TOOL::Init(), SCH_EDIT_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), SCH_MOVE_TOOL::Init(), SYMBOL_EDITOR_EDIT_TOOL::Init(), SYMBOL_EDITOR_PIN_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), CONVERT_TOOL::Init(), EDIT_TOOL::Init(), PAD_TOOL::Init(), PCB_SELECTION_TOOL::Init(), makeShapeModificationMenu(), SCH_EDIT_TOOL::Properties(), 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, std::vector< KICAD_T >  aTypes  )

staticprivateinherited

Helper function used by Count()

Definition at line 127 of file selection_conditions.cpp.

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 195 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 175 of file selection_conditions.h.

polarCoordFunc()

bool EDITOR_CONDITIONS::polarCoordFunc ( const SELECTION &  aSelection, EDA_DRAW_FRAME *  aFrame  )

staticprotected

Helper function used by FullscreenCursor().

Definition at line 190 of file editor_conditions.cpp.

References EDA_DRAW_FRAME::GetShowPolarCoords().

Referenced by PolarCoordinates().

PolarCoordinates()

SELECTION_CONDITION EDITOR_CONDITIONS::PolarCoordinates

(

)

Create a functor testing if polar coordinates are current being used.

Note

This requires the frame passed into the constructor be be derived from EDA_DRAW_FRAME.

Returns

Functor testing if the grid is visible

Definition at line 98 of file editor_conditions.cpp.

References m_frame, and polarCoordFunc().

Referenced by GERBVIEW_FRAME::setupUIConditions(), and PCB_EDIT_FRAME::setupUIConditions().

RedoAvailable()

SELECTION_CONDITION EDITOR_CONDITIONS::RedoAvailable

(

)

Create a functor that tests if there are any items in the redo queue.

Returns

Functor testing if the redo queue has items.

Definition at line 52 of file editor_conditions.cpp.

References m_frame, and redoFunc().

Referenced by CVPCB_MAINFRAME::setupUIConditions(), SCH_EDIT_FRAME::setupUIConditions(), SYMBOL_EDIT_FRAME::setupUIConditions(), PL_EDITOR_FRAME::setupUIConditions(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), and PCB_EDIT_FRAME::setupUIConditions().

redoFunc()

bool EDITOR_CONDITIONS::redoFunc ( const SELECTION &  aSelection, EDA_BASE_FRAME *  aFrame  )

staticprotected

Helper function used by Units().

Definition at line 152 of file editor_conditions.cpp.

References EDA_BASE_FRAME::GetRedoCommandCount().

Referenced by RedoAvailable().

ScriptingConsoleVisible()

SELECTION_CONDITION EDITOR_CONDITIONS::ScriptingConsoleVisible

(

)

Create a functor testing if the python scripting console window is visible.

Note

This requires the frame passed into the constructor be be derived from EDA_DRAW_FRAME.

Returns

Functor testing if the python scripting console window is visible

Definition at line 130 of file editor_conditions.cpp.

References consoleVisibleFunc(), and m_frame.

Referenced by SCH_EDIT_FRAME::setupUIConditions(), and PCB_EDIT_FRAME::setupUIConditions().

ShowAlways()

static bool SELECTION_CONDITIONS::ShowAlways ( const SELECTION &  aSelection )

inlinestaticinherited

The default condition function (always returns true).

Definition at line 75 of file selection_conditions.h.

Referenced by ACTION_CONDITIONS::ACTION_CONDITIONS(), LIBRARY_EDITOR_CONTROL::AddContextMenuItems(), CONDITIONAL_MENU::AddSeparator(), EDA_DRAW_FRAME::AddStandardSubMenus(), EDA_3D_CONTROLLER::Init(), EE_TOOL_BASE< T >::Init(), SCH_DESIGN_BLOCK_CONTROL::Init(), SCH_EDIT_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), PICKER_TOOL::Init(), ZOOM_TOOL::Init(), PL_DRAWING_TOOLS::Init(), PL_EDIT_TOOL::Init(), ROUTER_TOOL::Init(), FOOTPRINT_EDITOR_CONTROL::Init(), GENERATOR_TOOL::Init(), PAD_TOOL::Init(), PCB_PICKER_TOOL::Init(), PCB_TOOL_BASE::Init(), LOCK_CONTEXT_MENU::LOCK_CONTEXT_MENU(), SCH_EDIT_FRAME::setupUIConditions(), SIMULATOR_FRAME::setupUIConditions(), SYMBOL_EDIT_FRAME::setupUIConditions(), PL_EDITOR_FRAME::setupUIConditions(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), and PCB_EDIT_FRAME::setupUIConditions().

ShowNever()

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

inlinestaticinherited

Always returns false.

Definition at line 80 of file selection_conditions.h.

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

toolFunc()

bool EDITOR_CONDITIONS::toolFunc ( const SELECTION &  aSelection, EDA_BASE_FRAME *  aFrame, const TOOL_ACTION &  aTool  )

staticprotected

Helper function used by NoActiveTool().

Definition at line 165 of file editor_conditions.cpp.

References TOOLS_HOLDER::IsCurrentTool().

Referenced by CurrentTool().

UndoAvailable()

SELECTION_CONDITION EDITOR_CONDITIONS::UndoAvailable ( )

virtual

Create a functor that tests if there are any items in the undo queue.

Returns

Functor testing if the undo queue has items.

Definition at line 46 of file editor_conditions.cpp.

References m_frame, and undoFunc().

Referenced by CVPCB_MAINFRAME::setupUIConditions(), SYMBOL_EDIT_FRAME::setupUIConditions(), PL_EDITOR_FRAME::setupUIConditions(), and FOOTPRINT_EDIT_FRAME::setupUIConditions().

undoFunc()

bool EDITOR_CONDITIONS::undoFunc ( const SELECTION &  aSelection, EDA_BASE_FRAME *  aFrame  )

staticprotected

Helper function used by RedoAvailable().

Definition at line 146 of file editor_conditions.cpp.

References EDA_BASE_FRAME::GetUndoCommandCount().

Referenced by UndoAvailable().

Units()

SELECTION_CONDITION EDITOR_CONDITIONS::Units

(

EDA_UNITS

aUnit

)

Create a functor that tests if the frame has the specified units.

Returns

Functor testing the units of a frame.

Definition at line 58 of file editor_conditions.cpp.

References m_frame, and unitsFunc().

Referenced by DISPLAY_FOOTPRINTS_FRAME::setupUIConditions(), SCH_EDIT_FRAME::setupUIConditions(), SYMBOL_EDIT_FRAME::setupUIConditions(), GERBVIEW_FRAME::setupUIConditions(), PL_EDITOR_FRAME::setupUIConditions(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), FOOTPRINT_VIEWER_FRAME::setupUIConditions(), and PCB_EDIT_FRAME::setupUIConditions().

unitsFunc()

bool EDITOR_CONDITIONS::unitsFunc ( const SELECTION &  aSelection, EDA_BASE_FRAME *  aFrame, EDA_UNITS  aUnits  )

staticprotected

Helper function used by CurrentTool().

Definition at line 158 of file editor_conditions.cpp.

References UNITS_PROVIDER::GetUserUnits().

Referenced by Units().

Member Data Documentation

m_frame

EDA_BASE_FRAME* EDITOR_CONDITIONS::m_frame

protected

Definition at line 180 of file editor_conditions.h.

Referenced by BoundingBoxes(), ContentModified(), CurrentTool(), FullscreenCursor(), PCB_EDITOR_CONDITIONS::Get45degMode(), PCB_EDITOR_CONDITIONS::GraphicsFillDisplay(), GridOverrides(), GridVisible(), PCB_EDITOR_CONDITIONS::HasItems(), SCH_EDITOR_CONDITIONS::LineMode(), NoActiveTool(), PCB_EDITOR_CONDITIONS::PadFillDisplay(), PCB_EDITOR_CONDITIONS::PadNumbersDisplay(), PolarCoordinates(), RedoAvailable(), ScriptingConsoleVisible(), PCB_EDITOR_CONDITIONS::TextFillDisplay(), PCB_EDITOR_CONDITIONS::TrackFillDisplay(), UndoAvailable(), Units(), PCB_EDITOR_CONDITIONS::ViaFillDisplay(), and PCB_EDITOR_CONDITIONS::ZoneDisplayMode().

---

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

• editor_conditions.h
• editor_conditions.cpp