MenuInterface.hh 5.25 KB
Newer Older
1
/*===========================================================================*\
Jan Möbius's avatar
Jan Möbius committed
2
3
*                                                                            *
*                              OpenFlipper                                   *
Jan Möbius's avatar
Jan Möbius committed
4
*      Copyright (C) 2001-2011 by Computer Graphics Group, RWTH Aachen       *
Jan Möbius's avatar
Jan Möbius committed
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 <http://www.gnu.org/licenses/>.                                       *
*                                                                            *
33
34
35
\*===========================================================================*/

/*===========================================================================*\
Jan Möbius's avatar
Jan Möbius committed
36
37
38
39
40
*                                                                            *
*   $Revision$                                                       *
*   $LastChangedBy$                                                *
*   $Date$                     *
*                                                                            *
41
\*===========================================================================*/
Jan Möbius's avatar
 
Jan Möbius committed
42
43
44
45
46
47
48




//
// C++ Interface: BasePlugin
//
Jan Möbius's avatar
   
Jan Möbius committed
49
// Description:
Jan Möbius's avatar
 
Jan Möbius committed
50
51
52
53
54
//
//
// Author: Jan Moebius <jan_moebius@web.de>, (C) 2007
//

Jan Möbius's avatar
   
Jan Möbius committed
55
56
#ifndef MENUBARINTERFACE_HH
#define MENUBARINTERFACE_HH
Jan Möbius's avatar
 
Jan Möbius committed
57
58
59
60

#include <QtGui>
#include <QMenuBar>
#include <OpenFlipper/common/Types.hh>
Jan Möbius's avatar
   
Jan Möbius committed
61

Jan Möbius's avatar
Jan Möbius committed
62
63
// typedef to support old interface
typedef QString MenuActionType;
Jan Möbius's avatar
   
Jan Möbius committed
64

Jan Möbius's avatar
Jan Möbius committed
65
/// The Menu will be added inside the File Menu
Jan Möbius's avatar
Jan Möbius committed
66
#define FILEMENU tr("File")
Jan Möbius's avatar
   
Jan Möbius committed
67

Jan Möbius's avatar
Jan Möbius committed
68
/// The Menu will be added inside the View Menu
Jan Möbius's avatar
Jan Möbius committed
69
#define VIEWMENU tr("View")
Jan Möbius's avatar
   
Jan Möbius committed
70

Jan Möbius's avatar
Jan Möbius committed
71
/// The Menu will be added inside the Tools Menu
Jan Möbius's avatar
Jan Möbius committed
72
#define TOOLSMENU tr("Tools")
Jan Möbius's avatar
   
Jan Möbius committed
73
74


Jan Möbius's avatar
 
Jan Möbius committed
75
/** \brief Interface for all plugins which provide entries to the main menubar
Jan Möbius's avatar
   
Jan Möbius committed
76
  *
Jan Möbius's avatar
Jan Möbius committed
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's avatar
   
Jan Möbius committed
81
 */
Jan Möbius's avatar
 
Jan Möbius committed
82
class MenuInterface {
Jan Möbius's avatar
   
Jan Möbius committed
83
84
85

public :

Jan Möbius's avatar
 
Jan Möbius committed
86
87
  /// Destructor
  virtual ~MenuInterface() {};
Jan Möbius's avatar
   
Jan Möbius committed
88

Jan Möbius's avatar
 
Jan Möbius committed
89
signals:
Jan Möbius's avatar
Jan Möbius committed
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's avatar
   
Jan Möbius committed
101
  /**  \brief Adds an action to the menubar
Jan Möbius's avatar
   
Jan Möbius committed
102
    *
Jan Möbius's avatar
Jan Möbius committed
103
    *  Add an action to one of the menubar toplevel menus \n
Jan Möbius's avatar
 
Jan Möbius committed
104
105
106
    * \n
    *   Example : \n
    *   QMenu *colorMenu = new QMenu(tr("&Colors")); \n
Jan Möbius's avatar
   
Jan Möbius committed
107
    *   emit addMenubarAction( colorMenu->menuAction(), TOOLSMENU )
Jan Möbius's avatar
 
Jan Möbius committed
108
    * \n
Jan Möbius's avatar
   
Jan Möbius committed
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's avatar
Jan Möbius committed
113
    * @param _name Name of the menu
Jan Möbius's avatar
 
Jan Möbius committed
114
  */
Jan Möbius's avatar
Jan Möbius committed
115
  virtual void addMenubarAction(QAction* /*_action*/, QString /*_name*/ ) {};
Jan Möbius's avatar
 
Jan Möbius committed
116
117
};

Jan Möbius's avatar
   
Jan Möbius committed
118
Q_DECLARE_INTERFACE(MenuInterface,"OpenFlipper.MenuInterface/1.0")
Jan Möbius's avatar
   
Jan Möbius committed
119

Jan Möbius's avatar
 
Jan Möbius committed
120
#endif // MENUBARINTERFACE_HH