← Back to branch summary

~ubuntu-branches/ubuntu/raring/openwalnut/raring

« back to all changes in this revision

Viewing changes to src/qt4gui/events/WOpenCustomDockWidgetEvent.h

  • Committer: Package Import Robot
  • Author(s): Sebastian Eichelbaum
  • Date: 2012-12-12 11:26:32 UTC
  • mfrom: (3.1.1 sid)
  • Revision ID: package-import@ubuntu.com-20121212112632-xhiuwkxuz5h0idkh
Tags: 1.3.1+hg5849-1
* Minor changes compared to 1.3.0 but included several bug fixes.
* See http://www.openwalnut.org/versions/4

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/qt4gui/events/WOpenCustomDockWidgetEvent.h
 
1
//---------------------------------------------------------------------------
 
2
//
 
3
// Project: OpenWalnut ( http://www.openwalnut.org )
 
4
//
 
5
// Copyright 2009 OpenWalnut Community, BSV@Uni-Leipzig and CNCF@MPI-CBS
 
6
// For more information see http://www.openwalnut.org/copying
 
7
//
 
8
// This file is part of OpenWalnut.
 
9
//
 
10
// OpenWalnut is free software: you can redistribute it and/or modify
 
11
// it under the terms of the GNU Lesser General Public License as published by
 
12
// the Free Software Foundation, either version 3 of the License, or
 
13
// (at your option) any later version.
 
14
//
 
15
// OpenWalnut is distributed in the hope that it will be useful,
 
16
// but WITHOUT ANY WARRANTY; without even the implied warranty of
 
17
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
18
// GNU Lesser General Public License for more details.
 
19
//
 
20
// You should have received a copy of the GNU Lesser General Public License
 
21
// along with OpenWalnut. If not, see <http://www.gnu.org/licenses/>.
 
22
//
 
23
//---------------------------------------------------------------------------
 
24
 
 
25
#ifndef WOPENCUSTOMDOCKWIDGETEVENT_H
 
26
#define WOPENCUSTOMDOCKWIDGETEVENT_H
 
27
 
 
28
#include <string>
 
29
 
 
30
#include <QtCore/QEvent>
 
31
 
 
32
#include "core/graphicsEngine/WGECamera.h"
 
33
#include "core/common/WFlag.h"
 
34
#include "core/gui/WCustomWidget.h"
 
35
 
 
36
#include "WEventTypes.h"
 
37
 
 
38
/**
 
39
 * A Qt event to open a new custom dock widget if posted to the WMainWindow.
 
40
 */
 
41
class WOpenCustomDockWidgetEvent : public QEvent
 
42
{
 
43
public:
 
44
    /**
 
45
     * Constructor
 
46
     *
 
47
     * \param title the title of the widget to open
 
48
     * \param projectionMode the kind of projection which should be used
 
49
     * \param flag The WFlag which contains the widget after its creation.
 
50
     */
 
51
    explicit WOpenCustomDockWidgetEvent( std::string title, WGECamera::ProjectionMode projectionMode,
 
52
        boost::shared_ptr< WFlag< boost::shared_ptr< WCustomWidget > > > flag );
 
53
 
 
54
    /**
 
55
     * Get the title of the widget to open.
 
56
     *
 
57
     * \return title of the widget to open
 
58
     */
 
59
    std::string getTitle() const;
 
60
 
 
61
    /**
 
62
     * Get the kind of projection which should be used.
 
63
     *
 
64
     * \return the kind of projection which should be used
 
65
     */
 
66
    WGECamera::ProjectionMode getProjectionMode() const;
 
67
 
 
68
    /**
 
69
     * Get the WFlag which contains the widget after its creation.
 
70
     *
 
71
     * \return a shared pointer to the WFlag
 
72
     */
 
73
    boost::shared_ptr< WFlag< boost::shared_ptr< WCustomWidget > > > getFlag() const;
 
74
 
 
75
    /**
 
76
     * Constant which saves the number used to distinguish this event from other
 
77
     * custom events.
 
78
     */
 
79
    static const QEvent::Type CUSTOM_TYPE = static_cast< QEvent::Type >( WQT_OPENCUSTOMDOCKWIDGET );
 
80
 
 
81
protected:
 
82
private:
 
83
    /**
 
84
     * the title of the widget to create
 
85
     */
 
86
    std::string m_title;
 
87
 
 
88
    /**
 
89
     * the kind of projection which should be used
 
90
     */
 
91
    WGECamera::ProjectionMode m_projectionMode;
 
92
 
 
93
    /**
 
94
     * WFlag which contains the widget after its creation.
 
95
     */
 
96
    boost::shared_ptr< WFlag< boost::shared_ptr< WCustomWidget > > > m_flag;
 
97
};
 
98
 
 
99
#endif  // WOPENCUSTOMDOCKWIDGETEVENT_H