KiCad PCB EDA Suite
pl_edit_tool.cpp
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2019 CERN
5  * Copyright (C) 2019 KiCad Developers, see AUTHORS.txt for contributors.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, you may find one here:
19  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20  * or you may search the http://www.gnu.org website for the version 2 license,
21  * or you may write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24 
25 #include <tool/tool_manager.h>
26 #include <tool/picker_tool.h>
30 #include <bitmaps.h>
31 #include <confirm.h>
32 #include <eda_item.h>
33 #include <macros.h>
34 #include <view/view.h>
35 #include <math/util.h> // for KiROUND
36 
38 #include "tools/pl_actions.h"
39 #include "tools/pl_edit_tool.h"
40 #include "pl_draw_panel_gal.h"
41 #include "pl_editor_frame.h"
42 #include "pl_editor_id.h"
43 
45  TOOL_INTERACTIVE( "plEditor.InteractiveEdit" ),
46  m_frame( nullptr ),
47  m_selectionTool( nullptr ),
48  m_moveInProgress( false ),
49  m_moveOffset( 0, 0 ),
50  m_cursor( 0, 0 ),
51  m_pickerItem( nullptr )
52 {
53 }
54 
55 
57 {
58  m_frame = getEditFrame<PL_EDITOR_FRAME>();
60 
61  wxASSERT_MSG( m_selectionTool, "plEditor.InteractiveSelection tool is not available" );
62 
63  CONDITIONAL_MENU& ctxMenu = m_menu.GetMenu();
64 
65  // cancel current tool goes in main context menu at the top if present
67 
68  ctxMenu.AddSeparator( 200 );
70 
71  // Finally, add the standard zoom/grid items
73 
74  //
75  // Add editing actions to the selection tool menu
76  //
78 
80 
81  selToolMenu.AddSeparator( 250 );
86 
87  return true;
88 }
89 
90 
92 {
93  if( aReason == MODEL_RELOAD )
94  m_frame = getEditFrame<PL_EDITOR_FRAME>();
95 }
96 
97 
98 int PL_EDIT_TOOL::Main( const TOOL_EVENT& aEvent )
99 {
101 
102  VECTOR2I originalCursorPos = controls->GetCursorPosition();
103 
104  // Be sure that there is at least one item that we can move. If there's no selection try
105  // looking for the stuff under mouse cursor (i.e. Kicad old-style hover selection).
107  bool unselect = selection.IsHover();
108 
109  if( selection.Empty() || m_moveInProgress )
110  return 0;
111 
112  std::set<DS_DATA_ITEM*> unique_peers;
113 
114  for( EDA_ITEM* item : selection )
115  {
116  DS_DRAW_ITEM_BASE* drawItem = static_cast<DS_DRAW_ITEM_BASE*>( item );
117  unique_peers.insert( drawItem->GetPeer() );
118  }
119 
120  std::string tool = aEvent.GetCommandStr().get();
121  m_frame->PushTool( tool );
122  Activate();
123 
124  controls->ShowCursor( true );
125  controls->SetAutoPan( true );
126 
127  bool restore_state = false;
128  bool chain_commands = false;
129  TOOL_EVENT* evt = const_cast<TOOL_EVENT*>( &aEvent );
130  VECTOR2I prevPos;
131 
132  if( !selection.Front()->IsNew() )
134 
135  // Main loop: keep receiving events
136  do
137  {
139 
140  if( evt->IsAction( &PL_ACTIONS::move ) || evt->IsMotion() || evt->IsDrag( BUT_LEFT )
141  || evt->IsAction( &ACTIONS::refreshPreview ) )
142  {
143  //------------------------------------------------------------------------
144  // Start a move operation
145  //
146  if( !m_moveInProgress )
147  {
148  // Apply any initial offset in case we're coming from a previous command.
149  //
150  for( DS_DATA_ITEM* item : unique_peers )
151  moveItem( item, m_moveOffset );
152 
153  // Set up the starting position and move/drag offset
154  //
155  m_cursor = controls->GetCursorPosition();
156 
157  if( selection.HasReferencePoint() )
158  {
159  VECTOR2I delta = m_cursor - selection.GetReferencePoint();
160 
161  // Drag items to the current cursor position
162  for( DS_DATA_ITEM* item : unique_peers )
163  moveItem( item, delta );
164 
165  selection.SetReferencePoint( m_cursor );
166  }
167  else if( selection.Size() == 1 )
168  {
169  // Set the current cursor position to the first dragged item origin,
170  // so the movement vector can be computed later
171  updateModificationPoint( selection );
172  m_cursor = originalCursorPos;
173  }
174  else
175  {
176  updateModificationPoint( selection );
177  }
178 
179  controls->SetCursorPosition( m_cursor, false );
180 
181  prevPos = m_cursor;
182  controls->SetAutoPan( true );
183  m_moveInProgress = true;
184  }
185 
186  //------------------------------------------------------------------------
187  // Follow the mouse
188  //
189  m_cursor = controls->GetCursorPosition();
190  VECTOR2I delta( m_cursor - prevPos );
191  selection.SetReferencePoint( m_cursor );
192 
193  m_moveOffset += delta;
194  prevPos = m_cursor;
195 
196  for( DS_DATA_ITEM* item : unique_peers )
197  moveItem( item, delta );
198 
200  }
201  //------------------------------------------------------------------------
202  // Handle cancel
203  //
204  else if( evt->IsCancelInteractive() || evt->IsActivate() )
205  {
206  if( m_moveInProgress )
207  {
208  evt->SetPassEvent( false );
209  restore_state = true;
210  }
211 
212  break;
213  }
214  //------------------------------------------------------------------------
215  // Handle TOOL_ACTION special cases
216  //
217  else if( evt->Action() == TA_UNDO_REDO_PRE )
218  {
219  unselect = true;
220  break;
221  }
222  else if( evt->Category() == TC_COMMAND )
223  {
224  if( evt->IsAction( &ACTIONS::doDelete ) )
225  {
226  // Exit on a remove operation; there is no further processing for removed items.
227  break;
228  }
229  }
230  //------------------------------------------------------------------------
231  // Handle context menu
232  //
233  else if( evt->IsClick( BUT_RIGHT ) )
234  {
236  }
237  //------------------------------------------------------------------------
238  // Handle drop
239  //
240  else if( evt->IsMouseUp( BUT_LEFT ) || evt->IsClick( BUT_LEFT ) )
241  {
242  break; // Finish
243  }
244  else
245  evt->SetPassEvent();
246 
247  } while( ( evt = Wait() ) ); //Should be assignment not equality test
248 
249  controls->ForceCursorPosition( false );
250  controls->ShowCursor( false );
251  controls->SetAutoPan( false );
252 
253  if( !chain_commands )
254  m_moveOffset = { 0, 0 };
255 
256  selection.ClearReferencePoint();
257 
258  for( auto item : selection )
259  item->ClearEditFlags();
260 
261  if( unselect )
263 
264  if( restore_state )
266  else
267  m_frame->OnModify();
268 
269  m_moveInProgress = false;
270  m_frame->PopTool( tool );
271  return 0;
272 }
273 
274 
276 {
277  aItem->MoveToUi( aItem->GetStartPosUi() + (wxPoint) aDelta );
278 
279  for( DS_DRAW_ITEM_BASE* item : aItem->GetDrawItems() )
280  {
281  getView()->Update( item );
282  item->SetFlags( IS_MOVED );
283  }
284 }
285 
286 
288 {
289  if( m_moveInProgress && aSelection.HasReferencePoint() )
290  return false;
291 
292  // When there is only one item selected, the reference point is its position...
293  if( aSelection.Size() == 1 )
294  {
295  aSelection.SetReferencePoint( aSelection.Front()->GetPosition() );
296  }
297  // ...otherwise modify items with regard to the grid-snapped cursor position
298  else
299  {
301  aSelection.SetReferencePoint( m_cursor );
302  }
303 
304  return true;
305 }
306 
307 
309 {
311 
312  wxCommandEvent evt( wxEVT_NULL, ID_APPEND_DESCR_FILE );
313  m_frame->Files_io( evt );
314 
315  return 0;
316 }
317 
318 
319 int PL_EDIT_TOOL::DoDelete( const TOOL_EVENT& aEvent )
320 {
322 
323  if( selection.Size() == 0 )
324  return 0;
325 
327 
328  while( selection.Front() )
329  {
330  DS_DRAW_ITEM_BASE* drawItem = static_cast<DS_DRAW_ITEM_BASE*>( selection.Front() );
331  DS_DATA_ITEM* dataItem = drawItem->GetPeer();
333 
334  for( DS_DRAW_ITEM_BASE* item : dataItem->GetDrawItems() )
335  {
336  // Note: repeat items won't be selected but must be removed & deleted
337 
338  if( item->IsSelected() )
340 
341  getView()->Remove( item );
342  }
343 
344  delete dataItem;
345  }
346 
347  m_frame->OnModify();
348 
349  return 0;
350 }
351 
352 
353 #define HITTEST_THRESHOLD_PIXELS 5
354 
355 
357 {
358  std::string tool = aEvent.GetCommandStr().get();
360 
361  // Deactivate other tools; particularly important if another PICKER is currently running
362  Activate();
363 
364  picker->SetCursor( KICURSOR::REMOVE );
365  m_pickerItem = nullptr;
366 
367  picker->SetClickHandler(
368  [this] ( const VECTOR2D& aPosition ) -> bool
369  {
370  if( m_pickerItem )
371  {
373  selectionTool->UnbrightenItem( m_pickerItem );
374  selectionTool->AddItemToSel( m_pickerItem, true /*quiet mode*/ );
376  m_pickerItem = nullptr;
377  }
378 
379  return true;
380  } );
381 
382  picker->SetMotionHandler(
383  [this] ( const VECTOR2D& aPos )
384  {
385  int threshold = KiROUND( getView()->ToWorld( HITTEST_THRESHOLD_PIXELS ) );
386  EDA_ITEM* item = nullptr;
387 
388  for( DS_DATA_ITEM* dataItem : DS_DATA_MODEL::GetTheInstance().GetItems() )
389  {
390  for( DS_DRAW_ITEM_BASE* drawItem : dataItem->GetDrawItems() )
391  {
392  if( drawItem->HitTest( (wxPoint) aPos, threshold ) )
393  {
394  item = drawItem;
395  break;
396  }
397  }
398  }
399 
400  if( m_pickerItem != item )
401  {
403 
404  if( m_pickerItem )
405  selectionTool->UnbrightenItem( m_pickerItem );
406 
407  m_pickerItem = item;
408 
409  if( m_pickerItem )
410  selectionTool->BrightenItem( m_pickerItem );
411  }
412  } );
413 
414  picker->SetFinalizeHandler(
415  [this] ( const int& aFinalState )
416  {
417  if( m_pickerItem )
419 
420  // Wake the selection tool after exiting to ensure the cursor gets updated
422  } );
423 
424  m_toolMgr->RunAction( ACTIONS::pickerTool, true, &tool );
425 
426  return 0;
427 }
428 
429 
430 int PL_EDIT_TOOL::Undo( const TOOL_EVENT& aEvent )
431 {
433  return 0;
434 }
435 
436 
437 int PL_EDIT_TOOL::Redo( const TOOL_EVENT& aEvent )
438 {
440  return 0;
441 }
442 
443 
444 int PL_EDIT_TOOL::Cut( const TOOL_EVENT& aEvent )
445 {
446  int retVal = Copy( aEvent );
447 
448  if( retVal == 0 )
449  retVal = DoDelete( aEvent );
450 
451  return retVal;
452 }
453 
454 
455 int PL_EDIT_TOOL::Copy( const TOOL_EVENT& aEvent )
456 {
458  std::vector<DS_DATA_ITEM*> items;
460  wxString sexpr;
461 
462  if( selection.GetSize() == 0 )
463  return 0;
464 
465  for( EDA_ITEM* item : selection.GetItems() )
466  items.push_back( static_cast<DS_DRAW_ITEM_BASE*>( item )->GetPeer() );
467 
468  try
469  {
470  model.SaveInString( items, sexpr );
471  }
472  catch( const IO_ERROR& ioe )
473  {
474  wxMessageBox( ioe.What(), _( "Error writing objects to clipboard" ) );
475  }
476 
477  if( m_toolMgr->SaveClipboard( TO_UTF8( sexpr ) ) )
478  return 0;
479  else
480  return -1;
481 }
482 
483 
484 int PL_EDIT_TOOL::Paste( const TOOL_EVENT& aEvent )
485 {
486  PL_SELECTION& selection = m_selectionTool->GetSelection();
488  std::string sexpr = m_toolMgr->GetClipboardUTF8();
489 
491 
492  model.SetPageLayout( sexpr.c_str(), true, wxT( "clipboard" ) );
493 
494  // Build out draw items and select the first of each data item
495  for( DS_DATA_ITEM* dataItem : model.GetItems() )
496  {
497  if( dataItem->GetDrawItems().empty() )
498  {
499  dataItem->SyncDrawItems( nullptr, getView() );
500  dataItem->GetDrawItems().front()->SetSelected();
501  }
502  }
503 
505 
506  if( !selection.Empty() )
507  {
508  selection.SetReferencePoint( selection.GetTopLeftItem()->GetPosition() );
510  }
511 
512  return 0;
513 }
514 
515 
517 {
518  Go( &PL_EDIT_TOOL::Main, PL_ACTIONS::move.MakeEvent() );
519 
521 
522  Go( &PL_EDIT_TOOL::Undo, ACTIONS::undo.MakeEvent() );
523  Go( &PL_EDIT_TOOL::Redo, ACTIONS::redo.MakeEvent() );
524 
525  Go( &PL_EDIT_TOOL::Cut, ACTIONS::cut.MakeEvent() );
526  Go( &PL_EDIT_TOOL::Copy, ACTIONS::copy.MakeEvent() );
527  Go( &PL_EDIT_TOOL::Paste, ACTIONS::paste.MakeEvent() );
529 
531 }
virtual void ShowCursor(bool aEnabled)
Enable or disables display of cursor.
static bool ShowAlways(const SELECTION &aSelection)
The default condition function (always returns true).
void AddStandardSubMenus(TOOL_MENU &aMenu)
Construct a "basic" menu for a tool, containing only items that apply to all tools (e....
TOOL_MENU m_menu
The functions below are not yet implemented - their interface may change.
Handle the graphic items list to draw/plot the frame and title block.
Definition: ds_data_model.h:38
void RebuildSelection()
Rebuild the selection from the flags in the view items.
int RemoveItemFromSel(const TOOL_EVENT &aEvent)
bool IsHover() const
Definition: selection.h:72
void SetCurrentCursor(KICURSOR aCursor)
Set the current cursor shape for this panel.
PL_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
void SetPassEvent(bool aPass=true)
Returns if it this event has a valid position (true for mouse events and context-menu or hotkey-based...
Definition: tool_event.h:257
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.
bool updateModificationPoint(PL_SELECTION &aSelection)
Set up handlers for various events.
Model changes (required full reload)
Definition: tool_base.h:81
int DeleteItemCursor(const TOOL_EVENT &aEvent)
This file is part of the common library.
static TOOL_ACTION doDelete
Definition: actions.h:75
int Paste(const TOOL_EVENT &aEvent)
PL_SELECTION_TOOL * m_selectionTool
Flag determining if anything is being dragged right now.
Definition: pl_edit_tool.h:80
TOOL_ACTIONS Action() const
These give a tool a method of informing the TOOL_MANAGER that a particular event should be passed on ...
Definition: tool_event.h:251
bool IsClick(int aButtonMask=BUT_ANY) const
Definition: tool_event.cpp:181
void BrightenItem(EDA_ITEM *aItem)
int Cut(const TOOL_EVENT &aEvent)
CONDITIONAL_MENU & GetMenu()
Definition: tool_menu.cpp:46
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:215
static TOOL_ACTION cancelInteractive
Definition: actions.h:65
virtual void PushTool(const std::string &actionName)
NB: the definition of "tool" is different at the user level.
virtual void Remove(VIEW_ITEM *aItem)
Remove a VIEW_ITEM from the view.
Definition: view.cpp:352
int ClearSelection(const TOOL_EVENT &aEvent)
TOOL_MENU & GetToolMenu()
bool IsMotion() const
Definition: tool_event.h:316
void moveItem(DS_DATA_ITEM *aItem, VECTOR2I aDelta)
Return the right modification point (e.g.
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Run the specified action.
Definition: tool_manager.h:141
VECTOR2I m_cursor
Definition: pl_edit_tool.h:90
void GetLayoutFromRedoList()
Redo the last edit:
std::vector< DS_DATA_ITEM * > & GetItems()
static TOOL_ACTION move
Definition: pl_actions.h:69
TOOL_EVENT_CATEGORY Category() const
Returns more specific information about the type of an event.
Definition: tool_event.h:248
virtual void SetCursorPosition(const VECTOR2D &aPosition, bool aWarpView=true, bool aTriggeredByArrows=false, long aArrowCommand=0)=0
Move cursor to the requested position expressed in world coordinates.
void SetFinalizeHandler(FINALIZE_HANDLER aHandler)
Set a handler for the finalize event.
Definition: picker_tool.h:102
virtual wxPoint GetPosition() const
Definition: eda_item.h:302
void setTransitions() override
This method is meant to be overridden in order to specify handlers for events.
static bool NotEmpty(const SELECTION &aSelection)
Test if there are any items selected.
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).
int AddItemToSel(const TOOL_EVENT &aEvent)
PL_SELECTION & GetSelection()
Return the set of currently selected items.
static const TOOL_EVENT SelectedItemsModified
Selected items were moved, this can be very high frequency on the canvas, use with care.
Definition: actions.h:206
bool IsCancelInteractive() const
Indicate the event should restart/end an ongoing interactive tool's event loop (eg esc key,...
Definition: tool_event.cpp:193
bool Init() override
Init() is called once upon a registration of the tool.
This file contains miscellaneous commonly used macros and functions.
EDA_ITEM * m_pickerItem
Definition: pl_edit_tool.h:92
bool IsAction(const TOOL_ACTION *aAction) const
Test if the event contains an action issued upon activation of the given TOOL_ACTION.
Definition: tool_event.cpp:70
static TOOL_ACTION pickerTool
Definition: actions.h:158
void OnModify()
Must be called after a change in order to set the "modify" flag.
int Main(const TOOL_EVENT &aEvent)
The "move" event loop.
Base class to handle basic graphic items.
Definition: ds_draw_item.h:58
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:96
static TOOL_ACTION selectionActivate
Activation of the selection tool.
Definition: pl_actions.h:44
static TOOL_ACTION copy
Definition: actions.h:70
void SetReferencePoint(const VECTOR2I &aP)
Definition: selection.h:264
EDA_ITEM * GetTopLeftItem(bool onlyModules=false) const override
bool IsDrag(int aButtonMask=BUT_ANY) const
Definition: tool_event.h:306
static DS_DATA_MODEL & GetTheInstance()
static function: returns the instance of DS_DATA_MODEL used in the application
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:29
virtual void PopTool(const std::string &actionName)
VECTOR2I m_moveOffset
Last cursor position (needed for getModificationPoint() to avoid changes of edit reference point).
Definition: pl_edit_tool.h:86
std::string GetClipboardUTF8() const
Return the information currently stored in the system clipboard.
Generic, UI-independent tool event.
Definition: tool_event.h:173
int Undo(const TOOL_EVENT &aEvent)
void SetMotionHandler(MOTION_HANDLER aHandler)
Set a handler for mouse motion.
Definition: picker_tool.h:82
PL_EDITOR_FRAME * m_frame
Definition: pl_edit_tool.h:79
const std::deque< EDA_ITEM * > GetItems() const
Definition: selection.h:133
static TOOL_ACTION cut
Definition: actions.h:69
An interface for classes handling user events controlling the view behavior such as zooming,...
const std::vector< DS_DRAW_ITEM_BASE * > & GetDrawItems() const
Definition: ds_data_item.h:111
virtual void ForceCursorPosition(bool aEnabled, const VECTOR2D &aPosition=VECTOR2D(0, 0))
Place the cursor immediately at a given point.
int Copy(const TOOL_EVENT &aEvent)
bool m_moveInProgress
Used for chaining commands.
Definition: pl_edit_tool.h:83
bool IsMouseUp(int aButtonMask=BUT_ANY) const
Definition: tool_event.h:311
#define IS_MOVED
Item being moved.
Definition: eda_item.h:106
void Reset(RESET_REASON aReason) override
Bring the tool to a known, initial state.
void SaveInString(wxString &aOutputString)
Save the description in a buffer.
KIGFX::VIEW * getView() const
Returns the instance of #VIEW object used in the application.
Definition: tool_base.cpp:36
virtual void SetAutoPan(bool aEnabled)
Turn on/off auto panning (this feature is used when there is a tool active (eg.
bool Empty() const
Checks if there is anything selected.
Definition: selection.h:122
static TOOL_ACTION clearSelection
Clear the current selection.
Definition: pl_actions.h:47
void SetCursor(KICURSOR aCursor)
Definition: picker_tool.h:62
#define HITTEST_THRESHOLD_PIXELS
void AddSeparator(int aOrder=ANY_ORDER)
Add a separator to the menu.
virtual unsigned int GetSize() const override
Return the number of stored items.
Definition: selection.h:101
void SetClickHandler(CLICK_HANDLER aHandler)
Set a handler for mouse click event.
Definition: picker_tool.h:71
OPT< std::string > GetCommandStr() const
Definition: tool_event.h:476
static TOOL_ACTION redo
Definition: actions.h:68
void SetPageLayout(const char *aPageLayout, bool aAppend=false, const wxString &aSource=wxT("Sexpr_string"))
Populate the list from a S expr description stored in a string.
int DoDelete(const TOOL_EVENT &aEvent)
Delete the selected items, or the item under the cursor.
bool SaveClipboard(const std::string &aTextUTF8)
Store information to the system clipboard.
DS_DATA_ITEM * GetPeer() const
Definition: ds_draw_item.h:63
bool IsActivate() const
Definition: tool_event.h:331
bool HasReferencePoint() const
Definition: selection.h:254
int ImportWorksheetContent(const TOOL_EVENT &aEvent)
Drawing sheet structure type definitions.
Definition: ds_data_item.h:95
#define _(s)
Definition: 3d_actions.cpp:33
void UnbrightenItem(EDA_ITEM *aItem)
int Size() const
Returns the number of selected parts.
Definition: selection.h:128
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:68
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:150
static TOOL_ACTION appendImportedWorksheet
Definition: pl_actions.h:66
RESET_REASON
Determine the reason of reset for a tool.
Definition: tool_base.h:78
void SaveCopyInUndoList()
Save a copy of the description (in a S expr string) for Undo/redo commands.
void Activate()
Run the tool.
void MoveToUi(wxPoint aPosition)
Move item to a new position.
static TOOL_ACTION deleteTool
Definition: actions.h:76
static TOOL_ACTION undo
Definition: actions.h:67
void Remove(DS_DATA_ITEM *aItem)
KIGFX::VIEW_CONTROLS * getViewControls() const
Return the instance of VIEW_CONTROLS object used in the application.
Definition: tool_base.cpp:42
void RollbackFromUndo()
Apply the last command in Undo List without stacking a Redo.
void PostEvent(const TOOL_EVENT &aEvent)
Put an event to the event queue to be processed at the end of event processing cycle.
Definition: tool_manager.h:267
void AddItem(const TOOL_ACTION &aAction, const SELECTION_CONDITION &aCondition, int aOrder=ANY_ORDER)
Add a menu entry to run a TOOL_ACTION on selected items.
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:75
void ShowContextMenu(SELECTION &aSelection)
Helper function to set and immediately show a CONDITIONAL_MENU in concert with the given SELECTION.
Definition: tool_menu.cpp:59
void GetLayoutFromUndoList()
Undo the last edit:
static TOOL_ACTION paste
Definition: actions.h:71
PL_SELECTION & RequestSelection()
Return either an existing selection (filtered), or the selection at the current cursor if the existin...
static TOOL_ACTION refreshPreview
Definition: actions.h:109
VECTOR2D GetCursorPosition() const
Return the current cursor position in world coordinates.
EDA_ITEM * Front() const
Definition: selection.h:203
virtual void Update(const VIEW_ITEM *aItem, int aUpdateFlags) const
For dynamic VIEWs, inform the associated VIEW that the graphical representation of this item has chan...
Definition: view.cpp:1503
const wxPoint GetStartPosUi(int ii=0) const
int Redo(const TOOL_EVENT &aEvent)
void Files_io(wxCommandEvent &event)