2.12.2021, 9:00 - 11:00: Due to updates GitLab may be unavailable for some minutes between 09:00 and 11:00.

mdidockablewindow.h 4.97 KB
Newer Older
1
2
3
4
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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
// ================================================================================================
// 
// This file is part of the CAMPVis Software Framework.
// 
// If not explicitly stated otherwise: Copyright (C) 2012, all rights reserved,
//      Christian Schulte zu Berge <christian.szb@in.tum.de>
//      Chair for Computer Aided Medical Procedures
//      Technische Universität München
//      Boltzmannstr. 3, 85748 Garching b. München, Germany
// For a full list of authors and contributors, please refer to the file "AUTHORS.txt".
// 
// The licensing of this softare is not yet resolved. Until then, redistribution in source or
// binary forms outside the CAMP chair is not permitted, unless explicitly stated in legal form.
// However, the names of the original authors and the above copyright notice must retain in its
// original state in any case.
// 
// Legal disclaimer provided by the BSD license:
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
// IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY 
// AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR 
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
// 
// ================================================================================================

#ifndef MDIDOCKABLEWINDOW_H__
#define MDIDOCKABLEWINDOW_H__

#include "mdidockedwindow.h"
#include "mdifloatingwindow.h"

#include <QWidget>

namespace campvis {

    class MdiDockArea;

    /**
     * MDI window that be docked and undocked.
     *
     * MdiDockableWindow takes care of creating all necessary representations (docked and floating
     * window) of the widget it's passed and seamlessly switching between them in response to the
     * user's actions (window dragging, key presses, etc).
     */
    class MdiDockableWindow : public QWidget {

        Q_OBJECT

    public:
        /**
         * Construct a new MdiDockableWindow.
         *
         * \param widget the widget this window is to wrap
         * \param mdiArea the MDI area the window should dock in
         * \param windowFlags flags used to customize the frame of the window
         */
        MdiDockableWindow(QWidget* widget, MdiDockArea* mdiArea, Qt::WindowFlags windowFlags = 0);

        /**
         * Set the title of this window.
         *
         * \param title the window's new title
         */
        void setWindowTitle(const QString& title);

        /**
         * Change the window's visibility.
         *
         * \param visible should the window be visible?
         */
        virtual void setVisible(bool visible);

        /**
         * Returns a checkable action that can be used to show or hide this window.
         *
         * The action's text is set to this window's title.
         */
        QAction* toggleViewAction() const;

    private slots:
        /**
         * Track the position of the associated floating MDI window and dock it if necessary.
         *
         * This slot is invoked when the position of the floating MDI window changes.
         */
        void trackFloatingWindowPosition(const QPoint& newPos);

        /**
         * Track the position of the associated docked MDI window and detach it if necessary.
         *
         * This slot is invoked when the position of the docked MDI window changes.
         */
        void trackDockedWindowPosition(const QPoint& newPos);

        /**
         * Depending on the state of _toggleViewAction, show or hide the window.
         *
         * \param on true if _toggleViewAction is checked, false otherwise
         */
        void toggleWindowVisibility(bool on);

        /**
         * Hide the closed MdiDockedWindow/MdiFloatingWindow and update the visibility action.
         */
        void handleWindowClosing();

    private:
        /**
         * Create and return an MdiDockedWindow wrapping the \p widget.
         *
         * \param widget the widget the new docked window should wrap
         */
        MdiDockedWindow* newDockedWindow(QWidget* widget);

        bool _docked;                         ///< Is the window currently docked?
        MdiDockArea* _mdiArea;                ///< The MDI this window docks in.
        MdiDockedWindow* _dockedWindow;       ///< The window's docked representation.
        MdiFloatingWindow* _floatingWindow;   ///< The window's floating representation.
        QAction* _toggleViewAction;           ///< A checkable action that can be used to show or hide this window.

    };
}

#endif // MDIDOCKABLEWINDOW_H__