KiCad PCB EDA Suite
editor_conditions.h
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) 2020 Ian McInerney <ian.s.mcinerney at ieee.org>
5  * Copyright (C) 1992-2020 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 #ifndef EDITOR_CONDITIONS_H_
26 #define EDITOR_CONDITIONS_H_
27 
28 #include <class_draw_panel_gal.h>
29 #include <functional>
30 #include <tool/selection.h>
32 
33 class EDA_BASE_FRAME;
34 class EDA_DRAW_FRAME;
35 class TOOL_ACTION;
36 
41 {
42 public:
49  m_frame( aFrame )
50  {}
51 
58 
65 
72 
79 
86 
93 
102 
111 
120 
129 
130 protected:
132  static bool contentModifiedFunc( const SELECTION& aSelection, EDA_BASE_FRAME* aFrame );
133 
135  static bool undoFunc( const SELECTION& aSelection, EDA_BASE_FRAME* aFrame );
136 
138  static bool redoFunc( const SELECTION& aSelection, EDA_BASE_FRAME* aFrame );
139 
141  static bool unitsFunc( const SELECTION& aSelection, EDA_BASE_FRAME* aFrame, EDA_UNITS aUnits );
142 
144  static bool toolFunc( const SELECTION& aSelection, EDA_BASE_FRAME* aFrame,
145  const TOOL_ACTION& aTool );
146 
148  static bool noToolFunc( const SELECTION& aSelection, EDA_BASE_FRAME* aFrame );
149 
151  static bool gridFunc( const SELECTION& aSelection, EDA_DRAW_FRAME* aFrame );
152 
154  static bool polarCoordFunc( const SELECTION& aSelection, EDA_DRAW_FRAME* aFrame );
155 
157  static bool cursorFunc( const SELECTION& aSelection, EDA_DRAW_FRAME* aFrame );
158 
160  static bool consoleVisibleFunc( const SELECTION& aSelection, EDA_DRAW_FRAME* aFrame );
161 
164 };
165 
166 #endif /* EDITOR_CONDITIONS_H_ */
static bool unitsFunc(const SELECTION &aSelection, EDA_BASE_FRAME *aFrame, EDA_UNITS aUnits)
Helper function used by CurrentTool().
SELECTION_CONDITION FullscreenCursor()
Create a functor testing if the cursor is full screen in a frame.
static bool contentModifiedFunc(const SELECTION &aSelection, EDA_BASE_FRAME *aFrame)
< Helper function used by ContentModified().
SELECTION_CONDITION CurrentTool(const TOOL_ACTION &aTool)
Create a functor testing if the specified tool is the current active tool in the frame.
Class that groups generic conditions for selected items.
SELECTION_CONDITION RedoAvailable()
Create a functor that tests if there are any items in the redo queue.
The base class for create windows for drawing purpose.
static bool consoleVisibleFunc(const SELECTION &aSelection, EDA_DRAW_FRAME *aFrame)
The frame to apply the conditions to.
Class that groups generic conditions for editor states.
static bool cursorFunc(const SELECTION &aSelection, EDA_DRAW_FRAME *aFrame)
Helper function used by ScriptingConsoleVisible().
static bool polarCoordFunc(const SELECTION &aSelection, EDA_DRAW_FRAME *aFrame)
Helper function used by FullscreenCursor().
EDA_BASE_FRAME * m_frame
static bool noToolFunc(const SELECTION &aSelection, EDA_BASE_FRAME *aFrame)
Helper function used by GridVisible().
SELECTION_CONDITION GridVisible()
Create a functor testing if the grid is visible in a frame.
SELECTION_CONDITION Units(EDA_UNITS aUnit)
Create a functor that tests if the frame has the specified units.
static bool undoFunc(const SELECTION &aSelection, EDA_BASE_FRAME *aFrame)
Helper function used by RedoAvailable().
SELECTION_CONDITION ScriptingConsoleVisible()
Create a functor testing if the python scripting console window is visible.
std::function< bool(const SELECTION &)> SELECTION_CONDITION
< Functor type that checks a specific condition for selected items.
SELECTION_CONDITION PolarCoordinates()
Create a functor testing if polar coordinates are current being used.
SELECTION_CONDITION ContentModified()
Create a functor that tests if the content of the frame is modified.
SELECTION_CONDITION NoActiveTool()
Create a functor testing if there are no tools active in the frame.
static bool gridFunc(const SELECTION &aSelection, EDA_DRAW_FRAME *aFrame)
Helper function used by PolarCoordinates().
static bool toolFunc(const SELECTION &aSelection, EDA_BASE_FRAME *aFrame, const TOOL_ACTION &aTool)
Helper function used by NoActiveTool().
EDA_UNITS
Definition: eda_units.h:38
static bool redoFunc(const SELECTION &aSelection, EDA_BASE_FRAME *aFrame)
Helper function used by Units().
SELECTION_CONDITION UndoAvailable()
Create a functor that tests if there are any items in the undo queue.
The base frame for deriving all KiCad main window classes.
Represent a single user action.
Definition: tool_action.h:67
EDITOR_CONDITIONS(EDA_BASE_FRAME *aFrame)
Create an object to define conditions dependent upon a specific frame.