KiCad PCB EDA Suite
tool_menu.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) 2017-2019 KiCad Developers, see CHANGELOG.txt for contributors.
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, you may find one here:
18  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19  * or you may search the http://www.gnu.org website for the version 2 license,
20  * or you may write to the Free Software Foundation, Inc.,
21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22  */
23 
24 #include <draw_frame.h>
25 #include <tool/tool_menu.h>
26 #include <tool/tool_interactive.h>
27 #include <tool/action_menu.h>
28 #include <tool/actions.h>
29 #include <tool/zoom_menu.h>
30 #include <tool/grid_menu.h>
31 #include <tool/selection.h>
32 
33 
35  m_menu( true, &aTool ),
36  m_tool( aTool )
37 {
38 }
39 
40 
42 {
43 }
44 
45 
47 {
48  return m_menu;
49 }
50 
51 
52 void TOOL_MENU::AddSubMenu( std::shared_ptr<ACTION_MENU> aSubMenu )
53 {
54  // store a copy of the menu (keeps a reference)
55  m_subMenus.push_back( std::move( aSubMenu ) );
56 }
57 
58 
60 {
61  m_menu.Evaluate( aSelection );
62  m_menu.UpdateAll();
63  m_menu.m_Dirty = false;
65 }
66 
67 
69 {
70  m_menu.m_Dirty = true;
72 }
73 
74 
76 {
77 }
78 
79 
80 // This makes the factory functions a bit less verbose
82 
84 {
89 
91 
92  if( aFrame )
93  {
94  m_menu.AddMenu( createOwnSubMenu<ZOOM_MENU>( aFrame ).get(), S_C::ShowAlways, 1000 );
95  m_menu.AddMenu( createOwnSubMenu<GRID_MENU>( aFrame ).get(), S_C::ShowAlways, 1000 );
96  }
97 }
static bool ShowAlways(const SELECTION &aSelection)
Function ShowAlways The default condition function (always returns true).
void AddMenu(ACTION_MENU *aMenu, const SELECTION_CONDITION &aCondition=SELECTION_CONDITIONS::ShowAlways, int aOrder=ANY_ORDER)
Function AddMenu()
TOOL_INTERACTIVE & m_tool
The tool that owns this menu.
Definition: tool_menu.h:159
void AddStandardSubMenus(EDA_DRAW_FRAME *aFrame)
Function CreateBasicMenu.
Definition: tool_menu.cpp:83
void ShowContextMenu()
Function ShowContextMenu.
Definition: tool_menu.cpp:68
~TOOL_MENU()
Destructor, also destructs any submenus created with TOOL_MENU::CreateSubMenu().
Definition: tool_menu.cpp:41
void AddSeparator(const SELECTION_CONDITION &aCondition=SELECTION_CONDITIONS::ShowAlways, int aOrder=ANY_ORDER)
Function AddSeparator()
CONDITIONAL_MENU & GetMenu()
Function GetMenu.
Definition: tool_menu.cpp:46
static TOOL_ACTION zoomFitScreen
Definition: actions.h:63
Class that groups generic conditions for selected items.
void UpdateAll()
Function UpdateAll() Runs update handlers for the menu and its submenus.
void SetContextMenu(ACTION_MENU *aMenu, CONTEXT_MENU_TRIGGER aTrigger=CMENU_BUTTON)
Function SetContextMenu()
The base class for create windows for drawing purpose.
Definition: draw_frame.h:82
CONDITIONAL_MENU m_menu
The conditional menu displayed by the tool.
Definition: tool_menu.h:154
std::vector< std::shared_ptr< ACTION_MENU > > m_subMenus
Lifetime-managing container of submenus.
Definition: tool_menu.h:164
void Evaluate(SELECTION &aSelection)
Function Evaluate()
bool m_Dirty
Menu requires updating before display.
Definition: action_menu.h:146
void CloseContextMenu(OPT_TOOL_EVENT &evt)
Function CloseContextMenu.
Definition: tool_menu.cpp:75
static TOOL_ACTION zoomCenter
Definition: actions.h:62
void AddSubMenu(std::shared_ptr< ACTION_MENU > aSubMenu)
Function CreateSubMenu.
Definition: tool_menu.cpp:52
TOOL_MENU(TOOL_INTERACTIVE &aTool)
Function TOOL_MENU.
Definition: tool_menu.cpp:34
static TOOL_ACTION zoomIn
Definition: actions.h:58
static TOOL_ACTION zoomOut
Definition: actions.h:59
void AddItem(const TOOL_ACTION &aAction, const SELECTION_CONDITION &aCondition, int aOrder=ANY_ORDER)
Function AddItem()
OPT< TOOL_EVENT > OPT_TOOL_EVENT
Definition: tool_event.h:486