KiCad PCB EDA Suite
Loading...
Searching...
No Matches
tool_menu.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) 2017-2020 KiCad Developers, see AUTHORS.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#ifndef TOOLS_TOOL_MENU__H_
25#define TOOLS_TOOL_MENU__H_
26
28
29#include <vector>
30#include <memory>
31
32class ACTION_MENU;
34
43{
44public:
45
54
58 ~TOOL_MENU();
59
65
75 void RegisterSubMenu( std::shared_ptr<ACTION_MENU> aSubMenu );
76
80 std::vector<std::shared_ptr<ACTION_MENU> >& GetSubMenus()
81 {
82 return m_subMenus;
83 }
84
93 void ShowContextMenu( SELECTION& aSelection );
94
99 void ShowContextMenu();
100
101private:
106
111
115 std::vector<std::shared_ptr<ACTION_MENU> > m_subMenus;
116};
117
118#endif // TOOLS_TOOL_MENU__H_
Defines the structure of a menu based on ACTIONs.
Definition: action_menu.h:49
Manage a CONDITIONAL_MENU and some number of CONTEXT_MENUs as sub-menus.
Definition: tool_menu.h:43
CONDITIONAL_MENU & GetMenu()
Definition: tool_menu.cpp:44
TOOL_INTERACTIVE & m_tool
The tool that owns this menu.
Definition: tool_menu.h:110
void RegisterSubMenu(std::shared_ptr< ACTION_MENU > aSubMenu)
Store a submenu of this menu model.
Definition: tool_menu.cpp:50
void ShowContextMenu()
Helper function to show a context menu without any selection for tools that can't make selections.
Definition: tool_menu.cpp:66
~TOOL_MENU()
Destruct any submenus created with TOOL_MENU::CreateSubMenu().
Definition: tool_menu.cpp:39
std::vector< std::shared_ptr< ACTION_MENU > > m_subMenus
Lifetime-managing container of submenus.
Definition: tool_menu.h:115
CONDITIONAL_MENU m_menu
The conditional menu displayed by the tool.
Definition: tool_menu.h:105
std::vector< std::shared_ptr< ACTION_MENU > > & GetSubMenus()
Definition: tool_menu.h:80