SCH_EDIT_TOOL Class Reference

#include <sch_edit_tool.h>

Inheritance diagram for SCH_EDIT_TOOL:

Public Types
enum	RESET_REASON {   RUN , MODEL_RELOAD , SUPERMODEL_RELOAD , GAL_SWITCH ,   REDRAW , SHUTDOWN }
	Determine the reason of reset for a tool. More...

Public Member Functions
	SCH_EDIT_TOOL ()
	~SCH_EDIT_TOOL () override
bool	Init () override
	Init() is called once upon a registration of the tool.
int	Rotate (const TOOL_EVENT &aEvent)
int	Mirror (const TOOL_EVENT &aEvent)
int	Swap (const TOOL_EVENT &aEvent)
int	RepeatDrawItem (const TOOL_EVENT &aEvent)
int	Properties (const TOOL_EVENT &aEvent)
int	EditField (const TOOL_EVENT &aEvent)
int	AutoplaceFields (const TOOL_EVENT &aEvent)
int	ChangeSymbols (const TOOL_EVENT &aEvent)
int	ChangeBodyStyle (const TOOL_EVENT &aEvent)
int	EditPageNumber (const TOOL_EVENT &aEvent)
int	Increment (const TOOL_EVENT &aEvent)
	Increment/decrement something about an item.
int	ChangeTextType (const TOOL_EVENT &aEvent)
	Change a text type to another one.
int	JustifyText (const TOOL_EVENT &aEvent)
int	BreakWire (const TOOL_EVENT &aEvent)
int	CleanupSheetPins (const TOOL_EVENT &aEvent)
int	GlobalEdit (const TOOL_EVENT &aEvent)
	Delete the selected items, or the item under the cursor.
int	DoDelete (const TOOL_EVENT &aEvent)
	Run the deletion tool.
int	InteractiveDelete (const TOOL_EVENT &aEvent)
int	DdAppendFile (const TOOL_EVENT &aEvent)
	Drag and drop.
int	SetAttribute (const TOOL_EVENT &aEvent)
	Modify Attributes (DNP, Exclude, etc.) All attributes are set to true unless all symbols already have the attribute set to true.
void	Reset (RESET_REASON aReason) override
	Bring the tool to a known, initial state.
bool	IsSymbolEditor () const
	Returns true if the tool is running in the symbol editor.
void	Activate ()
	Run the tool.
TOOL_MENU &	GetToolMenu ()
void	SetContextMenu (ACTION_MENU *aMenu, CONTEXT_MENU_TRIGGER aTrigger=CMENU_BUTTON)
	Assign a context menu and tells when it should be activated.
void	RunMainStack (std::function< void()> aFunc)
	Call a function using the main stack.
template<class T >
void	Go (int(T::*aStateFunc)(const TOOL_EVENT &), const TOOL_EVENT_LIST &aConditions=TOOL_EVENT(TC_ANY, TA_ANY))
	Define which state (aStateFunc) to go when a certain event arrives (aConditions).
TOOL_EVENT *	Wait (const TOOL_EVENT_LIST &aEventList=TOOL_EVENT(TC_ANY, TA_ANY))
	Suspend execution of the tool until an event specified in aEventList arrives.
TOOL_TYPE	GetType () const
	Return the type of the tool.
TOOL_ID	GetId () const
	Return the unique identifier of the tool.
const std::string &	GetName () const
	Return the name of the tool.
TOOL_MANAGER *	GetManager () const
	Return the instance of TOOL_MANAGER that takes care of the tool.
bool	IsToolActive () const

Static Public Attributes
static const std::vector< KICAD_T >	RotatableItems

Protected Member Functions
void	updateItem (EDA_ITEM *aItem, bool aUpdateRTree) const
	Similar to getView()->Update(), but handles items that are redrawn by their parents and updating the SCH_SCREEN's RTree.
void	saveCopyInUndoList (EDA_ITEM *aItem, UNDO_REDO aType, bool aAppend=false, bool aDirtyConnectivity=true)
void	attachManager (TOOL_MANAGER *aManager)
	Set the TOOL_MANAGER the tool will belong to.
KIGFX::VIEW *	getView () const
	Returns the instance of #VIEW object used in the application.
KIGFX::VIEW_CONTROLS *	getViewControls () const
	Return the instance of VIEW_CONTROLS object used in the application.
template<typename T >
T *	getEditFrame () const
	Return the application window object, casted to requested user type.
template<typename T >
T *	getModel () const
	Return the model object if it matches the requested type.

Protected Attributes
SCH_EDIT_FRAME *	m_frame
KIGFX::SCH_VIEW *	m_view
SCH_SELECTION_TOOL *	m_selectionTool
bool	m_isSymbolEditor
std::unique_ptr< TOOL_MENU >	m_menu
	The functions below are not yet implemented - their interface may change.
TOOL_TYPE	m_type
TOOL_ID	m_toolId
	Unique id, assigned by a TOOL_MANAGER instance.
std::string	m_toolName
	Names are expected to obey the format application.ToolName (eg.
TOOL_MANAGER *	m_toolMgr

Private Member Functions
void	editFieldText (SCH_FIELD *aField)
void	collectUnits (const SCH_SELECTION &aSelection, std::set< std::pair< SCH_SYMBOL *, SCH_SCREEN * > > &aCollectedUnits)
	Set up handlers for various events.
void	setTransitions () override
	This method is meant to be overridden in order to specify handlers for events.
void	resetTransitions ()
	Clear the current transition map and restores the default one created by setTransitions().
void	goInternal (TOOL_STATE_FUNC &aState, const TOOL_EVENT_LIST &aConditions)
EDA_ITEM *	getModelInternal () const
TOOLS_HOLDER *	getToolHolderInternal () const

Private Attributes
EDA_ITEM *	m_pickerItem

Detailed Description

Definition at line 36 of file sch_edit_tool.h.

Member Enumeration Documentation

RESET_REASON

enum TOOL_BASE::RESET_REASON

inherited

Determine the reason of reset for a tool.

Enumerator
RUN	Tool is invoked after being inactive.
MODEL_RELOAD	Model changes (the sheet for a schematic)
SUPERMODEL_RELOAD	For schematics, the entire schematic changed, not just the sheet.
GAL_SWITCH	Rendering engine changes.
REDRAW	Full drawing refresh.
SHUTDOWN	Tool is being shut down.

Definition at line 77 of file tool_base.h.

Constructor & Destructor Documentation

SCH_EDIT_TOOL()

SCH_EDIT_TOOL::SCH_EDIT_TOOL

(

)

Definition at line 260 of file sch_edit_tool.cpp.

References m_pickerItem.

~SCH_EDIT_TOOL()

SCH_EDIT_TOOL::~SCH_EDIT_TOOL ( )

inlineoverride

Definition at line 40 of file sch_edit_tool.h.

Member Function Documentation

Activate()

void TOOL_INTERACTIVE::Activate ( )

inherited

Run the tool.

After activation, the tool starts receiving events until it is finished.

Definition at line 65 of file tool_interactive.cpp.

References TOOL_MANAGER::InvokeTool(), TOOL_BASE::m_toolId, and TOOL_BASE::m_toolMgr.

Referenced by AUTOPLACE_TOOL::autoplace(), EDIT_TOOL::copyToClipboard(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawBezier(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawLine(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::DrawRectangle(), SCH_DRAWING_TOOLS::DrawRuleArea(), SCH_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_DRAWING_TOOLS::DrawTable(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawZone(), BOARD_EDITOR_CONTROL::DrillOrigin(), PAD_TOOL::EditPad(), PAD_TOOL::EnumeratePads(), PCB_CONTROL::GridPlaceOrigin(), SCH_EDITOR_CONTROL::HighlightNetCursor(), SCH_DRAWING_TOOLS::ImportGraphics(), SYMBOL_EDITOR_DRAWING_TOOLS::ImportGraphics(), SCH_DRAWING_TOOLS::ImportSheet(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), InteractiveDelete(), SYMBOL_EDITOR_EDIT_TOOL::InteractiveDelete(), PL_EDIT_TOOL::InteractiveDelete(), PCB_CONTROL::InteractiveDelete(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), SCH_POINT_EDITOR::Main(), PICKER_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), PCB_PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), PCB_POINT_EDITOR::OnSelectionChange(), SCH_GROUP_TOOL::PickNewMember(), PCB_GROUP_TOOL::PickNewMember(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceReferenceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), POSITION_RELATIVE_TOOL::PositionRelativeInteractively(), EDIT_TOOL::Remove(), ROUTER_TOOL::RouteSelected(), PCB_PICKER_TOOL::SelectItemInteractively(), PCB_PICKER_TOOL::SelectPointInteractively(), DRAWING_TOOL::SetAnchor(), DRC_TOOL::ShowDRCDialog(), SCH_EDITOR_CONTROL::SimProbe(), SCH_EDITOR_CONTROL::SimTune(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

attachManager()

void TOOL_BASE::attachManager ( TOOL_MANAGER *  aManager )

protectedinherited

Set the TOOL_MANAGER the tool will belong to.

Called by TOOL_MANAGER::RegisterTool()

Definition at line 62 of file tool_base.cpp.

References TOOL_BASE::m_toolMgr.

Referenced by TOOL_MANAGER::RegisterTool().

AutoplaceFields()

int SCH_EDIT_TOOL::AutoplaceFields

(

const TOOL_EVENT &

aEvent

)

Definition at line 1971 of file sch_edit_tool.cpp.

References _, AUTOPLACE_MANUAL, COMMIT::Empty(), SELECTION::Empty(), SCH_COLLECTOR::FieldOwners, SELECTION::Front(), SELECTION::GetItem(), EDA_ITEM::GetParent(), SCH_EDIT_FRAME::GetScreen(), SELECTION::GetSize(), SELECTION::IsHover(), EDA_ITEM::IsMoving(), EDA_ITEM::IsType(), SCH_ITEM::IsType(), SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_selectionTool, TOOL_BASE::m_toolMgr, COMMIT::Modify(), TOOL_MANAGER::PostAction(), SCH_COMMIT::Push(), ACTIONS::refreshPreview, SCH_SELECTION_TOOL::RequestSelection(), RotatableItems, TOOL_MANAGER::RunAction(), ACTIONS::selectionClear, and SCH_TOOL_BASE< SCH_EDIT_FRAME >::updateItem().

Referenced by setTransitions().

BreakWire()

int SCH_EDIT_TOOL::BreakWire

(

const TOOL_EVENT &

aEvent

)

Definition at line 2939 of file sch_edit_tool.cpp.

References _, SELECTION_TOOL::AddItemToSel(), SCHEMATIC::BreakSegment(), SCH_ACTIONS::breakWire, EDA_ITEM::ClearFlags(), SCH_SELECTION_TOOL::ClearSelection(), TOOL_EVENT::DisableGridSnapping(), SCH_ACTIONS::drag, ENDPOINT, KIGFX::VIEW_CONTROLS::GetCursorPosition(), SCH_EDIT_FRAME::GetScreen(), TOOL_BASE::getViewControls(), SELECTION::IsHover(), SCH_ACTIONS::lineMode45, SCH_ACTIONS::lineMode90, SCH_ACTIONS::lineModeFree, SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_selectionTool, TOOL_BASE::m_toolMgr, TOOL_EVENT::Matches(), TOOL_MANAGER::PostAction(), SCH_COMMIT::Push(), SCH_SELECTION_TOOL::RequestSelection(), SCH_COMMIT::Revert(), TOOL_MANAGER::RunAction(), TOOL_MANAGER::RunSynchronousAction(), SCH_LINE_T, SCH_EDIT_FRAME::Schematic(), ACTIONS::selectionClear, EDA_ITEM::SetFlags(), SCH_ACTIONS::slice, STARTPOINT, and SCH_EDIT_FRAME::TestDanglingEnds().

Referenced by setTransitions().

ChangeBodyStyle()

int SCH_EDIT_TOOL::ChangeBodyStyle

(

const TOOL_EVENT &

aEvent

)

Definition at line 2048 of file sch_edit_tool.cpp.

References _, COMMIT::Empty(), SELECTION::Empty(), SCH_EDIT_FRAME::FlipBodyStyle(), SELECTION::Front(), SCH_ITEM::GetBodyStyle(), SCH_EDIT_FRAME::GetScreen(), TOOL_EVENT::IsAction(), SELECTION::IsHover(), EDA_ITEM::IsNew(), SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_selectionTool, TOOL_BASE::m_toolMgr, COMMIT::Modify(), TOOL_MANAGER::PostAction(), SCH_COMMIT::Push(), ACTIONS::refreshPreview, SCH_SELECTION_TOOL::RequestSelection(), TOOL_MANAGER::RunAction(), SCH_SYMBOL_T, ACTIONS::selectionClear, SCH_ACTIONS::showDeMorganAlternate, and SCH_ACTIONS::showDeMorganStandard.

Referenced by setTransitions().

ChangeSymbols()

int SCH_EDIT_TOOL::ChangeSymbols

(

const TOOL_EVENT &

aEvent

)

Definition at line 2020 of file sch_edit_tool.cpp.

References DIALOG_CHANGE_SYMBOLS::CHANGE, SCH_ACTIONS::changeSymbol, SCH_ACTIONS::changeSymbols, SELECTION::Empty(), SELECTION::Front(), TOOL_EVENT::IsAction(), SELECTION::IsHover(), SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_selectionTool, TOOL_BASE::m_toolMgr, SCH_SELECTION_TOOL::RequestSelection(), TOOL_MANAGER::RunAction(), SCH_SYMBOL_T, ACTIONS::selectionClear, DIALOG_SHIM::ShowQuasiModal(), and DIALOG_CHANGE_SYMBOLS::UPDATE.

Referenced by setTransitions().

ChangeTextType()

int SCH_EDIT_TOOL::ChangeTextType

(

const TOOL_EVENT &

aEvent

)

Change a text type to another one.

The new text, label, hierarchical label, or global label is created from the old text and the old text object is deleted.

A tricky case is when the 'old" text is being edited (i.e. moving) because we must create a new text, and prepare the undo/redo command data for this change and the current move/edit command

Definition at line 2466 of file sch_edit_tool.cpp.

References _, COMMIT::Added(), SCH_LABEL_BASE::AddFields(), SCH_BASE_FRAME::AddToScreen(), ANGLE_VERTICAL, AUTOPLACE_AUTO, SCH_ITEM::AutoplaceFields(), SPIN_STYLE::BOTTOM, BOX2< Vec >::Centre(), TOOL_EVENT::Commit(), CTX_NETNAME, COMMIT::Empty(), EscapeString(), BOX2< Vec >::GetBottom(), EDA_ITEM::GetBoundingBox(), SCH_SHAPE::GetBoundingBox(), SCH_ITEM::GetClass(), EDA_ITEM::GetEditFlags(), BOX2< Vec >::GetEnd(), SCH_LABEL_BASE::GetFields(), EDA_TEXT::GetFont(), EDA_TEXT::GetHorizJustify(), EDA_TEXT::GetHyperlink(), BOX2< Vec >::GetLeft(), SCH_TEXTBOX::GetLegacyTextMargin(), SCH_TEXTBOX::GetMarginBottom(), SCH_TEXTBOX::GetMarginLeft(), SCH_TEXTBOX::GetMarginRight(), SCH_TEXTBOX::GetMarginTop(), EDA_DRAW_FRAME::GetNearestGridPosition(), BOX2< Vec >::GetOrigin(), EDA_ITEM::GetPosition(), BOX2< Vec >::GetPosition(), BOX2< Vec >::GetRight(), SCH_EDIT_FRAME::GetScreen(), SCH_LABEL_BASE::GetShape(), SCH_LABEL_BASE::GetSpinStyle(), EDA_TEXT::GetText(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextSize(), EDA_TEXT::GetTextThickness(), BOX2< Vec >::GetTop(), GR_TEXT_H_ALIGN_RIGHT, BOX2< Vec >::Inflate(), EDA_TEXT::IsBold(), EDA_TEXT::IsItalic(), EDA_ITEM::IsNew(), EDA_ITEM::IsSelected(), EDA_ANGLE::IsVertical(), KiROUND(), LAYER_NOTES, SPIN_STYLE::LEFT, SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, SCHEMATIC_SETTINGS::m_LabelSizeRatio, SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_selectionTool, TOOL_BASE::m_toolMgr, SCH_LABEL_BASE::MirrorHorizontally(), SCH_LABEL_BASE::MirrorVertically(), TOOL_EVENT::Parameter(), NET_SETTINGS::ParseBusGroup(), SCH_COMMIT::Push(), COMMIT::Removed(), SCH_BASE_FRAME::RemoveFromScreen(), SCH_SELECTION_TOOL::RequestSelection(), SPIN_STYLE::RIGHT, TOOL_MANAGER::RunAction(), SCH_DIRECTIVE_LABEL_T, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_LABEL_LOCATE_ANY_T, SCH_LABEL_T, SCH_TEXT_T, SCH_TEXTBOX_T, SCH_ITEM::Schematic(), ACTIONS::selectionClear, ACTIONS::selectItem, EDA_TEXT::SetAttributes(), EDA_TEXT::SetBold(), EDA_SHAPE::SetEnd(), BOX2< Vec >::SetEnd(), EDA_ITEM::SetFlags(), EDA_TEXT::SetFont(), EDA_TEXT::SetHyperlink(), EDA_TEXT::SetItalic(), BOX2< Vec >::SetOrigin(), SCH_SHAPE::SetPosition(), SCH_LABEL_BASE::SetShape(), SCH_LABEL_BASE::SetSpinStyle(), SCH_FIELD::SetText(), EDA_TEXT::SetTextPos(), EDA_TEXT::SetTextSize(), EDA_TEXT::SetTextThickness(), SCHEMATIC::Settings(), text, EDA_ITEM::Type(), UnescapeString(), UNIMPLEMENTED_FOR, ACTIONS::unselectItem, COMMIT::Unstage(), SPIN_STYLE::UP, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by setTransitions().

CleanupSheetPins()

int SCH_EDIT_TOOL::CleanupSheetPins

(

const TOOL_EVENT &

aEvent

)

Definition at line 3038 of file sch_edit_tool.cpp.

References _, SCH_SHEET::CleanupSheet(), SELECTION::Front(), SCH_EDIT_FRAME::GetScreen(), SCH_SHEET::HasUndefinedPins(), SELECTION::IsHover(), IsOK(), SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_selectionTool, TOOL_BASE::m_toolMgr, COMMIT::Modify(), SCH_COMMIT::Push(), SCH_SELECTION_TOOL::RequestSelection(), TOOL_MANAGER::RunAction(), SCH_SHEET_T, ACTIONS::selectionClear, and SCH_TOOL_BASE< SCH_EDIT_FRAME >::updateItem().

Referenced by setTransitions().

collectUnits()

void SCH_EDIT_TOOL::collectUnits ( const SCH_SELECTION &  aSelection, std::set< std::pair< SCH_SYMBOL *, SCH_SCREEN * > > &  aCollectedUnits  )

private

Set up handlers for various events.

Definition at line 3230 of file sch_edit_tool.cpp.

References CollectOtherUnits(), SCH_EDIT_FRAME::GetCurrentSheet(), SCH_SYMBOL::GetLibId(), SCH_SYMBOL::GetRef(), SCH_EDIT_FRAME::GetScreen(), SCH_ITEM::GetUnit(), SCHEMATIC::Hierarchy(), SCH_SYMBOL::IsAnnotated(), SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, SCH_SYMBOL_T, and SCH_EDIT_FRAME::Schematic().

Referenced by SetAttribute().

DdAppendFile()

int SCH_EDIT_TOOL::DdAppendFile

(

const TOOL_EVENT &

aEvent

)

Drag and drop.

Definition at line 3224 of file sch_edit_tool.cpp.

References SCH_ACTIONS::importSheet, TOOL_BASE::m_toolMgr, TOOL_EVENT::Parameter(), and TOOL_MANAGER::RunAction().

Referenced by setTransitions().

DoDelete()

int SCH_EDIT_TOOL::DoDelete

(

const TOOL_EVENT &

aEvent

)

Run the deletion tool.

Definition at line 1659 of file sch_edit_tool.cpp.

References _, alg::contains(), deletableItems, SCH_EDIT_FRAME::DeleteJunction(), SCH_ITEM::GetConnectionPoints(), SCH_SCREEN::GetItem(), SELECTION::GetItems(), SCH_EDIT_FRAME::GetScreen(), EDA_ITEM::HasFlag(), SCH_ITEM::IsConnectable(), SCH_SCREEN::IsExplicitJunction(), SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_selectionTool, TOOL_BASE::m_toolMgr, COMMIT::Modify(), pin, SCH_COMMIT::Push(), COMMIT::Remove(), SCH_SHEET::RemovePin(), SCH_SELECTION_TOOL::RequestSelection(), TOOL_MANAGER::RunAction(), SCH_ITEM::RunOnChildren(), SCH_FIELD_T, SCH_GROUP_T, SCH_JUNCTION_T, SCH_RULE_AREA_T, SCH_SHEET_PIN_T, SCH_SHEET_T, SCH_TABLECELL_T, ACTIONS::selectionClear, EDA_ITEM::SetFlags(), STRUCT_DELETED, EDA_ITEM::Type(), and SCH_EDIT_FRAME::UpdateHierarchyNavigator().

Referenced by setTransitions().

EditField()

int SCH_EDIT_TOOL::EditField

(

const TOOL_EVENT &

aEvent

)

Definition at line 1883 of file sch_edit_tool.cpp.

References SELECTION_TOOL::AddItemToSel(), SCH_SELECTION_TOOL::ClearSelection(), editFieldText(), SCH_ACTIONS::editFootprint, SCH_ACTIONS::editReference, SCH_ACTIONS::editValue, SELECTION::Front(), SCH_SYMBOL::GetField(), SCH_FIELD::GetId(), EDA_ITEM::GetParent(), SCH_ITEM::GetParentSymbol(), TOOL_EVENT::IsAction(), SELECTION::IsHover(), SCH_SYMBOL::IsPower(), EDA_TEXT::IsVisible(), SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_selectionTool, TOOL_BASE::m_toolMgr, SCH_SELECTION_TOOL::RequestSelection(), TOOL_MANAGER::RunAction(), SCH_FIELD_T, SCH_PIN_T, SCH_SYMBOL_T, ACTIONS::selectionClear, SELECTION::Size(), and EDA_ITEM::Type().

Referenced by setTransitions().

editFieldText()

void SCH_EDIT_TOOL::editFieldText ( SCH_FIELD *  aField )

private

Definition at line 1836 of file sch_edit_tool.cpp.

References _, AUTOPLACE_AUTO, AUTOPLACE_MANUAL, SCH_ITEM::AutoplaceFields(), DO_TRANSLATE, SCH_BASE_FRAME::eeconfig(), COMMIT::Empty(), EESCHEMA_SETTINGS::AUTOPLACE_FIELDS::enable, SCH_EDIT_FRAME::GetCurrentSheet(), GetDefaultFieldName(), EDA_ITEM::GetEditFlags(), SCH_ITEM::GetFieldsAutoplaced(), SCH_FIELD::GetId(), SCH_FIELD::GetName(), EDA_ITEM::GetParent(), SCH_EDIT_FRAME::GetScreen(), SCH_FIELD::IsMandatory(), EESCHEMA_SETTINGS::m_AutoplaceFields, SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, TOOL_BASE::m_toolMgr, COMMIT::Modify(), SCH_COMMIT::Push(), SCH_SHEET_T, SCH_SYMBOL_T, SCHEMATIC_T, DIALOG_SHIM::ShowQuasiModal(), TitleCaps(), EDA_ITEM::Type(), and DIALOG_FIELD_PROPERTIES::UpdateField().

Referenced by EditField(), and Properties().

EditPageNumber()

int SCH_EDIT_TOOL::EditPageNumber

(

const TOOL_EVENT &

aEvent

)

Definition at line 3065 of file sch_edit_tool.cpp.

References _, SELECTION::Front(), SCH_EDIT_FRAME::GetCurrentSheet(), SCH_SHEET_PATH::GetPageNumber(), SCH_EDIT_FRAME::GetScreen(), SELECTION::GetSize(), SELECTION::IsHover(), SCH_SHEET_PATH::Last(), SCH_SHEET_PATH::LastScreen(), SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_selectionTool, TOOL_BASE::m_toolMgr, COMMIT::Modify(), SCH_EDIT_FRAME::OnPageSettingsChange(), SCH_SHEET_PATH::PathHumanReadable(), SCH_SHEET_PATH::pop_back(), SCH_COMMIT::Push(), SCH_SHEET_PATH::push_back(), SCH_SELECTION_TOOL::RequestSelection(), TOOL_MANAGER::RunAction(), SCH_SHEET_T, ACTIONS::selectionClear, SCH_SHEET_PATH::SetPageNumber(), BASE_SCREEN::SetPageNumber(), and SCH_SHEET_PATH::size().

Referenced by setTransitions().

getEditFrame()

template<typename T >

T * TOOL_BASE::getEditFrame ( ) const

inlineprotectedinherited

Return the application window object, casted to requested user type.

Definition at line 186 of file tool_base.h.

References TOOL_BASE::getToolHolderInternal(), and T.

Referenced by ZONE_CREATE_HELPER::createNewZone(), and ZONE_CREATE_HELPER::setUniquePriority().

GetId()

TOOL_ID TOOL_BASE::GetId ( ) const

inlineinherited

Return the unique identifier of the tool.

The identifier is set by an instance of TOOL_MANAGER.

Returns

Identifier of the tool.

Definition at line 123 of file tool_base.h.

References TOOL_BASE::m_toolId.

Referenced by TOOL_MANAGER::finishTool(), TOOL_MANAGER::InitTools(), TOOL_MANAGER::isActive(), TOOL_MANAGER::RegisterTool(), ACTION_MANAGER::RunHotKey(), TOOL_MANAGER::runTool(), TOOL_MANAGER::saveViewControls(), and TOOL_MANAGER::ShutdownTool().

GetManager()

TOOL_MANAGER * TOOL_BASE::GetManager ( ) const

inlineinherited

Return the instance of TOOL_MANAGER that takes care of the tool.

Returns

Instance of the TOOL_MANAGER or NULL if there is no associated tool manager.

Definition at line 146 of file tool_base.h.

References TOOL_BASE::m_toolMgr.

Referenced by MULTICHANNEL_TOOL::AutogenerateRuleAreas(), ZONE_CREATE_HELPER::commitZone(), ZONE_CREATE_HELPER::createNewZone(), PNS_KICAD_IFACE::DisplayItem(), PCB_TOOL_BASE::doInteractiveItemPlacement(), PCB_TUNING_PATTERN::EditPush(), PCB_TUNING_PATTERN::EditRevert(), PCB_TUNING_PATTERN::EditStart(), ACTION_MENU::getToolManager(), PNS_KICAD_IFACE::GetUnits(), makeShapeModificationMenu(), ZONE_CREATE_HELPER::OnFirstPoint(), ZONE_CREATE_HELPER::performZoneCutout(), PAD_TOOL::PlacePad(), MULTICHANNEL_TOOL::RepeatLayout(), SCH_COMMIT::SCH_COMMIT(), PCB_TUNING_PATTERN::Update(), and GLOBAL_EDIT_TOOL::ZonesManager().

getModel()

template<typename T >

T * TOOL_BASE::getModel ( ) const

inlineprotectedinherited

Return the model object if it matches the requested type.

Definition at line 198 of file tool_base.h.

References TOOL_BASE::getModelInternal(), and T.

Referenced by ZONE_CREATE_HELPER::commitZone(), and ZONE_CREATE_HELPER::createZoneFromExisting().

getModelInternal()

EDA_ITEM * TOOL_BASE::getModelInternal ( ) const

privateinherited

Definition at line 56 of file tool_base.cpp.

References TOOL_MANAGER::GetModel(), and TOOL_BASE::m_toolMgr.

Referenced by TOOL_BASE::getModel().

GetName()

const std::string & TOOL_BASE::GetName ( ) const

inlineinherited

Return the name of the tool.

Tool names are expected to obey the format: application.ToolName (eg. pcbnew.InteractiveSelection).

Returns

The name of the tool.

Definition at line 136 of file tool_base.h.

References TOOL_BASE::m_toolName.

Referenced by PCB_CONTROL::AppendBoard(), TOOL_MANAGER::dispatchInternal(), TOOL_INTERACTIVE::goInternal(), COMMON_TOOLS::GridProperties(), SCH_DRAWING_TOOLS::ImportSheet(), TOOL_MANAGER::InitTools(), TOOL_MANAGER::invokeTool(), TOOL_MANAGER::RegisterTool(), TOOL_MANAGER::ResetTools(), TOOL_MANAGER::runTool(), and TOOL_MANAGER::ShutdownTool().

getToolHolderInternal()

TOOLS_HOLDER * TOOL_BASE::getToolHolderInternal ( ) const

privateinherited

Definition at line 50 of file tool_base.cpp.

References TOOL_MANAGER::GetToolHolder(), and TOOL_BASE::m_toolMgr.

Referenced by TOOL_BASE::getEditFrame().

GetToolMenu()

TOOL_MENU & TOOL_INTERACTIVE::GetToolMenu ( )

inherited

Definition at line 112 of file tool_interactive.cpp.

References TOOL_INTERACTIVE::m_menu.

Referenced by EDIT_TOOL::doMoveSelection(), GROUP_TOOL::Init(), SCH_EDIT_TABLE_TOOL::Init(), SCH_INSPECTION_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), SCH_MOVE_TOOL::Init(), SCH_POINT_EDITOR::Init(), SYMBOL_EDITOR_EDIT_TOOL::Init(), SYMBOL_EDITOR_MOVE_TOOL::Init(), SYMBOL_EDITOR_PIN_TOOL::Init(), PL_EDIT_TOOL::Init(), ALIGN_DISTRIBUTE_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), BOARD_INSPECTION_TOOL::Init(), CONVERT_TOOL::Init(), EDIT_TOOL::Init(), FOOTPRINT_CHOOSER_SELECTION_TOOL::Init(), GENERATOR_TOOL::Init(), PAD_TOOL::Init(), PCB_EDIT_TABLE_TOOL::Init(), and PCB_POINT_EDITOR::Init().

GetType()

TOOL_TYPE TOOL_BASE::GetType ( ) const

inlineinherited

Return the type of the tool.

Returns

The type of the tool.

Definition at line 111 of file tool_base.h.

References TOOL_BASE::m_type.

Referenced by TOOL_MANAGER::InvokeTool(), TOOL_MANAGER::ResetTools(), TOOL_MANAGER::runTool(), and TOOL_MANAGER::ShutdownTool().

getView()

KIGFX::VIEW * TOOL_BASE::getView ( ) const

protectedinherited

Returns the instance of #VIEW object used in the application.

It allows tools to draw.

Returns

The instance of VIEW.

Definition at line 38 of file tool_base.cpp.

References TOOL_MANAGER::GetView(), and TOOL_BASE::m_toolMgr.

Referenced by SCH_POINT_EDITOR::addCornerCondition(), ALIGN_DISTRIBUTE_TOOL::AlignLeft(), ALIGN_DISTRIBUTE_TOOL::AlignRight(), SCH_INSPECTION_TOOL::CheckSymbol(), GERBVIEW_CONTROL::ClearAllLayers(), PL_SELECTION_TOOL::ClearSelection(), SCH_SELECTION_TOOL::ClearSelection(), SCH_SELECTION_TOOL::CollectHits(), SCH_LINE_WIRE_BUS_TOOL::computeBreakPoint(), COMMON_TOOLS::CursorControl(), EDIT_TOOL::DeleteItems(), COMMON_TOOLS::doCenter(), PL_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), SELECTION_TOOL::doSelectionMenu(), COMMON_TOOLS::doZoomFit(), COMMON_TOOLS::doZoomInOut(), COMMON_TOOLS::doZoomToPreset(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawOneBezier(), SCH_DRAWING_TOOLS::DrawRuleArea(), SCH_LINE_WIRE_BUS_TOOL::DrawSegments(), SCH_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_DRAWING_TOOLS::DrawTable(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawZone(), BOARD_EDITOR_CONTROL::DrillOrigin(), SCH_SELECTION_TOOL::EnterGroup(), PAD_TOOL::EnumeratePads(), SCH_SELECTION_TOOL::ExitGroup(), PCB_SELECTION_TOOL::FilterCollectorForFootprints(), SCH_SELECTION_TOOL::GetNode(), ROUTER_TOOL::getStartLayer(), PCB_CONTROL::GridPlaceOrigin(), PCB_CONTROL::GridResetOrigin(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), SCH_SELECTION_TOOL::GuessSelectionCandidates(), ROUTER_TOOL::handleCommonEvents(), PL_SELECTION_TOOL::highlight(), PCB_SELECTION_TOOL::highlight(), SCH_SELECTION_TOOL::highlight(), GERBVIEW_CONTROL::HighlightControl(), BOARD_INSPECTION_TOOL::highlightNet(), PNS::TOOL_BASE::highlightNets(), PCB_SELECTION_TOOL::hitTestDistance(), SCH_DRAWING_TOOLS::ImportGraphics(), SYMBOL_EDITOR_DRAWING_TOOLS::ImportGraphics(), SCH_DRAWING_TOOLS::ImportSheet(), EDIT_TOOL::Init(), ROUTER_TOOL::InlineDrag(), InteractiveDelete(), PL_EDIT_TOOL::InteractiveDelete(), PCB_CONTROL::InteractiveDelete(), SCH_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), PCB_PICKER_TOOL::Main(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), Mirror(), EDIT_TOOL::MoveExact(), PL_EDIT_TOOL::moveItem(), COMMON_TOOLS::OnGridChanged(), PCB_POINT_EDITOR::OnSelectionChange(), COMMON_TOOLS::PanControl(), SCH_EDITOR_CONTROL::Paste(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PL_EDIT_TOOL::Paste(), ROUTER_TOOL::performRouting(), PNS::TOOL_BASE::pickSingleItem(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceReferenceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), POSITION_RELATIVE_TOOL::PositionRelativeInteractively(), ROUTER_TOOL::prepareInteractive(), Properties(), EDIT_TOOL::Properties(), PCB_SELECTION_TOOL::pruneObscuredSelectionCandidates(), SCH_SELECTION_TOOL::Reset(), SCH_TOOL_BASE< T >::Reset(), GERBVIEW_SELECTION_TOOL::Reset(), PNS::TOOL_BASE::Reset(), BOARD_EDITOR_CONTROL::Reset(), DRAWING_TOOL::Reset(), GENERATOR_TOOL_PNS_PROXY::Reset(), PCB_CONTROL::Reset(), PCB_SELECTION_TOOL::Reset(), Rotate(), GERBVIEW_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::Selectable(), SCH_SELECTION_TOOL::SelectAll(), PCB_SELECTION_TOOL::SelectAll(), SCH_SELECTION_TOOL::selectionContains(), PL_SELECTION_TOOL::selectionContains(), PCB_SELECTION_TOOL::selectionContains(), SCH_SELECTION_TOOL::selectMultiple(), PL_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::SelectMultiple(), PL_SELECTION_TOOL::SelectPoint(), SCH_SELECTION_TOOL::selectPoint(), PCB_SELECTION_TOOL::SelectPolyArea(), PCB_SELECTION_TOOL::SelectRectArea(), ZOOM_TOOL::selectRegion(), GERBVIEW_SELECTION_TOOL::selectVisually(), DRAWING_TOOL::SetAnchor(), SCH_EDITOR_CONTROL::SimProbe(), SCH_EDITOR_CONTROL::SimTune(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_EDITOR_CONTROL::ToggleDirectiveLabels(), SCH_EDITOR_CONTROL::ToggleERCErrors(), SCH_EDITOR_CONTROL::ToggleERCWarnings(), SCH_EDITOR_CONTROL::ToggleHiddenFields(), SYMBOL_EDITOR_CONTROL::ToggleHiddenFields(), SCH_EDITOR_CONTROL::ToggleHiddenPins(), SYMBOL_EDITOR_CONTROL::ToggleHiddenPins(), SCH_EDITOR_CONTROL::ToggleOPCurrents(), SCH_EDITOR_CONTROL::ToggleOPVoltages(), SCH_EDITOR_CONTROL::TogglePinAltIcons(), SYMBOL_EDITOR_CONTROL::TogglePinAltIcons(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), PL_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlight(), PCB_TEST_SELECTION_TOOL::unhighlight(), SCH_SELECTION_TOOL::unhighlight(), GERBVIEW_SELECTION_TOOL::unselect(), SCH_SELECTION_TOOL::UnselectAll(), PCB_SELECTION_TOOL::UnselectAll(), GERBVIEW_SELECTION_TOOL::unselectVisually(), SCH_POINT_EDITOR::updateEditedPoint(), PL_POINT_EDITOR::updateEditedPoint(), PCB_POINT_EDITOR::updateEditedPoint(), SCH_FIND_REPLACE_TOOL::UpdateFind(), PL_POINT_EDITOR::updateItem(), PCB_POINT_EDITOR::updateItem(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), SCH_POINT_EDITOR::updatePoints(), PL_POINT_EDITOR::updatePoints(), PCB_POINT_EDITOR::updatePoints(), SCH_SELECTION_TOOL::updateSelection(), PCB_SELECTION_TOOL::updateSelection(), PNS::TOOL_BASE::updateStartItem(), PCB_SELECTION_TOOL::view(), PCB_TOOL_BASE::view(), PCB_VIEWER_TOOLS::view(), PCB_TEST_SELECTION_TOOL::view(), SCH_SELECTION_TOOL::ZoomFitCrossProbeBBox(), PCB_SELECTION_TOOL::ZoomFitCrossProbeBBox(), PCB_SELECTION_TOOL::zoomFitSelection(), GERBVIEW_SELECTION_TOOL::~GERBVIEW_SELECTION_TOOL(), PCB_SELECTION_TOOL::~PCB_SELECTION_TOOL(), and SCH_SELECTION_TOOL::~SCH_SELECTION_TOOL().

getViewControls()

KIGFX::VIEW_CONTROLS * TOOL_BASE::getViewControls ( ) const

protectedinherited

Return the instance of VIEW_CONTROLS object used in the application.

It allows tools to read & modify user input and its settings (eg. show cursor, enable snapping to grid, etc.).

Returns

The instance of VIEW_CONTROLS.

Definition at line 44 of file tool_base.cpp.

References TOOL_MANAGER::GetViewControls(), and TOOL_BASE::m_toolMgr.

Referenced by SCH_POINT_EDITOR::addCorner(), PCB_POINT_EDITOR::addCorner(), SCH_POINT_EDITOR::addCornerCondition(), SCH_SELECTION_TOOL::autostartEvent(), BreakWire(), PCB_POINT_EDITOR::chamferCorner(), PCB_SELECTION_TOOL::controls(), PCB_TOOL_BASE::controls(), PCB_TEST_SELECTION_TOOL::controls(), EDIT_TOOL::copyToClipboard(), COMMON_TOOLS::CursorControl(), EDIT_TOOL::DeleteItems(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), COMMON_TOOLS::doZoomToPreset(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawLine(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::DrawRectangle(), SCH_DRAWING_TOOLS::DrawRuleArea(), SCH_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_DRAWING_TOOLS::DrawTable(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), SCH_EDITOR_CONTROL::HighlightNet(), BOARD_INSPECTION_TOOL::HighlightNet(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), SCH_DRAWING_TOOLS::ImportGraphics(), SYMBOL_EDITOR_DRAWING_TOOLS::ImportGraphics(), SCH_DRAWING_TOOLS::ImportSheet(), SYMBOL_EDITOR_EDIT_TOOL::Increment(), EDIT_TOOL::Init(), SCH_POINT_EDITOR::Main(), SCH_SELECTION_TOOL::Main(), PICKER_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), PCB_PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), PCB_POINT_EDITOR::makePoints(), SCH_POINT_EDITOR::makePointsAndBehavior(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), COMMON_TOOLS::OnGridChanged(), PCB_POINT_EDITOR::OnSelectionChange(), SCH_EDITOR_CONTROL::Paste(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), PCB_CONTROL::placeBoardItems(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceReferenceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceTuningPattern(), POSITION_RELATIVE_TOOL::PositionRelativeInteractively(), Properties(), EDIT_TOOL::Properties(), RepeatDrawItem(), PL_SELECTION_TOOL::RequestSelection(), SCH_SELECTION_TOOL::RequestSelection(), DRAWING_TOOL::Reset(), PCB_POINT_EDITOR::Reset(), COMMON_TOOLS::ResetLocalCoords(), ROUTER_TOOL::RouteSelected(), PCB_SELECTION_TOOL::selectCursor(), SCH_SELECTION_TOOL::selectMultiple(), PL_SELECTION_TOOL::selectMultiple(), SCH_SELECTION_TOOL::SelectNode(), PCB_SELECTION_TOOL::SelectPolyArea(), PCB_SELECTION_TOOL::SelectRectArea(), ZOOM_TOOL::selectRegion(), PCB_SELECTION_TOOL::selectTableCells(), SCH_SELECTION_TOOL::selectTableCells(), ALIGN_DISTRIBUTE_TOOL::selectTarget(), PICKER_TOOL::setControls(), PCB_PICKER_TOOL::setControls(), SCH_POINT_EDITOR::setEditedPoint(), PL_POINT_EDITOR::setEditedPoint(), PCB_POINT_EDITOR::setEditedPoint(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::SyncSheetsPins(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), SCH_POINT_EDITOR::updateEditedPoint(), PL_POINT_EDITOR::updateEditedPoint(), PCB_POINT_EDITOR::updateEditedPoint(), PL_EDIT_TOOL::updateModificationPoint(), and COMMON_TOOLS::ZoomCenter().

GlobalEdit()

int SCH_EDIT_TOOL::GlobalEdit

(

const TOOL_EVENT &

aEvent

)

Delete the selected items, or the item under the cursor.

Definition at line 536 of file eeschema/dialogs/dialog_global_edit_text_and_graphics.cpp.

References SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, and DIALOG_SHIM::ShowModal().

Referenced by setTransitions().

Go()

template<class T >

void TOOL_INTERACTIVE::Go ( int(T::*)(const TOOL_EVENT &)  aStateFunc, const TOOL_EVENT_LIST &  aConditions = TOOL_EVENT( TC_ANY, TA_ANY )  )

inherited

Define which state (aStateFunc) to go when a certain event arrives (aConditions).

No conditions means any event.

Definition at line 147 of file tool_interactive.h.

References TOOL_INTERACTIVE::goInternal(), and T.

Referenced by EDA_3D_CONTROLLER::setTransitions(), BITMAP2CMP_CONTROL::setTransitions(), DESIGN_BLOCK_CONTROL::setTransitions(), GROUP_TOOL::setTransitions(), LIBRARY_EDITOR_CONTROL::setTransitions(), CVPCB_ASSOCIATION_TOOL::setTransitions(), CVPCB_CONTROL::setTransitions(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::setTransitions(), SCH_DESIGN_BLOCK_CONTROL::setTransitions(), SCH_DRAWING_TOOLS::setTransitions(), SCH_EDIT_TABLE_TOOL::setTransitions(), setTransitions(), SCH_EDITOR_CONTROL::setTransitions(), SCH_FIND_REPLACE_TOOL::setTransitions(), SCH_INSPECTION_TOOL::setTransitions(), SCH_LINE_WIRE_BUS_TOOL::setTransitions(), SCH_MOVE_TOOL::setTransitions(), SCH_NAVIGATE_TOOL::setTransitions(), SCH_POINT_EDITOR::setTransitions(), SCH_SELECTION_TOOL::setTransitions(), SIMULATOR_CONTROL::setTransitions(), SYMBOL_EDITOR_CONTROL::setTransitions(), SYMBOL_EDITOR_DRAWING_TOOLS::setTransitions(), SYMBOL_EDITOR_EDIT_TOOL::setTransitions(), SYMBOL_EDITOR_MOVE_TOOL::setTransitions(), SYMBOL_EDITOR_PIN_TOOL::setTransitions(), GERBVIEW_CONTROL::setTransitions(), GERBVIEW_INSPECTION_TOOL::setTransitions(), GERBVIEW_SELECTION_TOOL::setTransitions(), COMMON_CONTROL::setTransitions(), COMMON_TOOLS::setTransitions(), EMBED_TOOL::setTransitions(), PICKER_TOOL::setTransitions(), PROPERTIES_TOOL::setTransitions(), ZOOM_TOOL::setTransitions(), KICAD_MANAGER_CONTROL::setTransitions(), PL_DRAWING_TOOLS::setTransitions(), PL_EDIT_TOOL::setTransitions(), PL_EDITOR_CONTROL::setTransitions(), PL_POINT_EDITOR::setTransitions(), PL_SELECTION_TOOL::setTransitions(), PCB_CALCULATOR_CONTROL::setTransitions(), AUTOPLACE_TOOL::setTransitions(), MICROWAVE_TOOL::setTransitions(), SCRIPTING_TOOL::setTransitions(), ROUTER_TOOL::setTransitions(), ALIGN_DISTRIBUTE_TOOL::setTransitions(), ARRAY_TOOL::setTransitions(), BOARD_EDITOR_CONTROL::setTransitions(), BOARD_INSPECTION_TOOL::setTransitions(), BOARD_REANNOTATE_TOOL::setTransitions(), CONVERT_TOOL::setTransitions(), DRAWING_TOOL::setTransitions(), DRC_TOOL::setTransitions(), EDIT_TOOL::setTransitions(), FOOTPRINT_CHOOSER_SELECTION_TOOL::setTransitions(), FOOTPRINT_EDITOR_CONTROL::setTransitions(), FOOTPRINT_WIZARD_TOOLS::setTransitions(), GENERATOR_TOOL::setTransitions(), GLOBAL_EDIT_TOOL::setTransitions(), MULTICHANNEL_TOOL::setTransitions(), PAD_TOOL::setTransitions(), PCB_CONTROL::setTransitions(), PCB_DESIGN_BLOCK_CONTROL::setTransitions(), PCB_EDIT_TABLE_TOOL::setTransitions(), PCB_PICKER_TOOL::setTransitions(), PCB_POINT_EDITOR::setTransitions(), PCB_SELECTION_TOOL::setTransitions(), PCB_VIEWER_TOOLS::setTransitions(), POSITION_RELATIVE_TOOL::setTransitions(), ZONE_FILLER_TOOL::setTransitions(), and PCB_TEST_SELECTION_TOOL::setTransitions().

goInternal()

void TOOL_INTERACTIVE::goInternal ( TOOL_STATE_FUNC &  aState, const TOOL_EVENT_LIST &  aConditions  )

privateinherited

Definition at line 84 of file tool_interactive.cpp.

References TOOL_BASE::GetName(), kicadTraceToolStack, TOOL_BASE::m_toolMgr, TOOL_EVENT_LIST::Names(), and TOOL_MANAGER::ScheduleNextState().

Referenced by TOOL_INTERACTIVE::Go().

Increment()

int SCH_EDIT_TOOL::Increment

(

const TOOL_EVENT &

aEvent

)

Increment/decrement something about an item.

Definition at line 3139 of file sch_edit_tool.cpp.

References _, TOOL_EVENT::Commit(), ACTIONS::INCREMENT::Delta, SELECTION::Empty(), SELECTION::Front(), SCH_EDIT_FRAME::GetScreen(), EDA_TEXT::GetText(), STRING_INCREMENTER::Increment(), ACTIONS::INCREMENT::Index, SELECTION::IsHover(), SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_selectionTool, TOOL_BASE::m_toolMgr, COMMIT::Modify(), TOOL_EVENT::Parameter(), TOOL_MANAGER::PostAction(), SCH_COMMIT::Push(), ACTIONS::refreshPreview, SCH_SELECTION_TOOL::RequestSelection(), TOOL_MANAGER::RunAction(), SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_LABEL_T, SCH_TEXT_T, ACTIONS::selectionClear, STRING_INCREMENTER::SetSkipIOSQXZ(), EDA_TEXT::SetText(), and EDA_ITEM::Type().

Referenced by setTransitions().

Init()

bool SCH_EDIT_TOOL::Init ( )

overridevirtual

Init() is called once upon a registration of the tool.

Returns

True if the initialization went fine, false - otherwise.

Reimplemented from TOOL_BASE.

Definition at line 269 of file sch_edit_tool.cpp.

References EE_RTREE::empty(), SCH_EDIT_FRAME::GetScreen(), TOOL_MANAGER::GetTool(), SCH_TOOL_BASE< T >::Init(), SCH_SCREEN::Items(), SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, TOOL_BASE::m_toolMgr, and SCH_SHEET_T.

InteractiveDelete()

int SCH_EDIT_TOOL::InteractiveDelete

(

const TOOL_EVENT &

aEvent

)

Definition at line 1767 of file sch_edit_tool.cpp.

References TOOL_INTERACTIVE::Activate(), SELECTION_TOOL::AddItemToSel(), SELECTION_TOOL::BrightenItem(), PICKER_TOOL_BASE::ClearHandlers(), SCH_COLLECTOR::Collect(), deletableItems, ACTIONS::doDelete, COLLECTOR::GetCount(), SCH_EDIT_FRAME::GetScreen(), TOOL_MANAGER::GetTool(), TOOL_BASE::getView(), SCH_SELECTION_TOOL::GuessSelectionCandidates(), HITTEST_THRESHOLD_PIXELS, KiROUND(), SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, m_pickerItem, COLLECTOR::m_Threshold, TOOL_BASE::m_toolMgr, ACTIONS::pickerTool, TOOL_MANAGER::PostAction(), TOOL_MANAGER::RunAction(), ACTIONS::selectionActivate, ACTIONS::selectionClear, PICKER_TOOL_BASE::SetClickHandler(), PICKER_TOOL_BASE::SetCursor(), PICKER_TOOL_BASE::SetFinalizeHandler(), PICKER_TOOL_BASE::SetMotionHandler(), PICKER_TOOL_BASE::SetSnapping(), and SELECTION_TOOL::UnbrightenItem().

Referenced by setTransitions().

IsSymbolEditor()

bool SCH_TOOL_BASE< SCH_EDIT_FRAME >::IsSymbolEditor ( ) const

inlineinherited

Returns true if the tool is running in the symbol editor.

Definition at line 100 of file sch_tool_base.h.

IsToolActive()

bool TOOL_BASE::IsToolActive ( ) const

inherited

Definition at line 32 of file tool_base.cpp.

References TOOL_MANAGER::IsToolActive(), TOOL_BASE::m_toolId, and TOOL_BASE::m_toolMgr.

Referenced by EDIT_TOOL::ChangeTrackLayer(), EDIT_TOOL::Drag(), ROUTER_TOOL::handleLayerSwitch(), EDIT_TOOL::invokeInlineRouter(), PCB_SELECTION_TOOL::Main(), BOARD_EDITOR_CONTROL::TrackWidthDec(), and BOARD_EDITOR_CONTROL::TrackWidthInc().

JustifyText()

int SCH_EDIT_TOOL::JustifyText

(

const TOOL_EVENT &

aEvent

)

Definition at line 2843 of file sch_edit_tool.cpp.

References _, ANGLE_HORIZONTAL, AUTOPLACE_NONE, ACTIONS::centerJustify, TOOL_EVENT::Commit(), COMMIT::Empty(), SELECTION::Front(), EDA_ITEM::GetParent(), SCH_EDIT_FRAME::GetScreen(), SELECTION::GetSize(), EDA_TEXT::GetTextAngle(), GR_TEXT_H_ALIGN_CENTER, GR_TEXT_H_ALIGN_LEFT, GR_TEXT_H_ALIGN_RIGHT, SELECTION::IsHover(), EDA_ITEM::IsMoving(), ACTIONS::leftJustify, SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_selectionTool, TOOL_BASE::m_toolMgr, TOOL_ACTION::MakeEvent(), TOOL_EVENT::Matches(), COMMIT::Modify(), SCH_COMMIT::Push(), ACTIONS::refreshPreview, SCH_SELECTION_TOOL::RequestSelection(), TOOL_MANAGER::RunAction(), SCH_FIELD_T, SCH_LABEL_T, SCH_TEXT_T, SCH_TEXTBOX_T, ACTIONS::selectionClear, EDA_ITEM::Type(), SCH_TOOL_BASE< SCH_EDIT_FRAME >::updateItem(), and SCH_EDIT_FRAME::UpdateItem().

Referenced by setTransitions().

Mirror()

int SCH_EDIT_TOOL::Mirror

(

const TOOL_EVENT &

aEvent

)

Definition at line 1071 of file sch_edit_tool.cpp.

References _, SCH_LINE_WIRE_BUS_TOOL::AddJunctionsIfNeeded(), AUTOPLACE_NONE, BOX2< Vec >::Centre(), SCHEMATIC::CleanUp(), TOOL_EVENT::Commit(), COMMIT::Empty(), SELECTION::Front(), EDA_ITEM::GetBoundingBox(), SCH_SHEET::GetBoundingBox(), SELECTION::GetCenter(), BOX2< Vec >::GetCenter(), GetFlippedAlignment(), EDA_TEXT::GetHorizJustify(), EDA_DRAW_FRAME::GetNearestHalfGridPosition(), EDA_ITEM::GetParent(), EDA_ITEM::GetPosition(), SCH_EDIT_FRAME::GetScreen(), SELECTION::GetSize(), TOOL_MANAGER::GetTool(), EDA_TEXT::GetVertJustify(), TOOL_BASE::getView(), SCH_ITEM::IsConnectable(), SELECTION::IsHover(), EDA_ITEM::IsMoving(), EDA_ITEM::IsSelected(), SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_selectionTool, TOOL_BASE::m_toolMgr, TOOL_EVENT::Matches(), SCH_ITEM::MirrorHorizontally(), SCH_TEXT::MirrorSpinStyle(), SCH_ACTIONS::mirrorV, SCH_ITEM::MirrorVertically(), COMMIT::Modify(), pin, SCH_COMMIT::Push(), KIGFX::VIEW::RecacheAllItems(), ACTIONS::refreshPreview, SCH_SELECTION_TOOL::RequestSelection(), RotatableItems, TOOL_MANAGER::RunAction(), SCH_BITMAP_T, SCH_DIRECTIVE_LABEL_T, SCH_FIELD_T, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_LABEL_T, SCH_SHEET_PIN_T, SCH_SHEET_T, SCH_SYMBOL_T, SCH_TEXT_T, SCH_EDIT_FRAME::Schematic(), ACTIONS::selectionClear, SCH_ITEM::SetFieldsAutoplaced(), EDA_TEXT::SetHorizJustify(), SCH_SYMBOL::SetOrientation(), EDA_TEXT::SetVertJustify(), SYM_MIRROR_X, SYM_MIRROR_Y, SCH_LINE_WIRE_BUS_TOOL::TrimOverLappingWires(), EDA_ITEM::Type(), SCH_TOOL_BASE< SCH_EDIT_FRAME >::updateItem(), SCH_EDIT_FRAME::UpdateItem(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by setTransitions().

Properties()

int SCH_EDIT_TOOL::Properties

(

const TOOL_EVENT &

aEvent

)

Definition at line 2089 of file sch_edit_tool.cpp.

References _, AUTOPLACE_AUTO, AUTOPLACE_MANUAL, SCH_SYMBOL::AutoplaceFields(), SCH_SHEET_LIST::BuildSheetList(), DIALOG_CHANGE_SYMBOLS::CHANGE, SCH_SCREEN::ClearAnnotation(), SCH_SCREENS::ClearAnnotationOfNewSheetPaths(), EDA_BASE_FRAME::ClearUndoRedoList(), SCH_INSPECTION_TOOL::CrossProbe(), editFieldText(), editor, SCH_EDIT_FRAME::EditSheetProperties(), SCH_BASE_FRAME::eeconfig(), SELECTION::Empty(), EESCHEMA_SETTINGS::AUTOPLACE_FIELDS::enable, FRAME_SCH_SYMBOL_EDITOR, SELECTION::Front(), SCH_ITEM::GetBodyStyle(), SCH_BASE_FRAME::GetCanvas(), KIGFX::VIEW_ITEM::GetClass(), SCH_EDIT_FRAME::GetCurrentSheet(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), KIGFX::SCH_VIEW::GetDrawingSheet(), SCH_ITEM::GetFieldsAutoplaced(), SCH_SYMBOL::GetLibId(), EDA_ITEM::GetParent(), DIALOG_TABLECELL_PROPERTIES::GetReturnValue(), SCH_SHEET::GetScreen(), SCH_EDIT_FRAME::GetScreen(), SELECTION::GetSize(), TOOL_MANAGER::GetTool(), SCH_ITEM::GetUnit(), TOOL_BASE::getView(), SCH_DRAW_PANEL::GetView(), TOOL_BASE::getViewControls(), ACTIONS::groupProperties, DS_PROXY_VIEW_ITEM::HitTestDrawingSheetItems(), SELECTION::IsHover(), SCH_SYMBOL::IsMissingLibSymbol(), EDA_TEXT::IsVisible(), SELECTION::Items(), KIWAY_HOLDER::Kiway(), LAYER_SCHEMATIC_DRAWINGSHEET, EESCHEMA_SETTINGS::m_AutoplaceFields, SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_selectionTool, TOOL_BASE::m_toolMgr, COMMIT::Modify(), SCHEMATIC::OnItemsAdded(), SCHEMATIC::OnItemsRemoved(), SELECTION_CONDITIONS::OnlyTypes(), SCH_EDIT_FRAME::OnModify(), ACTIONS::pageSettings, pin, KIWAY::Player(), TOOL_MANAGER::PostAction(), SCH_COMMIT::Push(), KIGFX::VIEW::RecacheAllItems(), EDA_DRAW_PANEL_GAL::Refresh(), SCHEMATIC::RefreshHierarchy(), SCH_SELECTION_TOOL::RequestSelection(), SCHEMATIC::Root(), TOOL_MANAGER::RunAction(), SCH_BITMAP_T, SCH_BUS_WIRE_ENTRY_T, SCH_DIRECTIVE_LABEL_T, SCH_FIELD_T, SCH_GLOBAL_LABEL_T, SCH_GROUP_T, SCH_HIER_LABEL_T, SCH_ITEM_LOCATE_BUS_T, SCH_ITEM_LOCATE_GRAPHIC_LINE_T, SCH_ITEM_LOCATE_WIRE_T, SCH_JUNCTION_T, SCH_LABEL_T, SCH_LINE_T, SCH_MARKER_T, SCH_NO_CONNECT_T, SCH_PIN_T, SCH_RULE_AREA_T, SCH_SHAPE_T, SCH_SHEET_PIN_T, SCH_SHEET_T, SCH_SYMBOL_T, SCH_TABLE_T, SCH_TABLECELL_T, SCH_TEXT_T, SCH_TEXTBOX_T, SCH_EDIT_FRAME::Schematic(), ACTIONS::selectionClear, DIALOG_SHIM::ShowModal(), DIALOG_SHIM::ShowQuasiModal(), SELECTION::Size(), SYMBOL_PROPS_EDIT_LIBRARY_SYMBOL, SYMBOL_PROPS_EDIT_OK, SYMBOL_PROPS_EDIT_SCHEMATIC_SYMBOL, SYMBOL_PROPS_WANT_EXCHANGE_SYMBOL, SYMBOL_PROPS_WANT_UPDATE_SYMBOL, table, DIALOG_TABLECELL_PROPERTIES::TABLECELL_PROPS_EDIT_TABLE, EDA_ITEM::Type(), DIALOG_CHANGE_SYMBOLS::UPDATE, SCH_EDIT_FRAME::UpdateHierarchyNavigator(), and SCH_TOOL_BASE< SCH_EDIT_FRAME >::updateItem().

Referenced by setTransitions().

RepeatDrawItem()

int SCH_EDIT_TOOL::RepeatDrawItem

(

const TOOL_EVENT &

aEvent

)

Definition at line 1501 of file sch_edit_tool.cpp.

References _, SELECTION::Add(), SCH_EDIT_FRAME::AddCopyForRepeatItem(), SCH_LINE_WIRE_BUS_TOOL::AddJunctionsIfNeeded(), SCH_BASE_FRAME::AddToScreen(), annotate, ANNOTATE_SELECTION, SCH_EDIT_FRAME::AnnotateSymbols(), SCH_EDIT_FRAME::CheckSheetForRecursion(), SCHEMATIC::CleanUp(), SCH_ITEM::Duplicate(), SCH_EDIT_FRAME::EditSheetProperties(), SCH_BASE_FRAME::eeconfig(), SELECTION::Empty(), SCH_EDIT_FRAME::GetCurrentSheet(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), SCH_SELECTION_TOOL::GetEnteredGroup(), SCH_SCREEN::GetFileName(), SCH_SHEET::GetFileName(), EDA_ITEM::GetPosition(), SCH_EDIT_FRAME::GetRepeatItems(), SCH_SHEET::GetScreen(), SCH_EDIT_FRAME::GetScreen(), SELECTION::GetSize(), TOOL_MANAGER::GetTool(), TOOL_BASE::getViewControls(), IGNORE_PARENT_GROUP, IS_NEW, SCH_ITEM::IsGroupableType(), EESCHEMA_SETTINGS::m_AnnotatePanel, SCHEMATIC_SETTINGS::m_AnnotateStartNum, SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, TOOL_BASE::m_toolMgr, EDA_IU_SCALE::MilsToIU(), SCH_ITEM::Move(), SCH_ACTIONS::move, TOOL_MANAGER::RunAction(), TOOL_MANAGER::RunSynchronousAction(), SCH_EDIT_FRAME::SaveCopyForRepeatItem(), SCH_SHEET_T, SCH_SYMBOL_T, SCH_EDIT_FRAME::Schematic(), schIUScale, ACTIONS::selectionClear, ACTIONS::selectItem, SCH_SCREEN::SetFileName(), SCH_SHEET::SetFileName(), EDA_ITEM::SetFlags(), EDA_ITEM::SetParent(), SCHEMATIC::Settings(), EDA_BASE_FRAME::ShowInfoBarWarning(), SCH_LINE_WIRE_BUS_TOOL::TrimOverLappingWires(), and EDA_ITEM::Type().

Referenced by setTransitions().

Reset()

void SCH_TOOL_BASE< SCH_EDIT_FRAME >::Reset ( RESET_REASON  aReason )

inlineoverridevirtualinherited

Bring the tool to a known, initial state.

If the tool claimed anything from the model or the view, it must release it when its reset.

Parameters

aReason

contains information about the reason of tool reset.

Implements TOOL_BASE.

Definition at line 85 of file sch_tool_base.h.

resetTransitions()

void TOOL_INTERACTIVE::resetTransitions ( )

privateinherited

Clear the current transition map and restores the default one created by setTransitions().

Definition at line 77 of file tool_interactive.cpp.

References TOOL_MANAGER::ClearTransitions(), TOOL_BASE::m_toolMgr, and TOOL_INTERACTIVE::setTransitions().

Rotate()

int SCH_EDIT_TOOL::Rotate

(

const TOOL_EVENT &

aEvent

)

Definition at line 779 of file sch_edit_tool.cpp.

References _, SCH_LINE_WIRE_BUS_TOOL::AddJunctionsIfNeeded(), ANGLE_90, ANGLE_HORIZONTAL, ANGLE_VERTICAL, AUTOPLACE_AUTO, AUTOPLACE_MANUAL, AUTOPLACE_NONE, SCH_SYMBOL::AutoplaceFields(), SCHEMATIC::CleanUp(), TOOL_EVENT::Commit(), SCH_BASE_FRAME::eeconfig(), COMMIT::Empty(), EESCHEMA_SETTINGS::AUTOPLACE_FIELDS::enable, ENDPOINT, SCH_SHEET::GetBodyBoundingBox(), EDA_ITEM::GetBoundingBox(), SCH_SHEET::GetBoundingBox(), SELECTION::GetCenter(), BOX2< Vec >::GetCenter(), SCH_ITEM::GetClass(), SCH_LINE::GetEndPoint(), SCH_ITEM::GetFieldsAutoplaced(), SELECTION::GetItem(), EDA_DRAW_FRAME::GetNearestHalfGridPosition(), EDA_ITEM::GetParent(), EDA_ITEM::GetPosition(), SELECTION::GetReferencePoint(), SCH_SHEET::GetRotationCenter(), SCH_EDIT_FRAME::GetScreen(), SELECTION::GetSize(), SCH_LINE::GetStartPoint(), EDA_TEXT::GetTextAngle(), TOOL_MANAGER::GetTool(), TOOL_BASE::getView(), group, EDA_ITEM::HasFlag(), SELECTION::HasReferencePoint(), SCH_ITEM::IsConnectable(), EDA_ANGLE::IsHorizontal(), SELECTION::IsHover(), EDA_ITEM::IsMoving(), EDA_ITEM::IsSelected(), KI_FALLTHROUGH, EESCHEMA_SETTINGS::m_AutoplaceFields, SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_selectionTool, TOOL_BASE::m_toolMgr, TOOL_EVENT::Matches(), COMMIT::Modify(), pin, TOOL_MANAGER::PostAction(), SCH_COMMIT::Push(), KIGFX::VIEW::RecacheAllItems(), ACTIONS::refreshPreview, SCH_SELECTION_TOOL::RequestSelection(), RotatableItems, SCH_ITEM::Rotate(), SCH_FIELD::Rotate(), SCH_LINE::Rotate(), SCH_SHEET::Rotate(), SCH_SYMBOL::Rotate(), SCH_TEXT::Rotate90(), SCH_ACTIONS::rotateCW, RotatePoint(), TOOL_MANAGER::RunAction(), SCH_BITMAP_T, SCH_BUS_BUS_ENTRY_T, SCH_BUS_WIRE_ENTRY_T, SCH_DIRECTIVE_LABEL_T, SCH_FIELD_T, SCH_GLOBAL_LABEL_T, SCH_GROUP_T, SCH_HIER_LABEL_T, SCH_JUNCTION_T, SCH_LABEL_T, SCH_LINE_T, SCH_NO_CONNECT_T, SCH_RULE_AREA_T, SCH_SHAPE_T, SCH_SHEET_PIN_T, SCH_SHEET_T, SCH_SYMBOL_T, SCH_TABLE_T, SCH_TEXT_T, SCH_TEXTBOX_T, SCH_EDIT_FRAME::Schematic(), SELECTED_BY_DRAG, ACTIONS::selectionClear, EDA_ITEM::SetFlags(), EDA_TEXT::SetTextAngle(), STARTPOINT, table, SCH_LINE_WIRE_BUS_TOOL::TrimOverLappingWires(), EDA_ITEM::Type(), UNIMPLEMENTED_FOR, SCH_TOOL_BASE< SCH_EDIT_FRAME >::updateItem(), and SCH_EDIT_FRAME::UpdateItem().

Referenced by setTransitions().

RunMainStack()

void TOOL_INTERACTIVE::RunMainStack ( std::function< void()>  aFunc )

inherited

Call a function using the main stack.

Parameters

aFunc

is the function to be calls.

Definition at line 106 of file tool_interactive.cpp.

References TOOL_BASE::m_toolMgr, and TOOL_MANAGER::RunMainStack().

Referenced by DRAWING_TOOL::PlaceText().

saveCopyInUndoList()

void SCH_TOOL_BASE< SCH_EDIT_FRAME >::saveCopyInUndoList ( EDA_ITEM *  aItem, UNDO_REDO  aType, bool  aAppend = false, bool  aDirtyConnectivity = true  )

inlineprotectedinherited

Definition at line 117 of file sch_tool_base.h.

SetAttribute()

int SCH_EDIT_TOOL::SetAttribute

(

const TOOL_EVENT &

aEvent

)

Modify Attributes (DNP, Exclude, etc.) All attributes are set to true unless all symbols already have the attribute set to true.

Definition at line 3265 of file sch_edit_tool.cpp.

References _, collectUnits(), COMMIT::Empty(), TOOL_EVENT::IsAction(), SELECTION::IsHover(), SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_selectionTool, TOOL_BASE::m_toolMgr, COMMIT::Modify(), SCH_COMMIT::Push(), SCH_SELECTION_TOOL::RequestSelection(), TOOL_MANAGER::RunAction(), SCH_SYMBOL_T, ACTIONS::selectionClear, SCH_ACTIONS::setDNP, SCH_ACTIONS::setExcludeFromBoard, SCH_ACTIONS::setExcludeFromBOM, and SCH_ACTIONS::setExcludeFromSimulation.

Referenced by setTransitions().

SetContextMenu()

void TOOL_INTERACTIVE::SetContextMenu ( ACTION_MENU *  aMenu, CONTEXT_MENU_TRIGGER  aTrigger = CMENU_BUTTON  )

inherited

Assign a context menu and tells when it should be activated.

Parameters

aMenu	is the menu to be assigned.
aTrigger	determines conditions upon which the context menu is activated.

Definition at line 95 of file tool_interactive.cpp.

References CMENU_OFF, TOOL_BASE::m_toolMgr, TOOL_MANAGER::ScheduleContextMenu(), and ACTION_MENU::SetTool().

Referenced by SELECTION_TOOL::doSelectionMenu(), DRAWING_TOOL::DrawVia(), TOOL_MENU::ShowContextMenu(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

setTransitions()

void SCH_EDIT_TOOL::setTransitions ( )

overrideprivatevirtual

This method is meant to be overridden in order to specify handlers for events.

It is called every time tool is reset or finished.

Implements TOOL_INTERACTIVE.

Definition at line 3314 of file sch_edit_tool.cpp.

References SCH_ACTIONS::autoplaceFields, AutoplaceFields(), SCH_ACTIONS::breakWire, BreakWire(), ACTIONS::centerJustify, ChangeBodyStyle(), SCH_ACTIONS::changeSymbol, SCH_ACTIONS::changeSymbols, ChangeSymbols(), ChangeTextType(), SCH_ACTIONS::cleanupSheetPins, CleanupSheetPins(), SCH_ACTIONS::ddAppendFile, DdAppendFile(), ACTIONS::decrementPrimary, ACTIONS::decrementSecondary, ACTIONS::deleteTool, DoDelete(), ACTIONS::doDelete, EditField(), SCH_ACTIONS::editFootprint, SCH_ACTIONS::editPageNumber, EditPageNumber(), SCH_ACTIONS::editReference, SCH_ACTIONS::editTextAndGraphics, SCH_ACTIONS::editValue, GlobalEdit(), TOOL_INTERACTIVE::Go(), Increment(), ACTIONS::increment, ACTIONS::incrementPrimary, ACTIONS::incrementSecondary, InteractiveDelete(), JustifyText(), ACTIONS::leftJustify, Mirror(), SCH_ACTIONS::mirrorH, SCH_ACTIONS::mirrorV, SCH_ACTIONS::properties, Properties(), SCH_ACTIONS::repeatDrawItem, RepeatDrawItem(), ACTIONS::rightJustify, Rotate(), SCH_ACTIONS::rotateCCW, SCH_ACTIONS::rotateCW, SetAttribute(), SCH_ACTIONS::setDNP, SCH_ACTIONS::setExcludeFromBoard, SCH_ACTIONS::setExcludeFromBOM, SCH_ACTIONS::setExcludeFromSimulation, SCH_ACTIONS::showDeMorganAlternate, SCH_ACTIONS::showDeMorganStandard, SCH_ACTIONS::slice, SCH_ACTIONS::swap, Swap(), SCH_ACTIONS::toCLabel, SCH_ACTIONS::toggleDeMorgan, SCH_ACTIONS::toGLabel, SCH_ACTIONS::toHLabel, SCH_ACTIONS::toLabel, SCH_ACTIONS::toText, SCH_ACTIONS::toTextBox, SCH_ACTIONS::updateSymbol, and SCH_ACTIONS::updateSymbols.

Swap()

int SCH_EDIT_TOOL::Swap

(

const TOOL_EVENT &

aEvent

)

Definition at line 1372 of file sch_edit_tool.cpp.

References SPIN_STYLE::CCWRotationsTo(), SELECTION::CountType(), SELECTION::Front(), SCH_LABEL_BASE::GetFields(), SELECTION::GetItemsSortedBySelectionOrder(), SCH_SYMBOL::GetOrientation(), SCH_SHEET_PIN::GetParent(), EDA_ITEM::GetPosition(), SCH_SHEET_PIN::GetSide(), SCH_LABEL_BASE::GetSpinStyle(), SCH_ITEM::IsConnectable(), SELECTION::IsHover(), EDA_ITEM::IsMoving(), SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_selectionTool, TOOL_BASE::m_toolMgr, SELECTION::OnlyContains(), SCH_EDIT_FRAME::OnModify(), pin, TOOL_MANAGER::PostAction(), ACTIONS::refreshPreview, SCH_SELECTION_TOOL::RequestSelection(), TOOL_MANAGER::RunAction(), SCH_TOOL_BASE< SCH_EDIT_FRAME >::saveCopyInUndoList(), SCH_DIRECTIVE_LABEL_T, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_LABEL_T, SCH_SHEET_PIN_T, SCH_SYMBOL_T, ACTIONS::selectionClear, SCH_SYMBOL::SetOrientation(), EDA_ITEM::SetPosition(), SCH_SHEET_PIN::SetSide(), SCH_LABEL_BASE::SetSpinStyle(), SELECTION::Size(), swapFieldPositionsWithMatching(), swappableItems, SCH_EDIT_FRAME::TestDanglingEnds(), EDA_ITEM::Type(), SCH_TOOL_BASE< SCH_EDIT_FRAME >::updateItem(), and SCH_EDIT_FRAME::UpdateItem().

Referenced by setTransitions().

updateItem()

void SCH_TOOL_BASE< SCH_EDIT_FRAME >::updateItem ( EDA_ITEM *  aItem, bool  aUpdateRTree  ) const

inlineprotectedinherited

Similar to getView()->Update(), but handles items that are redrawn by their parents and updating the SCH_SCREEN's RTree.

Similar to m_frame->SaveCopyInUndoList(), but handles items that are owned by their parents.

Definition at line 110 of file sch_tool_base.h.

Wait()

TOOL_EVENT * TOOL_INTERACTIVE::Wait ( const TOOL_EVENT_LIST &  aEventList = TOOL_EVENT( TC_ANY, TA_ANY ) )

inherited

Suspend execution of the tool until an event specified in aEventList arrives.

No parameters means waiting for any event.

Definition at line 71 of file tool_interactive.cpp.

References TOOL_BASE::m_toolMgr, and TOOL_MANAGER::ScheduleWait().

Referenced by SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), SELECTION_TOOL::doSelectionMenu(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawOneBezier(), SCH_DRAWING_TOOLS::DrawRuleArea(), SCH_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_DRAWING_TOOLS::DrawTable(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawVia(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), SCH_DRAWING_TOOLS::ImportGraphics(), SYMBOL_EDITOR_DRAWING_TOOLS::ImportGraphics(), SCH_DRAWING_TOOLS::ImportSheet(), ROUTER_TOOL::InlineDrag(), EDA_3D_CONTROLLER::Main(), CVPCB_CONTROL::Main(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), SCH_POINT_EDITOR::Main(), SCH_SELECTION_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), PICKER_TOOL::Main(), ZOOM_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), PL_SELECTION_TOOL::Main(), PCB_PICKER_TOOL::Main(), PCB_SELECTION_TOOL::Main(), PCB_TEST_SELECTION_TOOL::Main(), ROUTER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), PCB_POINT_EDITOR::OnSelectionChange(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), EDIT_TOOL::pickReferencePoint(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceReferenceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), POSITION_RELATIVE_TOOL::PositionRelativeInteractively(), SCH_SELECTION_TOOL::selectMultiple(), PL_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectPoint(), PCB_SELECTION_TOOL::SelectPolyArea(), PCB_SELECTION_TOOL::SelectRectArea(), ZOOM_TOOL::selectRegion(), PCB_SELECTION_TOOL::selectTableCells(), SCH_SELECTION_TOOL::selectTableCells(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

Member Data Documentation

m_frame

SCH_EDIT_FRAME * SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame

protectedinherited

Definition at line 172 of file sch_tool_base.h.

m_isSymbolEditor

bool SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_isSymbolEditor

protectedinherited

Definition at line 175 of file sch_tool_base.h.

m_menu

std::unique_ptr<TOOL_MENU> TOOL_INTERACTIVE::m_menu

protectedinherited

The functions below are not yet implemented - their interface may change.

Definition at line 125 of file tool_interactive.h.

Referenced by SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), PCB_TOOL_BASE::doInteractiveItemPlacement(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawOneBezier(), SCH_DRAWING_TOOLS::DrawRuleArea(), SCH_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_DRAWING_TOOLS::DrawTable(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), TOOL_INTERACTIVE::GetToolMenu(), SCH_DRAWING_TOOLS::ImportGraphics(), SYMBOL_EDITOR_DRAWING_TOOLS::ImportGraphics(), SCH_DRAWING_TOOLS::ImportSheet(), EDA_3D_CONTROLLER::Init(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Init(), SCH_DESIGN_BLOCK_CONTROL::Init(), SCH_DRAWING_TOOLS::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), SCH_SELECTION_TOOL::Init(), SCH_TOOL_BASE< T >::Init(), SYMBOL_EDITOR_CONTROL::Init(), SYMBOL_EDITOR_DRAWING_TOOLS::Init(), GERBVIEW_SELECTION_TOOL::Init(), PICKER_TOOL::Init(), ZOOM_TOOL::Init(), PL_DRAWING_TOOLS::Init(), PL_EDIT_TOOL::Init(), PL_SELECTION_TOOL::Init(), ROUTER_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), DRAWING_TOOL::Init(), FOOTPRINT_EDITOR_CONTROL::Init(), PAD_TOOL::Init(), PCB_DESIGN_BLOCK_CONTROL::Init(), PCB_PICKER_TOOL::Init(), PCB_SELECTION_TOOL::Init(), PCB_TOOL_BASE::Init(), PCB_VIEWER_TOOLS::Init(), EDA_3D_CONTROLLER::Main(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), SCH_SELECTION_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), PICKER_TOOL::Main(), ZOOM_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_SELECTION_TOOL::Main(), PCB_PICKER_TOOL::Main(), PCB_SELECTION_TOOL::Main(), ROUTER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceReferenceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), TOOL_INTERACTIVE::TOOL_INTERACTIVE(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

m_pickerItem

EDA_ITEM* SCH_EDIT_TOOL::m_pickerItem

private

Definition at line 107 of file sch_edit_tool.h.

Referenced by InteractiveDelete(), and SCH_EDIT_TOOL().

m_selectionTool

SCH_SELECTION_TOOL* SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_selectionTool

protectedinherited

Definition at line 174 of file sch_tool_base.h.

m_toolId

TOOL_ID TOOL_BASE::m_toolId

protectedinherited

Unique id, assigned by a TOOL_MANAGER instance.

Definition at line 215 of file tool_base.h.

Referenced by TOOL_INTERACTIVE::Activate(), TOOL_BASE::GetId(), and TOOL_BASE::IsToolActive().

m_toolMgr

TOOL_MANAGER* TOOL_BASE::m_toolMgr

protectedinherited

Definition at line 220 of file tool_base.h.

Referenced by TOOL_INTERACTIVE::Activate(), SCH_POINT_EDITOR::addCorner(), SELECTION_TOOL::AddItemsToSel(), SELECTION_TOOL::AddItemToSel(), GROUP_TOOL::AddToGroup(), SYMBOL_EDITOR_MOVE_TOOL::AlignElements(), SCH_MOVE_TOOL::AlignToGrid(), PCB_CONTROL::AppendBoard(), SCH_EDITOR_CONTROL::AssignNetclass(), BOARD_EDITOR_CONTROL::AssignNetclass(), CVPCB_ASSOCIATION_TOOL::Associate(), TOOL_BASE::attachManager(), SCH_DRAWING_TOOLS::AutoPlaceAllSheetPins(), AutoplaceFields(), SCH_SELECTION_TOOL::autostartEvent(), BreakWire(), BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), ROUTER_TOOL::CanInlineDrag(), ChangeBodyStyle(), SCH_EDITOR_CONTROL::ChangeLineMode(), ChangeSymbols(), ChangeTextType(), EDIT_TOOL::ChangeTrackLayer(), EDIT_TOOL::ChangeTrackWidth(), CleanupSheetPins(), GERBVIEW_CONTROL::ClearAllLayers(), SCH_EDITOR_CONTROL::ClearHighlight(), BOARD_INSPECTION_TOOL::ClearHighlight(), GERBVIEW_SELECTION_TOOL::clearSelection(), PL_SELECTION_TOOL::ClearSelection(), SCH_EDIT_TABLE_TOOL::clearSelection(), PCB_EDIT_TABLE_TOOL::clearSelection(), SCH_SELECTION_TOOL::ClearSelection(), PCB_SELECTION_TOOL::ClearSelection(), SCH_EDITOR_CONTROL::CopyAsText(), SYMBOL_EDITOR_EDIT_TOOL::CopyAsText(), PAD_TOOL::copyPadSettings(), EDIT_TOOL::copyToClipboard(), ARRAY_TOOL::CreateArray(), SCH_GROUP_TOOL::createCommit(), SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), MICROWAVE_TOOL::createInductorBetween(), SCH_INSPECTION_TOOL::CrossProbe(), DRC_TOOL::CrossProbe(), COMMON_TOOLS::CursorControl(), SCH_EDITOR_CONTROL::Cut(), PCB_CONTROL::CycleLayerPresets(), DdAppendFile(), EDIT_TOOL::DeleteItems(), BOARD_INSPECTION_TOOL::DiffFootprint(), SCH_EDITOR_CONTROL::doCopy(), BOARD_EDITOR_CONTROL::doCrossProbePcbToSch(), SCH_EDITOR_CONTROL::doCrossProbeSchToPcb(), DoDelete(), SYMBOL_EDITOR_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), BOARD_INSPECTION_TOOL::doHideRatsnestNet(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), PCB_SELECTION_TOOL::doSyncSelection(), SCH_DRAWING_TOOLS::doSyncSheetsPins(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), COMMON_TOOLS::doZoomInOut(), COMMON_TOOLS::doZoomToPreset(), EDIT_TOOL::Drag(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawOneBezier(), DRAWING_TOOL::DrawRectangle(), SCH_DRAWING_TOOLS::DrawRuleArea(), SCH_LINE_WIRE_BUS_TOOL::DrawSegments(), SCH_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_DRAWING_TOOLS::DrawTable(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawZone(), BOARD_EDITOR_CONTROL::DrillOrigin(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), EDIT_TOOL::Duplicate(), EditField(), SYMBOL_EDITOR_EDIT_TOOL::editFieldProperties(), editFieldText(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), PAD_TOOL::EditPad(), EditPageNumber(), SYMBOL_EDITOR_EDIT_TOOL::editShapeProperties(), SYMBOL_EDITOR_EDIT_TOOL::editSymbolProperties(), SCH_EDIT_TABLE_TOOL::EditTable(), PCB_EDIT_TABLE_TOOL::EditTable(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), SCH_SELECTION_TOOL::EnterGroup(), PCB_SELECTION_TOOL::EnterGroup(), SCH_NAVIGATE_TOOL::EnterSheet(), PAD_TOOL::EnumeratePads(), SCH_INSPECTION_TOOL::ExcludeMarker(), KICAD_MANAGER_CONTROL::Execute(), SCH_SELECTION_TOOL::ExitGroup(), PCB_SELECTION_TOOL::ExitGroup(), PCB_SELECTION_TOOL::expandConnection(), EDA_3D_CONTROLLER::ExportImage(), ZONE_FILLER_TOOL::FillAllZones(), PCB_SELECTION_TOOL::filterSelection(), PCB_SELECTION_TOOL::FindItem(), SCH_EDITOR_CONTROL::FindSymbolAndItem(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), EDIT_TOOL::Flip(), EDIT_TOOL::GetAndPlace(), TOOL_BASE::GetManager(), TOOL_BASE::getModelInternal(), DRAWING_TOOL::getSourceZoneForAction(), PCB_EDIT_TABLE_TOOL::getTableCellSelection(), TOOL_BASE::getToolHolderInternal(), SCH_EDIT_TABLE_TOOL::getToolMgr(), PCB_EDIT_TABLE_TOOL::getToolMgr(), TOOL_BASE::getView(), TOOL_BASE::getViewControls(), TOOL_INTERACTIVE::goInternal(), PCB_SELECTION_TOOL::grabUnconnected(), COMMON_TOOLS::GridFast1(), COMMON_TOOLS::GridFast2(), COMMON_TOOLS::GridFastCycle(), SCH_EDITOR_CONTROL::GridFeedback(), COMMON_TOOLS::GridNext(), COMMON_TOOLS::GridOrigin(), PCB_CONTROL::GridPlaceOrigin(), COMMON_TOOLS::GridPreset(), COMMON_TOOLS::GridPrev(), SCH_GROUP_TOOL::Group(), PCB_GROUP_TOOL::Group(), PCB_CONTROL::HighContrastModeCycle(), GERBVIEW_CONTROL::HighlightControl(), BOARD_INSPECTION_TOOL::HighlightItem(), SCH_EDITOR_CONTROL::HighlightNet(), BOARD_INSPECTION_TOOL::HighlightNet(), BOARD_INSPECTION_TOOL::highlightNet(), SCH_EDITOR_CONTROL::HighlightNetCursor(), PL_EDIT_TOOL::ImportDrawingSheetContent(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), SCH_DRAWING_TOOLS::ImportGraphics(), SYMBOL_EDITOR_DRAWING_TOOLS::ImportGraphics(), SCH_DRAWING_TOOLS::ImportSheet(), Increment(), SYMBOL_EDITOR_EDIT_TOOL::Increment(), EDIT_TOOL::Increment(), GROUP_TOOL::Init(), Init(), SCH_TOOL_BASE< T >::Init(), SYMBOL_EDITOR_CONTROL::Init(), SYMBOL_EDITOR_EDIT_TOOL::Init(), PL_DRAWING_TOOLS::Init(), PL_EDIT_TOOL::Init(), PL_POINT_EDITOR::Init(), ROUTER_TOOL::Init(), ALIGN_DISTRIBUTE_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), BOARD_INSPECTION_TOOL::Init(), BOARD_REANNOTATE_TOOL::Init(), CONVERT_TOOL::Init(), DRAWING_TOOL::Init(), EDIT_TOOL::Init(), FOOTPRINT_CHOOSER_SELECTION_TOOL::Init(), FOOTPRINT_EDITOR_CONTROL::Init(), GENERATOR_TOOL::Init(), GLOBAL_EDIT_TOOL::Init(), PAD_TOOL::Init(), PCB_EDIT_TABLE_TOOL::Init(), PCB_POINT_EDITOR::Init(), PCB_SELECTION_TOOL::Init(), POSITION_RELATIVE_TOOL::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), BOARD_INSPECTION_TOOL::InspectDRCError(), SCH_INSPECTION_TOOL::InspectERCError(), InteractiveDelete(), SYMBOL_EDITOR_EDIT_TOOL::InteractiveDelete(), PL_EDIT_TOOL::InteractiveDelete(), PCB_CONTROL::InteractiveDelete(), EDIT_TOOL::invokeInlineRouter(), EDIT_TOOL::isRouterActive(), TOOL_BASE::IsToolActive(), JustifyText(), EDIT_TOOL::JustifyText(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), EDA_3D_CONTROLLER::Main(), CVPCB_CONTROL::Main(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), SCH_MOVE_TOOL::Main(), SCH_POINT_EDITOR::Main(), SCH_SELECTION_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_SELECTION_TOOL::Main(), PCB_PICKER_TOOL::Main(), PCB_SELECTION_TOOL::Main(), ROUTER_TOOL::MainLoop(), PCB_VIEWER_TOOLS::MeasureTool(), Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), EDIT_TOOL::Mirror(), BOARD_EDITOR_CONTROL::modifyLockSelected(), EDIT_TOOL::Move(), EDIT_TOOL::MoveExact(), SCH_EDITOR_CONTROL::NextLineMode(), SYMBOL_EDITOR_CONTROL::OnDeMorgan(), ARRAY_TOOL::onDialogClosed(), SELECTION_TOOL::onDisambiguationExpire(), COMMON_TOOLS::OnGridChanged(), PCB_POINT_EDITOR::OnSelectionChange(), SCH_EDITOR_CONTROL::Paste(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PL_EDIT_TOOL::Paste(), PAD_TOOL::pastePadProperties(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), SCH_GROUP_TOOL::PickNewMember(), PCB_GROUP_TOOL::PickNewMember(), EDIT_TOOL::pickReferencePoint(), SYMBOL_EDITOR_EDIT_TOOL::PinTable(), PCB_CONTROL::placeBoardItems(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_EDITOR_CONTROL::PlaceLinkedDesignBlock(), PCB_CONTROL::PlaceLinkedDesignBlock(), SCH_DRAWING_TOOLS::PlaceNextSymbolUnit(), DRAWING_TOOL::PlaceReferenceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), POSITION_RELATIVE_TOOL::PositionRelativeInteractively(), GERBVIEW_CONTROL::Print(), PCB_CONTROL::Print(), Properties(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), PAD_TOOL::pushPadSettings(), EDIT_TOOL::rebuildConnectivity(), ZONE_FILLER_TOOL::rebuildConnectivity(), SCH_SELECTION_TOOL::RebuildSelection(), PAD_TOOL::RecombinePad(), SCH_EDITOR_CONTROL::Redo(), SYMBOL_EDITOR_EDIT_TOOL::Redo(), GENERATOR_TOOL::RegenerateSelected(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), EDA_3D_CONTROLLER::ReloadBoard(), EDIT_TOOL::Remove(), SCH_POINT_EDITOR::removeCorner(), PCB_POINT_EDITOR::removeCorner(), GROUP_TOOL::RemoveFromGroup(), SELECTION_TOOL::RemoveItemFromSel(), SELECTION_TOOL::RemoveItemsFromSel(), FOOTPRINT_EDITOR_CONTROL::RenameFootprint(), SYMBOL_EDITOR_CONTROL::RenameSymbol(), RepeatDrawItem(), SYMBOL_EDITOR_DRAWING_TOOLS::RepeatDrawItem(), MULTICHANNEL_TOOL::repeatLayout(), PCB_SELECTION_TOOL::RequestSelection(), SCH_SELECTION_TOOL::RequestSelection(), EDA_3D_CONTROLLER::Reset(), COMMON_TOOLS::Reset(), PNS::TOOL_BASE::Reset(), GENERATOR_TOOL_PNS_PROXY::Reset(), COMMON_TOOLS::ResetLocalCoords(), TOOL_INTERACTIVE::resetTransitions(), ROUTER_TOOL::restoreSelection(), Rotate(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), EDIT_TOOL::Rotate(), ROUTER_TOOL::RouteSelected(), TOOL_INTERACTIVE::RunMainStack(), DRC_TOOL::RunTests(), SCH_EDITOR_CONTROL::SaveToLinkedDesignBlock(), PCB_CONTROL::SaveToLinkedDesignBlock(), SCH_SELECTION_TOOL::Selectable(), SCH_SELECTION_TOOL::SelectAll(), PCB_SELECTION_TOOL::SelectAll(), SCH_SELECTION_TOOL::SelectColumns(), PCB_SELECTION_TOOL::SelectColumns(), SCH_SELECTION_TOOL::SelectConnection(), PCB_TOOL_BASE::selection(), COMMON_TOOLS::SelectionTool(), GERBVIEW_SELECTION_TOOL::SelectItem(), PCB_PICKER_TOOL::SelectItemInteractively(), GERBVIEW_SELECTION_TOOL::SelectItems(), SCH_SELECTION_TOOL::selectMultiple(), PL_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::SelectMultiple(), PCB_SELECTION_TOOL::selectNet(), SCH_SELECTION_TOOL::SelectNext(), GERBVIEW_SELECTION_TOOL::selectPoint(), PCB_TEST_SELECTION_TOOL::selectPoint(), PL_SELECTION_TOOL::SelectPoint(), PCB_SELECTION_TOOL::selectPoint(), SCH_SELECTION_TOOL::selectPoint(), PCB_PICKER_TOOL::SelectPointInteractively(), PCB_SELECTION_TOOL::SelectPolyArea(), SCH_SELECTION_TOOL::SelectPrevious(), PCB_SELECTION_TOOL::SelectRectArea(), SCH_SELECTION_TOOL::SelectRows(), PCB_SELECTION_TOOL::SelectRows(), PCB_SELECTION_TOOL::selectSameSheet(), PCB_SELECTION_TOOL::selectSheetContents(), SCH_SELECTION_TOOL::SelectTable(), PCB_SELECTION_TOOL::SelectTable(), PCB_SELECTION_TOOL::selectTableCells(), SCH_SELECTION_TOOL::selectTableCells(), DRAWING_TOOL::SetAnchor(), SetAttribute(), TOOL_INTERACTIVE::SetContextMenu(), EDA_3D_CONTROLLER::SetMaterial(), PCB_SELECTION_TOOL::SetSelectPoly(), PCB_SELECTION_TOOL::SetSelectRect(), DRC_TOOL::ShowDRCDialog(), BOARD_INSPECTION_TOOL::ShowFootprintLinks(), SCH_EDITOR_CONTROL::SimProbe(), SCH_EDITOR_CONTROL::SimTune(), SCH_DRAWING_TOOLS::SingleClickPlace(), PCB_CONTROL::SnapMode(), Swap(), SYMBOL_EDITOR_EDIT_TOOL::Swap(), EDIT_TOOL::Swap(), SCH_SELECTION_TOOL::SyncSelection(), COMMON_TOOLS::ToggleCursor(), COMMON_TOOLS::ToggleCursorStyle(), EDA_3D_CONTROLLER::ToggleLayersManager(), EDA_3D_CONTROLLER::ToggleRaytracing(), EDA_3D_CONTROLLER::ToggleVisibility(), BOARD_EDITOR_CONTROL::TrackWidthDec(), BOARD_EDITOR_CONTROL::TrackWidthInc(), SCH_MOVE_TOOL::trimDanglingLines(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), SCH_EDITOR_CONTROL::Undo(), SYMBOL_EDITOR_EDIT_TOOL::Undo(), SCH_LINE_WIRE_BUS_TOOL::UnfoldBus(), GROUP_TOOL::Ungroup(), PCB_SELECTION_TOOL::unrouteSegment(), PCB_SELECTION_TOOL::unrouteSelected(), SCH_SELECTION_TOOL::UnselectAll(), PCB_SELECTION_TOOL::UnselectAll(), GERBVIEW_SELECTION_TOOL::UnselectItem(), GERBVIEW_SELECTION_TOOL::UnselectItems(), PNS::TOOL_BASE::updateEndItem(), PCB_POINT_EDITOR::updateItem(), BOARD_INSPECTION_TOOL::UpdateLocalRatsnest(), SCH_INSPECTION_TOOL::UpdateMessagePanel(), GERBVIEW_CONTROL::UpdateMessagePanel(), PL_EDITOR_CONTROL::UpdateMessagePanel(), PCB_CONTROL::UpdateMessagePanel(), EDIT_TOOL::updateModificationPoint(), MULTICHANNEL_TOOL::UpdatePickedItem(), PNS::TOOL_BASE::updateStartItem(), BOARD_EDITOR_CONTROL::ViaSizeDec(), BOARD_EDITOR_CONTROL::ViaSizeInc(), TOOL_INTERACTIVE::Wait(), BOARD_EDITOR_CONTROL::ZoneDuplicate(), ZONE_FILLER_TOOL::ZoneFill(), BOARD_EDITOR_CONTROL::ZoneMerge(), and ZONE_FILLER_TOOL::ZoneUnfill().

m_toolName

std::string TOOL_BASE::m_toolName

protectedinherited

Names are expected to obey the format application.ToolName (eg.

pcbnew.InteractiveSelection).

Definition at line 219 of file tool_base.h.

Referenced by TOOL_BASE::GetName().

m_type

TOOL_TYPE TOOL_BASE::m_type

protectedinherited

Definition at line 214 of file tool_base.h.

Referenced by TOOL_BASE::GetType().

m_view

KIGFX::SCH_VIEW* SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_view

protectedinherited

Definition at line 173 of file sch_tool_base.h.

RotatableItems

const std::vector< KICAD_T > SCH_EDIT_TOOL::RotatableItems

static

Initial value:

= {
    SCH_SHAPE_T,
    SCH_RULE_AREA_T,
    SCH_TEXT_T,
    SCH_TEXTBOX_T,
    SCH_TABLE_T,
    SCH_TABLECELL_T,    
    SCH_LABEL_T,
    SCH_GLOBAL_LABEL_T,
    SCH_GROUP_T,
    SCH_HIER_LABEL_T,
    SCH_DIRECTIVE_LABEL_T,
    SCH_FIELD_T,
    SCH_SYMBOL_T,
    SCH_SHEET_PIN_T,
    SCH_SHEET_T,
    SCH_BITMAP_T,
    SCH_BUS_BUS_ENTRY_T,
    SCH_BUS_WIRE_ENTRY_T,
    SCH_LINE_T,
    SCH_JUNCTION_T,
    SCH_NO_CONNECT_T
}

Definition at line 42 of file sch_edit_tool.h.

Referenced by AutoplaceFields(), Mirror(), and Rotate().

---

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

• sch_edit_tool.h
• eeschema/dialogs/dialog_global_edit_text_and_graphics.cpp
• sch_edit_tool.cpp