Group generic conditions for PCB editor states. More...

#include <pcb_editor_conditions.h>

Inheritance diagram for PCB_EDITOR_CONDITIONS:

Public Member Functions
	PCB_EDITOR_CONDITIONS (PCB_BASE_FRAME *aFrame)

SELECTION_CONDITION	HasItems ()
	Create a functor that tests if there are items in the board. More...

SELECTION_CONDITION	PadNumbersDisplay ()
	Create a functor that tests if the pad numbers are displayed. More...

SELECTION_CONDITION	PadFillDisplay ()
	Create a functor that tests if the frame fills the pads. More...

SELECTION_CONDITION	TextFillDisplay ()
	Create a functor that tests if the frame fills text items. More...

SELECTION_CONDITION	GraphicsFillDisplay ()
	Create a functor that tests if the frame fills graphics items. More...

SELECTION_CONDITION	ViaFillDisplay ()
	Create a functor that tests if the frame fills vias. More...

SELECTION_CONDITION	TrackFillDisplay ()
	Create a functor that tests if the frame fills tracks. More...

SELECTION_CONDITION	ZoneDisplayMode (ZONE_DISPLAY_MODE aMode)
	Create a functor that tests the current zone display mode in the frame. More...

SELECTION_CONDITION	Get45degMode ()
	Create a functor that tests whether only 45 degree lines should be allowed. More...

SELECTION_CONDITION	ContentModified ()
	Create a functor that tests if the content of the frame is modified. More...

SELECTION_CONDITION	UndoAvailable ()
	Create a functor that tests if there are any items in the undo queue. More...

SELECTION_CONDITION	RedoAvailable ()
	Create a functor that tests if there are any items in the redo queue. More...

SELECTION_CONDITION	Units (EDA_UNITS aUnit)
	Create a functor that tests if the frame has the specified units. More...

SELECTION_CONDITION	CurrentTool (const TOOL_ACTION &aTool)
	Create a functor testing if the specified tool is the current active tool in the frame. More...

SELECTION_CONDITION	NoActiveTool ()
	Create a functor testing if there are no tools active in the frame. More...

SELECTION_CONDITION	GridVisible ()
	Create a functor testing if the grid is visible in a frame. More...

SELECTION_CONDITION	PolarCoordinates ()
	Create a functor testing if polar coordinates are current being used. More...

SELECTION_CONDITION	FullscreenCursor ()
	Create a functor testing if the cursor is full screen in a frame. More...

SELECTION_CONDITION	ScriptingConsoleVisible ()
	Create a functor testing if the python scripting console window is visible. More...

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 Protected Member Functions
static bool	hasItemsFunc (const SELECTION &aSelection, PCB_BASE_FRAME *aFrame)
	< Helper function used by HasItems() More...

static bool	padNumberDisplayFunc (const SELECTION &aSelection, PCB_BASE_FRAME *aFrame)
	Helper function used by PadFillDisplay() More...

static bool	padFillDisplayFunc (const SELECTION &aSelection, PCB_BASE_FRAME *aFrame)
	Helper function used by TextFillDisplay() More...

static bool	textFillDisplayFunc (const SELECTION &aSelection, PCB_BASE_FRAME *aFrame)
	Helper function used by GraphicsFillDisplay() More...

static bool	graphicsFillDisplayFunc (const SELECTION &aSelection, PCB_BASE_FRAME *aFrame)
	Helper function used by ViaFillDisplay() More...

static bool	viaFillDisplayFunc (const SELECTION &aSelection, PCB_BASE_FRAME *aFrame)
	Helper function used by TrackFillDisplay() More...

static bool	trackFillDisplayFunc (const SELECTION &aSelection, PCB_BASE_FRAME *aFrame)
	Helper function used by ZoneDisplayMode() More...

static bool	zoneDisplayModeFunc (const SELECTION &aSelection, PCB_BASE_FRAME *aFrame, ZONE_DISPLAY_MODE aMode)
	Helper function used by Line45degMode() More...

static bool	get45degModeFunc (const SELECTION &aSelection, PCB_BASE_FRAME *aFrame)

static bool	contentModifiedFunc (const SELECTION &aSelection, EDA_BASE_FRAME *aFrame)
	< Helper function used by ContentModified(). More...

static bool	undoFunc (const SELECTION &aSelection, EDA_BASE_FRAME *aFrame)
	Helper function used by RedoAvailable(). More...

static bool	redoFunc (const SELECTION &aSelection, EDA_BASE_FRAME *aFrame)
	Helper function used by Units(). More...

static bool	unitsFunc (const SELECTION &aSelection, EDA_BASE_FRAME *aFrame, EDA_UNITS aUnits)
	Helper function used by CurrentTool(). More...

static bool	toolFunc (const SELECTION &aSelection, EDA_BASE_FRAME *aFrame, const TOOL_ACTION &aTool)
	Helper function used by NoActiveTool(). More...

static bool	noToolFunc (const SELECTION &aSelection, EDA_BASE_FRAME *aFrame)
	Helper function used by GridVisible(). More...

static bool	gridFunc (const SELECTION &aSelection, EDA_DRAW_FRAME *aFrame)
	Helper function used by PolarCoordinates(). More...

static bool	polarCoordFunc (const SELECTION &aSelection, EDA_DRAW_FRAME *aFrame)
	Helper function used by FullscreenCursor(). More...

static bool	cursorFunc (const SELECTION &aSelection, EDA_DRAW_FRAME *aFrame)
	Helper function used by ScriptingConsoleVisible(). More...

static bool	consoleVisibleFunc (const SELECTION &aSelection, EDA_DRAW_FRAME *aFrame)
	The frame to apply the conditions to. More...

Protected Attributes
EDA_BASE_FRAME *	m_frame

Detailed Description

Group generic conditions for PCB editor states.

Definition at line 41 of file pcb_editor_conditions.h.

Constructor & Destructor Documentation

◆ PCB_EDITOR_CONDITIONS()

PCB_EDITOR_CONDITIONS::PCB_EDITOR_CONDITIONS ( PCB_BASE_FRAME * aFrame )

inline

Definition at line 44 of file pcb_editor_conditions.h.

  :
  EDITOR_CONDITIONS( aFrame )
  {}

Member Function Documentation

◆ consoleVisibleFunc()

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

staticprotectedinherited

The frame to apply the conditions to.

Definition at line 173 of file editor_conditions.cpp.

 {
  return aFrame->IsScriptingConsoleVisible();
 }

References EDA_DRAW_FRAME::IsScriptingConsoleVisible().

Referenced by EDITOR_CONDITIONS::ScriptingConsoleVisible().

◆ ContentModified()

SELECTION_CONDITION EDITOR_CONDITIONS::ContentModified ( )

inherited

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

Returns: Functor testing for modified content.

Definition at line 38 of file editor_conditions.cpp.

 {
  return std::bind( &EDITOR_CONDITIONS::contentModifiedFunc, _1, m_frame );
 }

References EDITOR_CONDITIONS::contentModifiedFunc().

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

◆ contentModifiedFunc()

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

staticprotectedinherited

< Helper function used by ContentModified().

Helper function used by UndoAvailable().

Definition at line 117 of file editor_conditions.cpp.

 {
  return aFrame->IsContentModified();
 }

References EDA_BASE_FRAME::IsContentModified().

Referenced by EDITOR_CONDITIONS::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 77 of file selection_conditions.cpp.

 {
  return std::bind( &SELECTION_CONDITIONS::countFunc, _1, aNumber );
 }

References SELECTION_CONDITIONS::countFunc().

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

◆ CurrentTool()

SELECTION_CONDITION EDITOR_CONDITIONS::CurrentTool ( const TOOL_ACTION & aTool )

inherited

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 62 of file editor_conditions.cpp.

 {
  return std::bind( &EDITOR_CONDITIONS::toolFunc, _1, m_frame, std::cref( aTool ) );
 }

References EDITOR_CONDITIONS::toolFunc().

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

◆ cursorFunc()

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

staticprotectedinherited

Helper function used by ScriptingConsoleVisible().

Definition at line 167 of file editor_conditions.cpp.

 {
  return aFrame->GetGalDisplayOptions().m_fullscreenCursor;
 }

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

Referenced by EDITOR_CONDITIONS::FullscreenCursor().

◆ Empty()

bool SELECTION_CONDITIONS::Empty ( const SELECTION & aSelection )

staticinherited

Test if there are no items selected.

Parameters

aSelection is the selection to be tested.

Returns: True if there are no items selected.

Definition at line 41 of file selection_conditions.cpp.

 {
  return aSelection.Empty();
 }

References SELECTION::Empty().

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

◆ FullscreenCursor()

SELECTION_CONDITION EDITOR_CONDITIONS::FullscreenCursor ( )

inherited

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 96 of file editor_conditions.cpp.

 {
  // The fullscreen cursor requires a draw frame
  EDA_DRAW_FRAME* drwFrame = dynamic_cast<EDA_DRAW_FRAME*>( m_frame );
 
  wxASSERT( drwFrame );
 
  return std::bind( &EDITOR_CONDITIONS::cursorFunc, _1, drwFrame );
 }

References EDITOR_CONDITIONS::cursorFunc().

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

◆ Get45degMode()

SELECTION_CONDITION PCB_EDITOR_CONDITIONS::Get45degMode ( )

Create a functor that tests whether only 45 degree lines should be allowed.

Returns: Functor returning true if only 45 degree lines should be allowed

Definition at line 126 of file pcb_editor_conditions.cpp.

 {
  PCB_BASE_FRAME* drwFrame = dynamic_cast<PCB_BASE_FRAME*>( m_frame );
 
  wxASSERT( drwFrame );
 
  return std::bind( &PCB_EDITOR_CONDITIONS::get45degModeFunc, _1, drwFrame );
 }

References get45degModeFunc(), and APPEARANCE_CONTROLS::m_frame.

Referenced by PCB_EDIT_FRAME::setupUIConditions().

◆ get45degModeFunc()

bool PCB_EDITOR_CONDITIONS::get45degModeFunc	(	const SELECTION &	aSelection,
		PCB_BASE_FRAME *	aFrame
	)

staticprotected

Definition at line 186 of file pcb_editor_conditions.cpp.

 {
  if( aFrame->IsType( FRAME_PCB_EDITOR ) )
  return aFrame->Settings().m_PcbUse45DegreeLimit;
  else
  return aFrame->Settings().m_FpeditUse45DegreeLimit;
 }

References FRAME_PCB_EDITOR, EDA_BASE_FRAME::IsType(), PCBNEW_SETTINGS::m_FpeditUse45DegreeLimit, PCBNEW_SETTINGS::m_PcbUse45DegreeLimit, and PCB_BASE_FRAME::Settings().

Referenced by Get45degMode().

◆ GraphicsFillDisplay()

SELECTION_CONDITION PCB_EDITOR_CONDITIONS::GraphicsFillDisplay ( )

Create a functor that tests if the frame fills graphics items.

Returns: Functor returning true if graphics items are filled

Definition at line 82 of file pcb_editor_conditions.cpp.

 {
  // Requires a PCB_BASE_FRAME
  PCB_BASE_FRAME* drwFrame = dynamic_cast<PCB_BASE_FRAME*>( m_frame );
 
  wxASSERT( drwFrame );
 
  return std::bind( &PCB_EDITOR_CONDITIONS::graphicsFillDisplayFunc, _1, drwFrame );
 }

References graphicsFillDisplayFunc(), and APPEARANCE_CONTROLS::m_frame.

Referenced by FOOTPRINT_VIEWER_FRAME::setupUIConditions(), DISPLAY_FOOTPRINTS_FRAME::setupUIConditions(), and FOOTPRINT_EDIT_FRAME::setupUIConditions().

◆ graphicsFillDisplayFunc()

bool PCB_EDITOR_CONDITIONS::graphicsFillDisplayFunc	(	const SELECTION &	aSelection,
		PCB_BASE_FRAME *	aFrame
	)

staticprotected

Helper function used by ViaFillDisplay()

Definition at line 162 of file pcb_editor_conditions.cpp.

 {
  return aFrame->GetDisplayOptions().m_DisplayGraphicsFill;
 }

References PCB_BASE_FRAME::GetDisplayOptions(), and PCB_DISPLAY_OPTIONS::m_DisplayGraphicsFill.

Referenced by GraphicsFillDisplay().

◆ gridFunc()

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

staticprotectedinherited

Helper function used by PolarCoordinates().

Definition at line 155 of file editor_conditions.cpp.

 {
  return aFrame->IsGridVisible();
 }

References EDA_DRAW_FRAME::IsGridVisible().

Referenced by EDITOR_CONDITIONS::GridVisible().

◆ GridVisible()

SELECTION_CONDITION EDITOR_CONDITIONS::GridVisible ( )

inherited

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 74 of file editor_conditions.cpp.

 {
  // The grid visibility check requires a draw frame
  EDA_DRAW_FRAME* drwFrame = dynamic_cast<EDA_DRAW_FRAME*>( m_frame );
 
  wxASSERT( drwFrame );
 
  return std::bind( &EDITOR_CONDITIONS::gridFunc, _1, drwFrame );
 }

References EDITOR_CONDITIONS::gridFunc().

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

◆ HasItems()

SELECTION_CONDITION PCB_EDITOR_CONDITIONS::HasItems ( )

Create a functor that tests if there are items in the board.

Returns: Functor returning true if the current board has items

Definition at line 38 of file pcb_editor_conditions.cpp.

 {
  // Requires a PCB_BASE_FRAME
  PCB_BASE_FRAME* drwFrame = dynamic_cast<PCB_BASE_FRAME*>( m_frame );
 
  wxASSERT( drwFrame );
 
  return std::bind( &PCB_EDITOR_CONDITIONS::hasItemsFunc, _1, drwFrame );
 }

References hasItemsFunc(), and APPEARANCE_CONTROLS::m_frame.

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

◆ hasItemsFunc()

bool PCB_EDITOR_CONDITIONS::hasItemsFunc	(	const SELECTION &	aSelection,
		PCB_BASE_FRAME *	aFrame
	)

staticprotected

< Helper function used by HasItems()

Helper function used by PadNumbersDisplay()

Definition at line 136 of file pcb_editor_conditions.cpp.

 {
  BOARD* board = aFrame->GetBoard();
 
  return board && !board->IsEmpty();
 }

References PCB_BASE_FRAME::GetBoard(), and BOARD::IsEmpty().

Referenced by HasItems().

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

 {
  return std::bind( &SELECTION_CONDITIONS::hasTypeFunc, _1, aType );
 }

References SELECTION_CONDITIONS::hasTypeFunc().

Referenced by PAD_TOOL::Init().

◆ Idle()

bool SELECTION_CONDITIONS::Idle ( const SELECTION & aSelection )

staticinherited

Test if there no items selected or being edited.

Parameters

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

 {
  return ( !aSelection.Front() || aSelection.Front()->GetEditFlags() == 0 );
 }

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().

◆ IdleSelection()

bool SELECTION_CONDITIONS::IdleSelection ( const SELECTION & aSelection )

staticinherited

Test if all selected items are not being edited.

Parameters

aSelection is the selection to be tested.

Returns: True if no selected items are being edited.

Definition at line 53 of file selection_conditions.cpp.

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

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

Referenced by SYMBOL_EDITOR_EDIT_TOOL::Init(), SYMBOL_EDITOR_MOVE_TOOL::Init(), and SCH_EDIT_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 89 of file selection_conditions.cpp.

 {
  return std::bind( &SELECTION_CONDITIONS::lessThanFunc, _1, aNumber );
 }

References SELECTION_CONDITIONS::lessThanFunc().

Referenced by EE_SELECTION_TOOL::Init().

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

 {
  return std::bind( &SELECTION_CONDITIONS::moreThanFunc, _1, aNumber );
 }

References SELECTION_CONDITIONS::moreThanFunc().

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

◆ NoActiveTool()

SELECTION_CONDITION EDITOR_CONDITIONS::NoActiveTool ( )

inherited

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 68 of file editor_conditions.cpp.

 {
  return std::bind( &EDITOR_CONDITIONS::noToolFunc, _1, m_frame );
 }

References EDITOR_CONDITIONS::noToolFunc().

Referenced by 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.

Parameters

aSelection is the selection to be tested.

Returns: True if there is at least one item selected.

Definition at line 35 of file selection_conditions.cpp.

 {
  return !aSelection.Empty();
 }

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().

◆ noToolFunc()

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

staticprotectedinherited

Helper function used by GridVisible().

Definition at line 149 of file editor_conditions.cpp.

 {
  return aFrame->ToolStackIsEmpty();
 }

References TOOLS_HOLDER::ToolStackIsEmpty().

Referenced by EDITOR_CONDITIONS::NoActiveTool().

◆ 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

aType is the type that is searched.

Returns: Functor testing if selected items are exclusively of one type.

Definition at line 65 of file selection_conditions.cpp.

 {
  return std::bind( &SELECTION_CONDITIONS::onlyTypeFunc, _1, aType );
 }

References SELECTION_CONDITIONS::onlyTypeFunc().

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

◆ 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

aTypes is 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 71 of file selection_conditions.cpp.

 {
  return std::bind( &SELECTION_CONDITIONS::onlyTypesFunc, _1, aTypes );
 }

References SELECTION_CONDITIONS::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().

◆ PadFillDisplay()

SELECTION_CONDITION PCB_EDITOR_CONDITIONS::PadFillDisplay ( )

Create a functor that tests if the frame fills the pads.

Returns: Functor returning true if the pads are filled

Definition at line 60 of file pcb_editor_conditions.cpp.

 {
  // Requires a PCB_BASE_FRAME
  PCB_BASE_FRAME* drwFrame = dynamic_cast<PCB_BASE_FRAME*>( m_frame );
 
  wxASSERT( drwFrame );
 
  return std::bind( &PCB_EDITOR_CONDITIONS::padFillDisplayFunc, _1, drwFrame );
 }

References APPEARANCE_CONTROLS::m_frame, and padFillDisplayFunc().

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

◆ padFillDisplayFunc()

bool PCB_EDITOR_CONDITIONS::padFillDisplayFunc	(	const SELECTION &	aSelection,
		PCB_BASE_FRAME *	aFrame
	)

staticprotected

Helper function used by TextFillDisplay()

Definition at line 150 of file pcb_editor_conditions.cpp.

 {
  return aFrame->GetDisplayOptions().m_DisplayPadFill;
 }

References PCB_BASE_FRAME::GetDisplayOptions(), and PCB_DISPLAY_OPTIONS::m_DisplayPadFill.

Referenced by PadFillDisplay().

◆ padNumberDisplayFunc()

bool PCB_EDITOR_CONDITIONS::padNumberDisplayFunc	(	const SELECTION &	aSelection,
		PCB_BASE_FRAME *	aFrame
	)

staticprotected

Helper function used by PadFillDisplay()

Definition at line 144 of file pcb_editor_conditions.cpp.

 {
  return aFrame->GetDisplayOptions().m_DisplayPadNum;
 }

References PCB_BASE_FRAME::GetDisplayOptions(), and PCB_DISPLAY_OPTIONS::m_DisplayPadNum.

Referenced by PadNumbersDisplay().

◆ PadNumbersDisplay()

SELECTION_CONDITION PCB_EDITOR_CONDITIONS::PadNumbersDisplay ( )

Create a functor that tests if the pad numbers are displayed.

Returns: Functor returning true if the pad numbers are displayed

Definition at line 49 of file pcb_editor_conditions.cpp.

 {
  // Requires a PCB_BASE_FRAME
  PCB_BASE_FRAME* drwFrame = dynamic_cast<PCB_BASE_FRAME*>( m_frame );
 
  wxASSERT( drwFrame );
 
  return std::bind( &PCB_EDITOR_CONDITIONS::padNumberDisplayFunc, _1, drwFrame );
 }

References APPEARANCE_CONTROLS::m_frame, and padNumberDisplayFunc().

Referenced by FOOTPRINT_VIEWER_FRAME::setupUIConditions(), and DISPLAY_FOOTPRINTS_FRAME::setupUIConditions().

◆ polarCoordFunc()

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

staticprotectedinherited

Helper function used by FullscreenCursor().

Definition at line 161 of file editor_conditions.cpp.

 {
  return aFrame->GetShowPolarCoords();
 }

References EDA_DRAW_FRAME::GetShowPolarCoords().

Referenced by EDITOR_CONDITIONS::PolarCoordinates().

◆ PolarCoordinates()

SELECTION_CONDITION EDITOR_CONDITIONS::PolarCoordinates ( )

inherited

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 85 of file editor_conditions.cpp.

 {
  // The polar coordinates require a draw frame
  EDA_DRAW_FRAME* drwFrame = dynamic_cast<EDA_DRAW_FRAME*>( m_frame );
 
  wxASSERT( drwFrame );
 
  return std::bind( &EDITOR_CONDITIONS::polarCoordFunc, _1, drwFrame );
 }

References EDITOR_CONDITIONS::polarCoordFunc().

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

◆ RedoAvailable()

SELECTION_CONDITION EDITOR_CONDITIONS::RedoAvailable ( )

inherited

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 50 of file editor_conditions.cpp.

 {
  return std::bind( &EDITOR_CONDITIONS::redoFunc, _1, m_frame );
 }

References EDITOR_CONDITIONS::redoFunc().

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

◆ redoFunc()

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

staticprotectedinherited

Helper function used by Units().

Definition at line 129 of file editor_conditions.cpp.

 {
  return aFrame->GetRedoCommandCount() > 0;
 }

References EDA_BASE_FRAME::GetRedoCommandCount().

Referenced by EDITOR_CONDITIONS::RedoAvailable().

◆ ScriptingConsoleVisible()

SELECTION_CONDITION EDITOR_CONDITIONS::ScriptingConsoleVisible ( )

inherited

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 107 of file editor_conditions.cpp.

 {
  EDA_DRAW_FRAME* drwFrame = dynamic_cast<EDA_DRAW_FRAME*>( m_frame );
 
  wxASSERT( drwFrame );
 
  return std::bind( &EDITOR_CONDITIONS::consoleVisibleFunc, _1, drwFrame );
 }

References EDITOR_CONDITIONS::consoleVisibleFunc().

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

Parameters

aSelection is the selection to be tested.

Returns: Always true.

Definition at line 77 of file selection_conditions.h.

  {
  return true;
  }

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().

◆ ShowNever()

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

inlinestaticinherited

Always returns false.

Parameters

aSelection is the selection to be tested.

Returns: Always false.

Definition at line 88 of file selection_conditions.h.

  {
  return false;
  }

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

◆ TextFillDisplay()

SELECTION_CONDITION PCB_EDITOR_CONDITIONS::TextFillDisplay ( )

Create a functor that tests if the frame fills text items.

Returns: Functor returning true if the text items are filled

Definition at line 71 of file pcb_editor_conditions.cpp.

 {
  // Requires a PCB_BASE_FRAME
  PCB_BASE_FRAME* drwFrame = dynamic_cast<PCB_BASE_FRAME*>( m_frame );
 
  wxASSERT( drwFrame );
 
  return std::bind( &PCB_EDITOR_CONDITIONS::textFillDisplayFunc, _1, drwFrame );
 }

References APPEARANCE_CONTROLS::m_frame, and textFillDisplayFunc().

Referenced by FOOTPRINT_VIEWER_FRAME::setupUIConditions(), DISPLAY_FOOTPRINTS_FRAME::setupUIConditions(), and FOOTPRINT_EDIT_FRAME::setupUIConditions().

◆ textFillDisplayFunc()

bool PCB_EDITOR_CONDITIONS::textFillDisplayFunc	(	const SELECTION &	aSelection,
		PCB_BASE_FRAME *	aFrame
	)

staticprotected

Helper function used by GraphicsFillDisplay()

Definition at line 156 of file pcb_editor_conditions.cpp.

 {
  return aFrame->GetDisplayOptions().m_DisplayTextFill;
 }

References PCB_BASE_FRAME::GetDisplayOptions(), and PCB_DISPLAY_OPTIONS::m_DisplayTextFill.

Referenced by TextFillDisplay().

◆ toolFunc()

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

staticprotectedinherited

Helper function used by NoActiveTool().

Definition at line 142 of file editor_conditions.cpp.

 {
  return aFrame->IsCurrentTool( aTool );
 }

References TOOLS_HOLDER::IsCurrentTool().

Referenced by EDITOR_CONDITIONS::CurrentTool().

◆ TrackFillDisplay()

SELECTION_CONDITION PCB_EDITOR_CONDITIONS::TrackFillDisplay ( )

Create a functor that tests if the frame fills tracks.

Returns: Functor returning true if tracks are filled

Definition at line 104 of file pcb_editor_conditions.cpp.

 {
  // Requires a PCB_BASE_FRAME
  PCB_BASE_FRAME* drwFrame = dynamic_cast<PCB_BASE_FRAME*>( m_frame );
 
  wxASSERT( drwFrame );
 
  return std::bind( &PCB_EDITOR_CONDITIONS::trackFillDisplayFunc, _1, drwFrame );
 }

References APPEARANCE_CONTROLS::m_frame, and trackFillDisplayFunc().

Referenced by PCB_EDIT_FRAME::setupUIConditions().

◆ trackFillDisplayFunc()

bool PCB_EDITOR_CONDITIONS::trackFillDisplayFunc	(	const SELECTION &	aSelection,
		PCB_BASE_FRAME *	aFrame
	)

staticprotected

Helper function used by ZoneDisplayMode()

Definition at line 174 of file pcb_editor_conditions.cpp.

 {
  return aFrame->GetDisplayOptions().m_DisplayPcbTrackFill;
 }

References PCB_BASE_FRAME::GetDisplayOptions(), and PCB_DISPLAY_OPTIONS::m_DisplayPcbTrackFill.

Referenced by TrackFillDisplay().

◆ UndoAvailable()

SELECTION_CONDITION EDITOR_CONDITIONS::UndoAvailable ( )

inherited

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 44 of file editor_conditions.cpp.

 {
  return std::bind( &EDITOR_CONDITIONS::undoFunc, _1, m_frame );
 }

References EDITOR_CONDITIONS::undoFunc().

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

◆ undoFunc()

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

staticprotectedinherited

Helper function used by RedoAvailable().

Definition at line 123 of file editor_conditions.cpp.

 {
  return aFrame->GetUndoCommandCount() > 0;
 }

References EDA_BASE_FRAME::GetUndoCommandCount().

Referenced by EDITOR_CONDITIONS::UndoAvailable().

◆ Units()

SELECTION_CONDITION EDITOR_CONDITIONS::Units ( EDA_UNITS aUnit )

inherited

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

Returns: Functor testing the units of a frame.

Definition at line 56 of file editor_conditions.cpp.

 {
  return std::bind( &EDITOR_CONDITIONS::unitsFunc, _1, m_frame, aUnit );
 }

References EDITOR_CONDITIONS::unitsFunc().

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

◆ unitsFunc()

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

staticprotectedinherited

Helper function used by CurrentTool().

Definition at line 135 of file editor_conditions.cpp.

 {
  return aFrame->GetUserUnits() == aUnits;
 }

References EDA_BASE_FRAME::GetUserUnits().

Referenced by EDITOR_CONDITIONS::Units().

◆ ViaFillDisplay()

SELECTION_CONDITION PCB_EDITOR_CONDITIONS::ViaFillDisplay ( )

Create a functor that tests if the frame fills vias.

Returns: Functor returning true if vias are filled

Definition at line 93 of file pcb_editor_conditions.cpp.

 {
  // Requires a PCB_BASE_FRAME
  PCB_BASE_FRAME* drwFrame = dynamic_cast<PCB_BASE_FRAME*>( m_frame );
 
  wxASSERT( drwFrame );
 
  return std::bind( &PCB_EDITOR_CONDITIONS::viaFillDisplayFunc, _1, drwFrame );
 }

References APPEARANCE_CONTROLS::m_frame, and viaFillDisplayFunc().

Referenced by PCB_EDIT_FRAME::setupUIConditions().

◆ viaFillDisplayFunc()

bool PCB_EDITOR_CONDITIONS::viaFillDisplayFunc	(	const SELECTION &	aSelection,
		PCB_BASE_FRAME *	aFrame
	)

staticprotected

Helper function used by TrackFillDisplay()

Definition at line 168 of file pcb_editor_conditions.cpp.

 {
  return aFrame->GetDisplayOptions().m_DisplayViaFill;
 }

References PCB_BASE_FRAME::GetDisplayOptions(), and PCB_DISPLAY_OPTIONS::m_DisplayViaFill.

Referenced by ViaFillDisplay().

◆ ZoneDisplayMode()

SELECTION_CONDITION PCB_EDITOR_CONDITIONS::ZoneDisplayMode ( ZONE_DISPLAY_MODE aMode )

Create a functor that tests the current zone display mode in the frame.

Parameters

aMode is the mode to test for

Returns: Functor returning true if the frame is using the specified mode

Definition at line 115 of file pcb_editor_conditions.cpp.

 {
  // Requires a PCB_BASE_FRAME
  PCB_BASE_FRAME* drwFrame = dynamic_cast<PCB_BASE_FRAME*>( m_frame );
 
  wxASSERT( drwFrame );
 
  return std::bind( &PCB_EDITOR_CONDITIONS::zoneDisplayModeFunc, _1, drwFrame, aMode );
 }

References APPEARANCE_CONTROLS::m_frame, and zoneDisplayModeFunc().

Referenced by PCB_EDIT_FRAME::setupUIConditions().

◆ zoneDisplayModeFunc()

bool PCB_EDITOR_CONDITIONS::zoneDisplayModeFunc	(	const SELECTION &	aSelection,
		PCB_BASE_FRAME *	aFrame,
		ZONE_DISPLAY_MODE	aMode
	)

staticprotected

Helper function used by Line45degMode()

Definition at line 180 of file pcb_editor_conditions.cpp.

 {
  return aFrame->GetDisplayOptions().m_ZoneDisplayMode == aMode;
 }

References PCB_BASE_FRAME::GetDisplayOptions(), and PCB_DISPLAY_OPTIONS::m_ZoneDisplayMode.

Referenced by ZoneDisplayMode().

Member Data Documentation

◆ m_frame

EDA_BASE_FRAME* EDITOR_CONDITIONS::m_frame

protectedinherited

Definition at line 163 of file editor_conditions.h.

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

Public Member Functions

Static Public Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PCB_EDITOR_CONDITIONS()

Member Function Documentation

◆ consoleVisibleFunc()

◆ ContentModified()

◆ contentModifiedFunc()

◆ Count()

◆ CurrentTool()

◆ cursorFunc()

◆ Empty()

◆ FullscreenCursor()

◆ Get45degMode()

◆ get45degModeFunc()

◆ GraphicsFillDisplay()

◆ graphicsFillDisplayFunc()

◆ gridFunc()

◆ GridVisible()

◆ HasItems()

◆ hasItemsFunc()

◆ HasType()

◆ Idle()

◆ IdleSelection()

◆ LessThan()

◆ MoreThan()

◆ NoActiveTool()

◆ NotEmpty()

◆ noToolFunc()

◆ OnlyType()

◆ OnlyTypes()

◆ PadFillDisplay()

◆ padFillDisplayFunc()

◆ padNumberDisplayFunc()

◆ PadNumbersDisplay()

◆ polarCoordFunc()

◆ PolarCoordinates()

◆ RedoAvailable()

◆ redoFunc()

◆ ScriptingConsoleVisible()

◆ ShowAlways()

◆ ShowNever()

◆ TextFillDisplay()

◆ textFillDisplayFunc()

◆ toolFunc()

◆ TrackFillDisplay()

◆ trackFillDisplayFunc()

◆ UndoAvailable()

◆ undoFunc()

◆ Units()

◆ unitsFunc()

◆ ViaFillDisplay()

◆ viaFillDisplayFunc()

◆ ZoneDisplayMode()

◆ zoneDisplayModeFunc()

Member Data Documentation

◆ m_frame