mirror of
https://gitlab.com/kicad/code/kicad.git
synced 2025-09-14 10:13:19 +02:00
72a1c71e07
This allows for the tool framework to keep track of a universal set of conditions for the UI state (enabled/checked/shown) for controls of actions. It removes the need for the main menubar menus to be CONDITIONAL_MENUs and be rebuilt on each open, and instead makes the updates of the check and enabling of items handled in the native wxWidgets way. This commit switchs the 3d viewer and kicad project manager window over to this system.
122 lines
4.5 KiB
C++
122 lines
4.5 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2004-2017 KiCad Developers.
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, you may find one here:
|
|
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
|
|
* or you may search the http://www.gnu.org website for the version 2 license,
|
|
* or you may write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|
|
*/
|
|
|
|
#ifndef MENUS_HELPERS_H_
|
|
#define MENUS_HELPERS_H_
|
|
|
|
/**
|
|
* @file menus_helpers.h
|
|
* @brief Usefull macros and inline functions to create menus items
|
|
* in menubars or popup menus
|
|
*/
|
|
|
|
|
|
#include <wx/menu.h>
|
|
#include <wx/menuitem.h>
|
|
#include <bitmaps.h>
|
|
|
|
class ACTION_MENU;
|
|
class TOOL_INTERACTIVE;
|
|
|
|
void AddMenuLanguageList( ACTION_MENU* aMasterMenu, TOOL_INTERACTIVE* aControlTool );
|
|
|
|
/**
|
|
* Add a bitmap to a menuitem
|
|
* @param aMenu is the menuitem.
|
|
* @param aImage is the icon to add to aMenu.
|
|
* It is added only if use images in menus config option allows it.
|
|
* For wxITEM_CHECK or wxITEM_RADIO menuitems, the bitmap is added only
|
|
* on Windows, other platforms do not support it
|
|
*/
|
|
void AddBitmapToMenuItem( wxMenuItem* aMenu, const wxBitmap& aImage );
|
|
|
|
|
|
/**
|
|
* Function AddMenuItem
|
|
* is an inline helper function to create and insert a menu item with an icon
|
|
* into \a aMenu
|
|
*
|
|
* @param aMenu is the menu to add the new item.
|
|
* @param aId is the command ID for the new menu item.
|
|
* @param aText is the string for the new menu item.
|
|
* @param aImage is the icon to add to the new menu item.
|
|
* @param aType is the type of menu :wxITEM_NORMAL (default), wxITEM_CHECK ...
|
|
* @return a pointer to the new created wxMenuItem
|
|
*/
|
|
wxMenuItem* AddMenuItem( wxMenu* aMenu, int aId, const wxString& aText,
|
|
const wxBitmap& aImage, wxItemKind aType = wxITEM_NORMAL );
|
|
|
|
|
|
/**
|
|
* Function AddMenuItem
|
|
* is an inline helper function to create and insert a menu item with an icon
|
|
* and a help message string into \a aMenu
|
|
*
|
|
* @param aMenu is the menu to add the new item.
|
|
* @param aId is the command ID for the new menu item.
|
|
* @param aText is the string for the new menu item.
|
|
* @param aHelpText is the help message string for the new menu item.
|
|
* @param aImage is the icon to add to the new menu item.
|
|
* @param aType is the type of menu :wxITEM_NORMAL (default), wxITEM_CHECK ...
|
|
* @return a pointer to the new created wxMenuItem
|
|
*/
|
|
wxMenuItem* AddMenuItem( wxMenu* aMenu, int aId, const wxString& aText,
|
|
const wxString& aHelpText, const wxBitmap& aImage,
|
|
wxItemKind aType = wxITEM_NORMAL );
|
|
|
|
|
|
/**
|
|
* Function AddMenuItem
|
|
* is an inline helper function to create and insert a menu item with an icon
|
|
* into \a aSubMenu in \a aMenu
|
|
*
|
|
* @param aMenu is the menu to add the new submenu item.
|
|
* @param aSubMenu is the submenu to add the new menu.
|
|
* @param aId is the command ID for the new menu item.
|
|
* @param aText is the string for the new menu item.
|
|
* @param aImage is the icon to add to the new menu item.
|
|
* @return a pointer to the new created wxMenuItem
|
|
*/
|
|
wxMenuItem* AddMenuItem( wxMenu* aMenu, wxMenu* aSubMenu, int aId,
|
|
const wxString& aText, const wxBitmap& aImage );
|
|
|
|
|
|
/**
|
|
* Function AddMenuItem
|
|
* is an inline helper function to create and insert a menu item with an icon
|
|
* and a help message string into \a aSubMenu in \a aMenu
|
|
*
|
|
* @param aMenu is the menu to add the new submenu item.
|
|
* @param aSubMenu is the submenu to add the new menu.
|
|
* @param aId is the command ID for the new menu item.
|
|
* @param aText is the string for the new menu item.
|
|
* @param aHelpText is the help message string for the new menu item.
|
|
* @param aImage is the icon to add to the new menu item.
|
|
* @return a pointer to the new created wxMenuItem
|
|
*/
|
|
wxMenuItem* AddMenuItem( wxMenu* aMenu, wxMenu* aSubMenu, int aId,
|
|
const wxString& aText, const wxString& aHelpText,
|
|
const wxBitmap& aImage );
|
|
|
|
#endif // MENUS_HELPERS_H_
|