KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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-2023 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 <wx/log.h>
26#include <fmt/format.h>
27
28#include <tool/tool_manager.h>
29#include <tool/picker_tool.h>
33#include <bitmaps.h>
34#include <confirm.h>
35#include <eda_item.h>
36#include <macros.h>
37#include <string_utils.h>
38#include <view/view.h>
39#include <math/util.h> // for KiROUND
40
42#include "tools/pl_actions.h"
43#include "tools/pl_edit_tool.h"
44#include "pl_draw_panel_gal.h"
45#include "pl_editor_frame.h"
46#include "pl_editor_id.h"
47
49 TOOL_INTERACTIVE( "plEditor.InteractiveEdit" ),
50 m_frame( nullptr ),
51 m_selectionTool( nullptr ),
52 m_moveInProgress( false ),
53 m_moveOffset( 0, 0 ),
54 m_cursor( 0, 0 ),
55 m_pickerItem( nullptr )
56{
57}
58
59
61{
62 m_frame = getEditFrame<PL_EDITOR_FRAME>();
64
65 wxASSERT_MSG( m_selectionTool, "plEditor.InteractiveSelection tool is not available" );
66
67 CONDITIONAL_MENU& ctxMenu = m_menu.GetMenu();
68
69 // cancel current tool goes in main context menu at the top if present
71
72 ctxMenu.AddSeparator( 200 );
74
75 // Finally, add the standard zoom/grid items
77
78 //
79 // Add editing actions to the selection tool menu
80 //
82
84
85 selToolMenu.AddSeparator( 250 );
90
91 return true;
92}
93
94
96{
97 if( aReason == MODEL_RELOAD )
98 m_frame = getEditFrame<PL_EDITOR_FRAME>();
99}
100
101
102int PL_EDIT_TOOL::Main( const TOOL_EVENT& aEvent )
103{
105
106 VECTOR2I originalCursorPos = controls->GetCursorPosition();
107
108 // Be sure that there is at least one item that we can move. If there's no selection try
109 // looking for the stuff under mouse cursor (i.e. Kicad old-style hover selection).
111 bool unselect = selection.IsHover();
112
113 if( selection.Empty() || m_moveInProgress )
114 return 0;
115
116 std::set<DS_DATA_ITEM*> unique_peers;
117
118 for( EDA_ITEM* item : selection )
119 {
120 DS_DRAW_ITEM_BASE* drawItem = static_cast<DS_DRAW_ITEM_BASE*>( item );
121 unique_peers.insert( drawItem->GetPeer() );
122 }
123
124 m_frame->PushTool( aEvent );
125
126 Activate();
127 // Must be done after Activate() so that it gets set into the correct context
128 controls->ShowCursor( true );
129 controls->SetAutoPan( true );
130
131 bool restore_state = false;
132 bool chain_commands = false;
133 TOOL_EVENT copy = aEvent;
134 TOOL_EVENT* evt = &copy;
135 VECTOR2I prevPos;
136
137 if( !selection.Front()->IsNew() )
138 {
139 try
140 {
142 }
143 catch( const fmt::v10::format_error& exc )
144 {
145 wxLogWarning( wxS( "Exception \"%s\" serializing string ocurred." ),
146 exc.what() );
147 return 1;
148 }
149 }
150
151 // Main loop: keep receiving events
152 do
153 {
154 m_frame->GetCanvas()->SetCurrentCursor( KICURSOR::MOVING );
155
156 if( evt->IsAction( &PL_ACTIONS::move ) || evt->IsMotion() || evt->IsDrag( BUT_LEFT )
158 {
159 //------------------------------------------------------------------------
160 // Start a move operation
161 //
162 if( !m_moveInProgress )
163 {
164 // Apply any initial offset in case we're coming from a previous command.
165 //
166 for( DS_DATA_ITEM* item : unique_peers )
167 moveItem( item, m_moveOffset );
168
169 // Set up the starting position and move/drag offset
170 //
171 m_cursor = controls->GetCursorPosition();
172
173 if( selection.HasReferencePoint() )
174 {
176
177 // Drag items to the current cursor position
178 for( DS_DATA_ITEM* item : unique_peers )
179 moveItem( item, delta );
180
181 selection.SetReferencePoint( m_cursor );
182 }
183 else if( selection.Size() == 1 )
184 {
185 // Set the current cursor position to the first dragged item origin,
186 // so the movement vector can be computed later
187 updateModificationPoint( selection );
188 m_cursor = originalCursorPos;
189 }
190 else
191 {
192 updateModificationPoint( selection );
193 }
194
195 controls->SetCursorPosition( m_cursor, false );
196
197 prevPos = m_cursor;
198 controls->SetAutoPan( true );
199 m_moveInProgress = true;
200 }
201
202 //------------------------------------------------------------------------
203 // Follow the mouse
204 //
205 m_cursor = controls->GetCursorPosition();
206 VECTOR2I delta( m_cursor - prevPos );
207 selection.SetReferencePoint( m_cursor );
208
210 prevPos = m_cursor;
211
212 for( DS_DATA_ITEM* item : unique_peers )
213 moveItem( item, delta );
214
216 }
217 //------------------------------------------------------------------------
218 // Handle cancel
219 //
220 else if( evt->IsCancelInteractive() || evt->IsActivate() )
221 {
222 if( evt->IsCancelInteractive() )
224
225 if( m_moveInProgress )
226 {
227 if( evt->IsActivate() )
228 {
229 // Allowing other tools to activate during a move runs the risk of race
230 // conditions in which we try to spool up both event loops at once.
231
232 m_frame->ShowInfoBarMsg( _( "Press <ESC> to cancel move." ) );
233
234 evt->SetPassEvent( false );
235 continue;
236 }
237
238 evt->SetPassEvent( false );
239 restore_state = true;
240 }
241
242 break;
243 }
244 //------------------------------------------------------------------------
245 // Handle TOOL_ACTION special cases
246 //
247 else if( evt->Action() == TA_UNDO_REDO_PRE )
248 {
249 unselect = true;
250 break;
251 }
252 else if( evt->IsAction( &ACTIONS::doDelete ) )
253 {
254 evt->SetPassEvent();
255 // Exit on a delete; there will no longer be anything to drag.
256 break;
257 }
258 else if( evt->IsAction( &ACTIONS::duplicate ) )
259 {
260 if( selection.Front()->IsNew() )
261 {
262 // This doesn't really make sense; we'll just end up dragging a stack of
263 // objects so we ignore the duplicate and just carry on.
264 continue;
265 }
266
267 // Move original back and exit. The duplicate will run in its own loop.
268 restore_state = true;
269 unselect = false;
270 chain_commands = true;
271 break;
272 }
273 //------------------------------------------------------------------------
274 // Handle context menu
275 //
276 else if( evt->IsClick( BUT_RIGHT ) )
277 {
279 }
280 //------------------------------------------------------------------------
281 // Handle drop
282 //
283 else if( evt->IsMouseUp( BUT_LEFT ) || evt->IsClick( BUT_LEFT ) )
284 {
285 break; // Finish
286 }
287 else
288 {
289 evt->SetPassEvent();
290 }
291
292 controls->SetAutoPan( m_moveInProgress );
293
294 } while( ( evt = Wait() ) ); //Should be assignment not equality test
295
296 controls->ForceCursorPosition( false );
297 controls->ShowCursor( false );
298 controls->SetAutoPan( false );
299
300 if( !chain_commands )
301 m_moveOffset = { 0, 0 };
302
303 selection.ClearReferencePoint();
304
305 for( EDA_ITEM* item : selection )
306 item->ClearEditFlags();
307
308 if( restore_state )
310 else
311 m_frame->OnModify();
312
313 if( unselect )
315 else
317
318 m_moveInProgress = false;
319 m_frame->PopTool( aEvent );
320 return 0;
321}
322
323
324void PL_EDIT_TOOL::moveItem( DS_DATA_ITEM* aItem, const VECTOR2I& aDelta )
325{
326 aItem->MoveToIU( aItem->GetStartPosIU() + aDelta );
327
328 for( DS_DRAW_ITEM_BASE* item : aItem->GetDrawItems() )
329 {
330 getView()->Update( item );
331 item->SetFlags( IS_MOVING );
332 }
333}
334
335
337{
338 if( m_moveInProgress && aSelection.HasReferencePoint() )
339 return false;
340
341 // When there is only one item selected, the reference point is its position...
342 if( aSelection.Size() == 1 )
343 {
344 aSelection.SetReferencePoint( aSelection.Front()->GetPosition() );
345 }
346 // ...otherwise modify items with regard to the grid-snapped cursor position
347 else
348 {
350 aSelection.SetReferencePoint( m_cursor );
351 }
352
353 return true;
354}
355
356
358{
360
361 wxCommandEvent evt( wxEVT_NULL, ID_APPEND_DESCR_FILE );
362 m_frame->Files_io( evt );
363
364 return 0;
365}
366
367
369{
371
372 if( selection.Size() == 0 )
373 return 0;
374
375
376 // Do not delete an item if it is currently a new item being created to avoid a crash
377 // In this case the selection contains only one item.
378 DS_DRAW_ITEM_BASE* currItem = static_cast<DS_DRAW_ITEM_BASE*>( selection.Front() );
379
380 if( currItem->GetFlags() & ( IS_NEW ) )
381 return 0;
382
384
385 while( selection.Front() )
386 {
387 DS_DRAW_ITEM_BASE* drawItem = static_cast<DS_DRAW_ITEM_BASE*>( selection.Front() );
388 DS_DATA_ITEM* dataItem = drawItem->GetPeer();
390
391 for( DS_DRAW_ITEM_BASE* item : dataItem->GetDrawItems() )
392 {
393 // Note: repeat items won't be selected but must be removed & deleted
394
395 if( item->IsSelected() )
397
398 getView()->Remove( item );
399 }
400
401 delete dataItem;
402 }
403
404 m_frame->OnModify();
405
406 return 0;
407}
408
409
410#define HITTEST_THRESHOLD_PIXELS 5
411
412
414{
416
417 // Deactivate other tools; particularly important if another PICKER is currently running
418 Activate();
419
420 picker->SetCursor( KICURSOR::REMOVE );
421 m_pickerItem = nullptr;
422
423 picker->SetClickHandler(
424 [this] ( const VECTOR2D& aPosition ) -> bool
425 {
426 if( m_pickerItem )
427 {
429 selectionTool->UnbrightenItem( m_pickerItem );
430 selectionTool->AddItemToSel( m_pickerItem, true /*quiet mode*/ );
432 m_pickerItem = nullptr;
433 }
434
435 return true;
436 } );
437
438 picker->SetMotionHandler(
439 [this] ( const VECTOR2D& aPos )
440 {
441 int threshold = KiROUND( getView()->ToWorld( HITTEST_THRESHOLD_PIXELS ) );
442 EDA_ITEM* item = nullptr;
443
444 for( DS_DATA_ITEM* dataItem : DS_DATA_MODEL::GetTheInstance().GetItems() )
445 {
446 for( DS_DRAW_ITEM_BASE* drawItem : dataItem->GetDrawItems() )
447 {
448 if( drawItem->HitTest( aPos, threshold ) )
449 {
450 item = drawItem;
451 break;
452 }
453 }
454 }
455
456 if( m_pickerItem != item )
457 {
459
460 if( m_pickerItem )
461 selectionTool->UnbrightenItem( m_pickerItem );
462
463 m_pickerItem = item;
464
465 if( m_pickerItem )
466 selectionTool->BrightenItem( m_pickerItem );
467 }
468 } );
469
470 picker->SetFinalizeHandler(
471 [this] ( const int& aFinalState )
472 {
473 if( m_pickerItem )
474 m_toolMgr->GetTool<PL_SELECTION_TOOL>()->UnbrightenItem( m_pickerItem );
475
476 // Wake the selection tool after exiting to ensure the cursor gets updated
478 } );
479
481
482 return 0;
483}
484
485
486int PL_EDIT_TOOL::Undo( const TOOL_EVENT& aEvent )
487{
489 return 0;
490}
491
492
493int PL_EDIT_TOOL::Redo( const TOOL_EVENT& aEvent )
494{
496 return 0;
497}
498
499
500int PL_EDIT_TOOL::Cut( const TOOL_EVENT& aEvent )
501{
502 int retVal = Copy( aEvent );
503
504 if( retVal == 0 )
505 retVal = DoDelete( aEvent );
506
507 return retVal;
508}
509
510
511int PL_EDIT_TOOL::Copy( const TOOL_EVENT& aEvent )
512{
514 std::vector<DS_DATA_ITEM*> items;
516 wxString sexpr;
517
518 if( selection.GetSize() == 0 )
519 return 0;
520
521 for( EDA_ITEM* item : selection.GetItems() )
522 items.push_back( static_cast<DS_DRAW_ITEM_BASE*>( item )->GetPeer() );
523
524 try
525 {
526 model.SaveInString( items, &sexpr );
527 }
528 catch( const IO_ERROR& ioe )
529 {
530 wxMessageBox( ioe.What(), _( "Error writing objects to clipboard" ) );
531 }
532
533 if( m_toolMgr->SaveClipboard( TO_UTF8( sexpr ) ) )
534 return 0;
535 else
536 return -1;
537}
538
539
540int PL_EDIT_TOOL::Paste( const TOOL_EVENT& aEvent )
541{
544 std::string sexpr = m_toolMgr->GetClipboardUTF8();
545
547
548 model.SetPageLayout( sexpr.c_str(), true, wxT( "clipboard" ) );
549
550 // Build out draw items and select the first of each data item
551 for( DS_DATA_ITEM* dataItem : model.GetItems() )
552 {
553 if( dataItem->GetDrawItems().empty() )
554 {
555 dataItem->SyncDrawItems( nullptr, getView() );
556 dataItem->GetDrawItems().front()->SetSelected();
557 }
558 }
559
561
562 if( !selection.Empty() )
563 {
564 selection.SetReferencePoint( selection.GetTopLeftItem()->GetPosition() );
566 }
567
568 return 0;
569}
570
571
573{
574 Go( &PL_EDIT_TOOL::Main, PL_ACTIONS::move.MakeEvent() );
575
577
578 Go( &PL_EDIT_TOOL::Undo, ACTIONS::undo.MakeEvent() );
579 Go( &PL_EDIT_TOOL::Redo, ACTIONS::redo.MakeEvent() );
580
581 Go( &PL_EDIT_TOOL::Cut, ACTIONS::cut.MakeEvent() );
582 Go( &PL_EDIT_TOOL::Copy, ACTIONS::copy.MakeEvent() );
583 Go( &PL_EDIT_TOOL::Paste, ACTIONS::paste.MakeEvent() );
585
587}
static TOOL_ACTION paste
Definition: actions.h:70
static TOOL_ACTION cancelInteractive
Definition: actions.h:63
static TOOL_ACTION copy
Definition: actions.h:69
static TOOL_ACTION pickerTool
Definition: actions.h:185
static TOOL_ACTION undo
Definition: actions.h:66
static TOOL_ACTION duplicate
Definition: actions.h:74
static TOOL_ACTION doDelete
Definition: actions.h:75
static TOOL_ACTION redo
Definition: actions.h:67
static TOOL_ACTION deleteTool
Definition: actions.h:76
static TOOL_ACTION cut
Definition: actions.h:68
static TOOL_ACTION refreshPreview
Definition: actions.h:133
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.
void AddSeparator(int aOrder=ANY_ORDER)
Add a separator to the menu.
Drawing sheet structure type definitions.
Definition: ds_data_item.h:96
void MoveToIU(const VECTOR2I &aPosition)
Move item to a new position.
const VECTOR2I GetStartPosIU(int ii=0) const
const std::vector< DS_DRAW_ITEM_BASE * > & GetDrawItems() const
Definition: ds_data_item.h:110
Handle the graphic items list to draw/plot the frame and title block.
Definition: ds_data_model.h:39
static DS_DATA_MODEL & GetTheInstance()
static function: returns the instance of DS_DATA_MODEL used in the application
void SaveInString(wxString *aOutputString)
Save the description in a buffer.
void Remove(DS_DATA_ITEM *aItem)
std::vector< DS_DATA_ITEM * > & GetItems()
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.
Base class to handle basic graphic items.
Definition: ds_draw_item.h:59
DS_DATA_ITEM * GetPeer() const
Definition: ds_draw_item.h:63
void ShowInfoBarMsg(const wxString &aMsg, bool aShowCloseButton=false)
Show the WX_INFOBAR displayed on the top of the canvas with a message and an info icon on the left of...
WX_INFOBAR * GetInfoBar()
void AddStandardSubMenus(TOOL_MENU &aMenu)
Construct a "basic" menu for a tool, containing only items that apply to all tools (e....
void SetCurrentCursor(KICURSOR aCursor)
Set the current cursor shape for this panel.
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:85
virtual VECTOR2I GetPosition() const
Definition: eda_item.h:239
EDA_ITEM_FLAGS GetFlags() const
Definition: eda_item.h:126
bool IsNew() const
Definition: eda_item.h:103
static const TOOL_EVENT SelectedEvent
Definition: actions.h:253
static const TOOL_EVENT SelectedItemsMoved
Used to inform tools that the selection should temporarily be non-editable.
Definition: actions.h:263
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:77
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:30
An interface for classes handling user events controlling the view behavior such as zooming,...
virtual void ForceCursorPosition(bool aEnabled, const VECTOR2D &aPosition=VECTOR2D(0, 0))
Place the cursor immediately at a given point.
virtual void ShowCursor(bool aEnabled)
Enable or disables display of cursor.
VECTOR2D GetCursorPosition() const
Return the current cursor position in world coordinates.
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.
virtual void SetAutoPan(bool aEnabled)
Turn on/off auto panning (this feature is used when there is a tool active (eg.
virtual void Remove(VIEW_ITEM *aItem)
Remove a VIEW_ITEM from the view.
Definition: view.cpp:354
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:1636
void SetMotionHandler(MOTION_HANDLER aHandler)
Set a handler for mouse motion.
Definition: picker_tool.h:83
void SetClickHandler(CLICK_HANDLER aHandler)
Set a handler for mouse click event.
Definition: picker_tool.h:72
void SetCursor(KICURSOR aCursor)
Definition: picker_tool.h:63
void SetFinalizeHandler(FINALIZE_HANDLER aHandler)
Set a handler for the finalize event.
Definition: picker_tool.h:103
static TOOL_ACTION clearSelection
Clear the current selection.
Definition: pl_actions.h:43
static TOOL_ACTION selectionActivate
Activation of the selection tool.
Definition: pl_actions.h:40
static TOOL_ACTION appendImportedDrawingSheet
Definition: pl_actions.h:62
static TOOL_ACTION move
Definition: pl_actions.h:65
void OnModify() override
Must be called after a change in order to set the "modify" flag.
void Files_io(wxCommandEvent &event)
void GetLayoutFromRedoList()
Redo the last edit:
void GetLayoutFromUndoList()
Undo the last edit:
void RollbackFromUndo()
Apply the last command in Undo List without stacking a Redo.
void SaveCopyInUndoList()
Save a copy of the description (in a S expr string) for Undo/redo commands.
PL_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
bool Init() override
Init() is called once upon a registration of the tool.
int Redo(const TOOL_EVENT &aEvent)
int DoDelete(const TOOL_EVENT &aEvent)
Delete the selected items, or the item under the cursor.
int ImportDrawingSheetContent(const TOOL_EVENT &aEvent)
bool m_moveInProgress
Used for chaining commands.
Definition: pl_edit_tool.h:83
int Main(const TOOL_EVENT &aEvent)
The "move" event loop.
int Cut(const TOOL_EVENT &aEvent)
bool updateModificationPoint(PL_SELECTION &aSelection)
Set up handlers for various events.
PL_SELECTION_TOOL * m_selectionTool
Flag determining if anything is being dragged right now.
Definition: pl_edit_tool.h:80
void moveItem(DS_DATA_ITEM *aItem, const VECTOR2I &aDelta)
Return the right modification point (e.g.
int InteractiveDelete(const TOOL_EVENT &aEvent)
VECTOR2I m_moveOffset
Last cursor position (needed for getModificationPoint() to avoid changes of edit reference point).
Definition: pl_edit_tool.h:86
VECTOR2I m_cursor
Definition: pl_edit_tool.h:90
void Reset(RESET_REASON aReason) override
Bring the tool to a known, initial state.
int Paste(const TOOL_EVENT &aEvent)
void setTransitions() override
This method is meant to be overridden in order to specify handlers for events.
EDA_ITEM * m_pickerItem
Definition: pl_edit_tool.h:92
int Undo(const TOOL_EVENT &aEvent)
PL_EDITOR_FRAME * m_frame
Definition: pl_edit_tool.h:79
int Copy(const TOOL_EVENT &aEvent)
int ClearSelection(const TOOL_EVENT &aEvent)
PL_SELECTION & GetSelection()
Return the set of currently selected items.
PL_SELECTION & RequestSelection()
Return either an existing selection (filtered), or the selection at the current cursor if the existin...
void RebuildSelection()
Rebuild the selection from the flags in the view items.
EDA_ITEM * GetTopLeftItem(bool onlyModules=false) const override
static bool NotEmpty(const SELECTION &aSelection)
Test if there are any items selected.
static bool ShowAlways(const SELECTION &aSelection)
The default condition function (always returns true).
int RemoveItemFromSel(const TOOL_EVENT &aEvent)
void BrightenItem(EDA_ITEM *aItem)
int AddItemToSel(const TOOL_EVENT &aEvent)
void UnbrightenItem(EDA_ITEM *aItem)
const std::deque< EDA_ITEM * > GetItems() const
Definition: selection.h:120
VECTOR2I GetReferencePoint() const
Definition: selection.cpp:170
bool IsHover() const
Definition: selection.h:83
virtual unsigned int GetSize() const override
Return the number of stored items.
Definition: selection.h:99
EDA_ITEM * Front() const
Definition: selection.h:208
int Size() const
Returns the number of selected parts.
Definition: selection.h:115
void ClearReferencePoint()
Definition: selection.cpp:185
void SetReferencePoint(const VECTOR2I &aP)
Definition: selection.cpp:179
bool Empty() const
Checks if there is anything selected.
Definition: selection.h:109
bool HasReferencePoint() const
Definition: selection.h:247
virtual void PopTool(const TOOL_EVENT &aEvent)
Pops a tool from the stack.
virtual void PushTool(const TOOL_EVENT &aEvent)
NB: the definition of "tool" is different at the user level.
KIGFX::VIEW_CONTROLS * getViewControls() const
Return the instance of VIEW_CONTROLS object used in the application.
Definition: tool_base.cpp:42
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:216
KIGFX::VIEW * getView() const
Returns the instance of #VIEW object used in the application.
Definition: tool_base.cpp:36
RESET_REASON
Determine the reason of reset for a tool.
Definition: tool_base.h:78
@ MODEL_RELOAD
Model changes (the sheet for a schematic)
Definition: tool_base.h:80
Generic, UI-independent tool event.
Definition: tool_event.h:167
bool IsCancelInteractive() const
Indicate the event should restart/end an ongoing interactive tool's event loop (eg esc key,...
Definition: tool_event.cpp:221
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:246
bool IsActivate() const
Definition: tool_event.h:337
bool IsClick(int aButtonMask=BUT_ANY) const
Definition: tool_event.cpp:209
bool IsDrag(int aButtonMask=BUT_ANY) const
Definition: tool_event.h:307
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:82
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:252
bool IsMouseUp(int aButtonMask=BUT_ANY) const
Definition: tool_event.h:317
bool IsMotion() const
Definition: tool_event.h:322
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_MENU & GetToolMenu()
TOOL_MENU m_menu
The functions below are not yet implemented - their interface may change.
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.
void Activate()
Run the tool.
void PostEvent(const TOOL_EVENT &aEvent)
Put an event to the event queue to be processed at the end of event processing cycle.
bool RunAction(const std::string &aActionName, T aParam)
Run the specified action immediately, pausing the current action to run the new one.
Definition: tool_manager.h:145
std::string GetClipboardUTF8() const
Return the information currently stored in the system clipboard.
bool PostAction(const std::string &aActionName, T aParam)
Run the specified action after the current action (coroutine) ends.
Definition: tool_manager.h:230
bool SaveClipboard(const std::string &aTextUTF8)
Store information to the system clipboard.
CONDITIONAL_MENU & GetMenu()
Definition: tool_menu.cpp:44
void ShowContextMenu(SELECTION &aSelection)
Helper function to set and immediately show a CONDITIONAL_MENU in concert with the given SELECTION.
Definition: tool_menu.cpp:57
void Dismiss() override
Dismisses the infobar and updates the containing layout and AUI manager (if one is provided).
Definition: wx_infobar.cpp:187
This file is part of the common library.
#define _(s)
#define IS_NEW
New item, just created.
#define IS_MOVING
Item being moved.
#define HITTEST_THRESHOLD_PIXELS
This file contains miscellaneous commonly used macros and functions.
@ ID_APPEND_DESCR_FILE
Definition: pl_editor_id.h:41
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: string_utils.h:391
constexpr int delta
@ TA_UNDO_REDO_PRE
Definition: tool_event.h:105
@ BUT_LEFT
Definition: tool_event.h:131
@ BUT_RIGHT
Definition: tool_event.h:132
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:85