File: DockManager.sip

package info (click to toggle)
qt-advanced-docking-system 3.8.3-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 13,600 kB
  • sloc: cpp: 11,678; python: 2,623; makefile: 12
file content (245 lines) | stat: -rw-r--r-- 7,621 bytes parent folder | download
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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
%Import QtWidgets/QtWidgetsmod.sip

%If (Qt_5_0_0 -)

%MappedType QMap<QString, ads::CDockWidget*>
        /TypeHint="Dict[QString, CDockWidget*]", TypeHintValue="{}"/
{
%TypeHeaderCode
#include <qmap.h>
%End

%ConvertFromTypeCode
    PyObject *d = PyDict_New();

    if (!d)
        return 0;
    
    QMap<QString, ads::CDockWidget*>::const_iterator it = sipCpp->constBegin();
    QMap<QString, ads::CDockWidget*>::const_iterator end = sipCpp->constEnd();

    while (it != end)
    {
        QString *k = new QString(it.key());
        PyObject *kobj = sipConvertFromType(k, sipType_QString,
                sipTransferObj);

        if (!kobj)
        {
            delete k;
            Py_DECREF(d);

            return 0;
        }

        PyObject *vobj = sipConvertFromType(it.value(), sipType_ads_CDockWidget,
                sipTransferObj);

        if (!vobj)
        {
            Py_DECREF(kobj);
            Py_DECREF(d);

            return 0;
        }

        int rc = PyDict_SetItem(d, kobj, vobj);

        Py_DECREF(vobj);
        Py_DECREF(kobj);

        if (rc < 0)
        {
            Py_DECREF(d);

            return 0;
        }

        ++it;
    }
    
    return d;
%End

%ConvertToTypeCode
    if (!sipIsErr)
            return PyDict_Check(sipPy);

    QMap<QString, ads::CDockWidget*> *qm = new QMap<QString, ads::CDockWidget*>;
    
    Py_ssize_t pos = 0;
    PyObject *kobj, *vobj;
    while (PyDict_Next(sipPy, &pos, &kobj, &vobj))
    {
        int kstate;
        QString *k = reinterpret_cast<QString *>(
                sipForceConvertToType(kobj, sipType_QString, sipTransferObj,
                        SIP_NOT_NONE, &kstate, sipIsErr));

        if (*sipIsErr)
        {
            PyErr_Format(PyExc_TypeError,
                    "a dict key has type '%s' but '_TYPE1_' is expected",
                    sipPyTypeName(Py_TYPE(kobj)));

            delete qm;

            return 0;
        }

        int vstate;
        ads::CDockWidget *v = reinterpret_cast<ads::CDockWidget *>(
                sipForceConvertToType(vobj, sipType_ads_CDockWidget, sipTransferObj,
                        SIP_NOT_NONE, &vstate, sipIsErr));

        if (*sipIsErr)
        {
            PyErr_Format(PyExc_TypeError,
                    "a dict value has type '%s' but '_TYPE2_' is expected",
                    sipPyTypeName(Py_TYPE(vobj)));

            sipReleaseType(k, sipType_QString, kstate);
            delete qm;

            return 0;
        }

        qm->insert(*k, v);

        sipReleaseType(v, sipType_ads_CDockWidget, vstate);
        sipReleaseType(k, sipType_QString, kstate);
    }
 
    *sipCppPtr = qm;
 
    return sipGetState(sipTransferObj);
%End
};

namespace ads
{

class CDockManager : ads::CDockContainerWidget
{
    
    %TypeHeaderCode
    #include <DockManager.h>
    %End

protected:
	void registerFloatingWidget(ads::CFloatingDockContainer* FloatingWidget /Transfer/);
	void removeFloatingWidget(ads::CFloatingDockContainer* FloatingWidget) /TransferBack/;
	void registerDockContainer(ads::CDockContainerWidget* DockContainer /Transfer/);
	void removeDockContainer(ads::CDockContainerWidget* DockContainer /TransferBack/);
	ads::CDockOverlay* containerOverlay() const;
	ads::CDockOverlay* dockAreaOverlay() const;
    void notifyWidgetOrAreaRelocation(QWidget* RelocatedWidget);
    void notifyFloatingWidgetDrop(ads::CFloatingDockContainer* FloatingWidget);

    virtual void showEvent(QShowEvent *event);

public:
	enum eViewMenuInsertionOrder
	{
		MenuSortedByInsertion,
		MenuAlphabeticallySorted
	};

	enum eConfigFlag
	{
		ActiveTabHasCloseButton,
		DockAreaHasCloseButton,
		DockAreaCloseButtonClosesTab,
		OpaqueSplitterResize,
		XmlAutoFormattingEnabled,
		XmlCompressionEnabled,
		TabCloseButtonIsToolButton,
		AllTabsHaveCloseButton,
		RetainTabSizeWhenCloseButtonHidden,
		OpaqueUndocking,
		DragPreviewIsDynamic,
		DragPreviewShowsContentPixmap,
		DragPreviewHasWindowFrame,
		AlwaysShowTabs,
		DockAreaHasUndockButton,
		DockAreaHasTabsMenuButton,
		DockAreaHideDisabledButtons,
		DockAreaDynamicTabsMenuButtonVisibility,
		FloatingContainerHasWidgetTitle,
		FloatingContainerHasWidgetIcon,
		HideSingleCentralWidgetTitleBar,
        FocusHighlighting,
        EqualSplitOnInsertion,
        FloatingContainerForceNativeTitleBar,
        FloatingContainerForceQWidgetTitleBar,
        MiddleMouseButtonClosesTab,
        DefaultDockAreaButtons,
		DefaultBaseConfig,
        DefaultOpaqueConfig,
		DefaultNonOpaqueConfig,
		NonOpaqueWithWindowFrame,
	};
    typedef QFlags<ads::CDockManager::eConfigFlag> ConfigFlags;

	CDockManager(QWidget* parent /TransferThis/ = 0);
	virtual ~CDockManager();
	static ads::CDockManager::ConfigFlags configFlags();
	static void setConfigFlags(const ads::CDockManager::ConfigFlags Flags);
	static void setConfigFlag(ads::CDockManager::eConfigFlag Flag, bool On = true);
	static bool testConfigFlag(eConfigFlag Flag);
    static ads::CIconProvider& iconProvider();
	ads::CDockAreaWidget* addDockWidget(ads::DockWidgetArea area, ads::CDockWidget* Dockwidget /Transfer/,
		ads::CDockAreaWidget* DockAreaWidget /Transfer/ = 0);
	ads::CDockAreaWidget* addDockWidgetTab(ads::DockWidgetArea area,
		ads::CDockWidget* Dockwidget /Transfer/);
	ads::CDockAreaWidget* addDockWidgetTabToArea(ads::CDockWidget* Dockwidget /Transfer/,
		ads::CDockAreaWidget* DockAreaWidget /Transfer/);
    ads::CFloatingDockContainer* addDockWidgetFloating(ads::CDockWidget* DockWidget /Transfer/);
	ads::CDockWidget* findDockWidget(const QString& ObjectName) const;
	void removeDockWidget(ads::CDockWidget* Dockwidget) /TransferBack/;
	QMap<QString, ads::CDockWidget*> dockWidgetsMap() const;
	const QList<ads::CDockContainerWidget*> dockContainers() const;
	const QList<ads::CFloatingDockContainer*> floatingWidgets() const;
	unsigned int zOrderIndex() const;
	QByteArray saveState(int version = 0) const;
	bool restoreState(const QByteArray &state, int version = 0);
	void addPerspective(const QString& UniquePrespectiveName);
	void removePerspective(const QString& Name);
	void removePerspectives(const QStringList& Names);
	QStringList perspectiveNames() const;
	void savePerspectives(QSettings& Settings) const;
	void loadPerspectives(QSettings& Settings);
    CDockWidget* centralWidget() const;
    CDockAreaWidget* setCentralWidget(CDockWidget* widget /Transfer/);
	QAction* addToggleViewActionToMenu(QAction* ToggleViewAction /Transfer/,
		const QString& Group = QString(), const QIcon& GroupIcon = QIcon());
	QMenu* viewMenu() const;
	void setViewMenuInsertionOrder(ads::CDockManager::eViewMenuInsertionOrder Order);
	bool isRestoringState() const;
	static int startDragDistance();
    ads::CDockWidget* focusedDockWidget() const;
    QList<int> splitterSizes(ads::CDockAreaWidget *ContainedArea) const;
    void setSplitterSizes(ads::CDockAreaWidget *ContainedArea, const QList<int>& sizes);

public slots:
	void openPerspective(const QString& PerspectiveName);
    void setDockWidgetFocused(ads::CDockWidget* DockWidget);

signals:
	void perspectiveListChanged();
	void perspectivesRemoved();
	void restoringState();
    void stateRestored();
    void openingPerspective(const QString& PerspectiveName);
    void perspectiveOpened(const QString& PerspectiveName);
	void floatingWidgetCreated(ads::CFloatingDockContainer*);
    void dockAreaCreated(ads::CDockAreaWidget*);
    void dockWidgetAdded(ads::CDockWidget* DockWidget);
    void dockWidgetAboutToBeRemoved(ads::CDockWidget*);
    void dockWidgetRemoved(ads::CDockWidget*);
    void focusedDockWidgetChanged(ads::CDockWidget*, ads::CDockWidget*);
};

};

%End