Jan Möbius committed Aug 05, 2009 1 ``````/*===========================================================================*\ `````` Jan Möbius committed Nov 25, 2010 2 3 ``````* * * OpenFlipper * `````` Jan Möbius committed Jan 26, 2011 4 ``````* Copyright (C) 2001-2011 by Computer Graphics Group, RWTH Aachen * `````` Jan Möbius committed Nov 25, 2010 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 ``````* www.openflipper.org * * * *--------------------------------------------------------------------------- * * This file is part of OpenFlipper. * * * * OpenFlipper is free software: you can redistribute it and/or modify * * it under the terms of the GNU Lesser General Public License as * * published by the Free Software Foundation, either version 3 of * * the License, or (at your option) any later version with the * * following exceptions: * * * * If other files instantiate templates or use macros * * or inline functions from this file, or you compile this file and * * link it with other files to produce an executable, this file does * * not by itself cause the resulting executable to be covered by the * * GNU Lesser General Public License. This exception does not however * * invalidate any other reasons why the executable file might be * * covered by the GNU Lesser General Public License. * * * * OpenFlipper 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 Lesser General Public License for more details. * * * * You should have received a copy of the GNU LesserGeneral Public * * License along with OpenFlipper. If not, * * see . * * * `````` Jan Möbius committed Aug 05, 2009 33 34 35 ``````\*===========================================================================*/ /*===========================================================================*\ `````` Jan Möbius committed Nov 25, 2010 36 37 38 39 40 ``````* * * \$Revision\$ * * \$LastChangedBy\$ * * \$Date\$ * * * `````` Jan Möbius committed Aug 05, 2009 41 ``````\*===========================================================================*/ `````` Jan Möbius committed Aug 29, 2008 42 43 44 45 46 47 48 `````` // // C++ Interface: BasePlugin // `````` Jan Möbius committed Jan 27, 2009 49 ``````// Description: `````` Jan Möbius committed Aug 29, 2008 50 51 52 53 54 ``````// // // Author: Jan Moebius , (C) 2007 // `````` Jan Möbius committed Jan 27, 2009 55 56 ``````#ifndef MENUBARINTERFACE_HH #define MENUBARINTERFACE_HH `````` Jan Möbius committed Aug 29, 2008 57 58 59 60 `````` #include #include #include `````` Jan Möbius committed Jan 27, 2009 61 `````` `````` Jan Möbius committed Jul 09, 2009 62 63 ``````// typedef to support old interface typedef QString MenuActionType; `````` Jan Möbius committed Jan 27, 2009 64 `````` `````` Jan Möbius committed Jul 09, 2009 65 ``````/// The Menu will be added inside the File Menu `````` Jan Möbius committed Aug 04, 2009 66 ``````#define FILEMENU tr("File") `````` Jan Möbius committed Jan 27, 2009 67 `````` `````` Jan Möbius committed Jul 09, 2009 68 ``````/// The Menu will be added inside the View Menu `````` Jan Möbius committed Aug 04, 2009 69 ``````#define VIEWMENU tr("View") `````` Jan Möbius committed Mar 09, 2009 70 `````` `````` Jan Möbius committed Jul 09, 2009 71 ``````/// The Menu will be added inside the Tools Menu `````` Jan Möbius committed Aug 04, 2009 72 ``````#define TOOLSMENU tr("Tools") `````` Jan Möbius committed Jan 27, 2009 73 74 `````` `````` Jan Möbius committed Aug 29, 2008 75 ``````/** \brief Interface for all plugins which provide entries to the main menubar `````` Jan Möbius committed Jan 27, 2009 76 `````` * `````` Jan Möbius committed Jul 09, 2009 77 78 79 80 `````` * To add custom menus or actions to the menubar, you have to use this interface class. Create * your own QMenu or QAction and emit addMenubarAction to add it to one of the menubar toplevel menus. * You can also get a pointer to one existing toplevel menus or create a new one with the getMenubarMenu * function. You can connect the signals and slots for your menu or action inside the plugin. `````` Jan Möbius committed Jan 27, 2009 81 `````` */ `````` Jan Möbius committed Aug 29, 2008 82 ``````class MenuInterface { `````` Jan Möbius committed Jan 27, 2009 83 84 85 `````` public : `````` Jan Möbius committed Aug 29, 2008 86 87 `````` /// Destructor virtual ~MenuInterface() {}; `````` Jan Möbius committed Jan 27, 2009 88 `````` `````` Jan Möbius committed Aug 29, 2008 89 ``````signals: `````` Jan Möbius committed Jul 09, 2009 90 91 92 93 94 95 96 97 98 99 100 `````` /** \brief Get a existing toplevel menu pointer or create a new one * * Checks if a toplevel menu is present and creates one if needed \n * * @param _name Menu name (see FILEMENU/VIEWMENU/TOOLSMENU example defines) * @param _menu The returned toplevel menu * @param _create Should a new menu be created if id doesn't exist */ virtual void getMenubarMenu (QString /*_name*/, QMenu *& /*_menu*/, bool /*_create*/) {}; `````` Jan Möbius committed Mar 09, 2009 101 `````` /** \brief Adds an action to the menubar `````` Jan Möbius committed Jan 27, 2009 102 `````` * `````` Jan Möbius committed Jul 09, 2009 103 `````` * Add an action to one of the menubar toplevel menus \n `````` Jan Möbius committed Aug 29, 2008 104 105 106 `````` * \n * Example : \n * QMenu *colorMenu = new QMenu(tr("&Colors")); \n `````` Jan Möbius committed Mar 09, 2009 107 `````` * emit addMenubarAction( colorMenu->menuAction(), TOOLSMENU ) `````` Jan Möbius committed Aug 29, 2008 108 `````` * \n `````` Jan Möbius committed Mar 09, 2009 109 110 111 112 `````` * All actions or sub actions can be freely controlled by yourself. You have * to connect the required signals and slots to your plugin. * * @param _action Pointer to the new action `````` Jan Möbius committed Jul 09, 2009 113 `````` * @param _name Name of the menu `````` Jan Möbius committed Aug 29, 2008 114 `````` */ `````` Jan Möbius committed Jul 09, 2009 115 `````` virtual void addMenubarAction(QAction* /*_action*/, QString /*_name*/ ) {}; `````` Jan Möbius committed Aug 29, 2008 116 117 ``````}; `````` Jan Möbius committed Mar 09, 2009 118 ``````Q_DECLARE_INTERFACE(MenuInterface,"OpenFlipper.MenuInterface/1.0") `````` Jan Möbius committed Jan 27, 2009 119 `````` `````` Jan Möbius committed Aug 29, 2008 120 ``#endif // MENUBARINTERFACE_HH``