[go: up one dir, main page]

File: todocklet.h

package info (click to toggle)
tora 2.1.2-1
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 27,560 kB
  • ctags: 21,885
  • sloc: cpp: 189,278; sh: 17,561; makefile: 692; python: 159; xml: 69; ansic: 56
file content (180 lines) | stat: -rw-r--r-- 4,845 bytes parent folder | download | duplicates (4)
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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180

/* BEGIN_COMMON_COPYRIGHT_HEADER
 *
 * TOra - An Oracle Toolkit for DBA's and developers
 * 
 * Shared/mixed copyright is held throughout files in this product
 * 
 * Portions Copyright (C) 2000-2001 Underscore AB
 * Portions Copyright (C) 2003-2005 Quest Software, Inc.
 * Portions Copyright (C) 2004-2009 Numerous Other Contributors
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation;  only version 2 of
 * the License is valid for this program.
 * 
 * This program 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 General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 * 
 *      As a special exception, you have permission to link this program
 *      with the Oracle Client libraries and distribute executables, as long
 *      as you follow the requirements of the GNU GPL in regard to all of the
 *      software in the executable aside from Oracle client libraries.
 * 
 *      Specifically you are not permitted to link this program with the
 *      Qt/UNIX, Qt/Windows or Qt Non Commercial products of TrollTech.
 *      And you are not permitted to distribute binaries compiled against
 *      these libraries. 
 * 
 *      You may link this product with any GPL'd Qt library.
 * 
 * All trademarks belong to their respective owners.
 *
 * END_COMMON_COPYRIGHT_HEADER */

#ifndef TODOCKLET_H
#define TODOCKLET_H

#include "config.h"

#include <QMap>
#include <QAction>
#include <QWidget>
#include <QDockWidget>
#include <QRect>

class toDocklet;

class toDockletHolder
{
public:
    virtual ~toDockletHolder(){};
    virtual toDocklet* docklet(QWidget *parent = 0,
                               Qt::WindowFlags flags = 0) = 0;
};


class toDocklet : public QDockWidget
{
    Q_OBJECT;

public:
    explicit toDocklet(const QString &title,
                       QWidget *parent = 0,
                       Qt::WindowFlags flags = 0);
    virtual ~toDocklet() {}


    /**
     * Get the icon for this docklet
     *
     */
    virtual QIcon icon() const = 0;


    /**
     * Get the docklet's name
     *
     */
    virtual QString name() const = 0;


    // ---------------------------------------- static

    /**
     * Used by REGISTER_VIEW to init docklets
     *
     */
    static toDockletHolder* registerDocklet(QString name, toDockletHolder *holder);


    /**
     * Get a list of available docklets
     *
     */
    static QList<toDocklet *> docklets(void);


    /**
     * Find the docklet for the given name
     *
     */
    static toDocklet* docklet(QString name);


signals:
    /**
     * Use this signal in a subclass after a child widget has been
     * activated. toDocklet will handle closing the popup, if any.
     *
     */
    void activated(void);


    /**
     * Emitted when the popup is closed
     *
     */
    void popupVisibleToggled(bool shown);


    /**
     * Emitted when docklet moves to new location
     *
     */
    void dockletLocationChanged(toDocklet *let, Qt::DockWidgetArea area);


public slots:
    /**
     * Show or hide popup. This is different from QDockWidget::floating
     *
     */
    void showPopup(bool shown);


protected:
    virtual bool event(QEvent *event);


private slots:
    void childActivated();
    void handleDockletLocationChanged(Qt::DockWidgetArea area);


private:
    bool       isPopup;
};


/**
 * Registers views statically. Simply place:
 *
 * REGISTER_VIEW("some untranslated, unique name", myAwesomeView);
 *
 * call in the .cpp file of your view definition. Uses toDockletHolder
 * to get around limitations with static initialization and QWidgets.
 *
 */
#define REGISTER_VIEW(NAME, TYPE)                           \
class TYPE##Holder : public toDockletHolder                 \
{                                                           \
public:                                                     \
    virtual toDocklet* docklet(QWidget *parent = 0,         \
                               Qt::WindowFlags flags = 0)   \
    {                                                       \
        static TYPE *let = new TYPE(parent, flags);         \
        return let;                                         \
    }                                                       \
};                                                          \
toDockletHolder* TYPE ## _myPrototype =                     \
    toDocklet::registerDocklet(NAME, new TYPE##Holder());

#endif