MIRA
EditorPart.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2012 by
3  * MetraLabs GmbH (MLAB), GERMANY
4  * and
5  * Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
6  * All rights reserved.
7  *
8  * Contact: info@mira-project.org
9  *
10  * Commercial Usage:
11  * Licensees holding valid commercial licenses may use this file in
12  * accordance with the commercial license agreement provided with the
13  * software or, alternatively, in accordance with the terms contained in
14  * a written agreement between you and MLAB or NICR.
15  *
16  * GNU General Public License Usage:
17  * Alternatively, this file may be used under the terms of the GNU
18  * General Public License version 3.0 as published by the Free Software
19  * Foundation and appearing in the file LICENSE.GPL3 included in the
20  * packaging of this file. Please review the following information to
21  * ensure the GNU General Public License version 3.0 requirements will be
22  * met: http://www.gnu.org/copyleft/gpl.html.
23  * Alternatively you may (at your option) use any later version of the GNU
24  * General Public License if such license has been publicly approved by
25  * MLAB and NICR (or its successors, if any).
26  *
27  * IN NO EVENT SHALL "MLAB" OR "NICR" BE LIABLE TO ANY PARTY FOR DIRECT,
28  * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
29  * THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLAB" OR
30  * "NICR" HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  *
32  * "MLAB" AND "NICR" SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
33  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
34  * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
35  * ON AN "AS IS" BASIS, AND "MLAB" AND "NICR" HAVE NO OBLIGATION TO
36  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
37  */
38 
47 #ifndef _MIRA_EDITORPART_H_
48 #define _MIRA_EDITORPART_H_
49 
50 #include <QtGui/QImage>
51 
53 
54 #include <rcp/WorkbenchPart.h>
55 #include <rcp/EditorPartWindow.h>
56 
57 // fwd decl
58 class QMenu;
59 
60 namespace mira {
61 
63 
70 {
71  Q_OBJECT
73 public:
74  EditorPart();
75 
76  virtual ~EditorPart();
77 
78 public:
79  virtual void init(IWorkbenchPartSite* site);
80 
81  IWorkbenchPartSite* getSite();
82 
83 public:
84 
90  virtual QImage captureContent();
91 
92 protected:
93 
99  virtual QWidget* createPartControl() = 0;
100 
107  QMenu* getViewMenu();
108 
109  virtual void closeEvent(QCloseEvent*);
110 
111 signals:
112 
113  void editorClosed(EditorPart* editor);
114  void editorDestroyed(EditorPart* editor);
115 
116 private:
117  IWorkbenchPartSite* mSite;
118 };
119 
121 }
122 
123 #endif
specialize cv::DataType for our ImgPixel and inherit from cv::DataType<Vec>
Definition: IOService.h:67
An editor is typically used to edit or browse data or objects.
Definition: EditorPart.h:69
A workbench part is a component within the workbench.
Definition: WorkbenchPart.h:118
#define MIRA_ABSTRACT_OBJECT(classIdentifier)
Use this MACRO instead of MIRA_OBJECT to declare the class as abstract.
Definition: FactoryMacros.h:239
Contains the base interface of all Reflectors, Serializers, etc.
Definition: EditorPartWindow.h:63
The primary interface between a workbench part and the workbench.
Definition: WorkbenchPart.h:68
#define MIRA_GUI_RCP_EXPORT
Definition: GuiRCPExports.h:61
Declaration of WorkbenchPart and related interfaces.
Declaration of the EditorPartWindow.