File: DockWidget.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 (134 lines) | stat: -rw-r--r-- 3,763 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
%Import QtWidgets/QtWidgetsmod.sip

%If (Qt_5_0_0 -)

namespace ads
{

class CDockWidget : QFrame
{
    %TypeHeaderCode
    #include <DockWidget.h>
    %End
    
protected:
    void setDockManager(ads::CDockManager* DockManager /Transfer/ );
    void setDockArea(ads::CDockAreaWidget* DockArea /Transfer/ );
    void setToggleViewActionChecked(bool Checked);
    void saveState(QXmlStreamWriter& Stream) const;
    void flagAsUnassigned();
    static void emitTopLevelEventForWidget(ads::CDockWidget* TopLevelDockWidget, bool Floating);
    void emitTopLevelChanged(bool Floating);
    void setClosedState(bool Closed);
    void toggleViewInternal(bool Open);
    bool closeDockWidgetInternal(bool ForceClose = false);
    
public:
	enum DockWidgetFeature
	{
		DockWidgetClosable,
		DockWidgetMovable,
		DockWidgetFloatable,
		DockWidgetDeleteOnClose,
        CustomCloseHandling,
        DockWidgetFocusable,
        DockWidgetForceCloseWithArea,
        NoTab,
        DeleteContentOnClose,
        DefaultDockWidgetFeatures,
        AllDockWidgetFeatures,
        DockWidgetAlwaysCloseAndDelete,
		NoDockWidgetFeatures
	};
    typedef QFlags<ads::CDockWidget::DockWidgetFeature> DockWidgetFeatures;

	enum eState
	{
		StateHidden,
		StateDocked,
		StateFloating
	};

	enum eInsertMode
	{
		AutoScrollArea,
		ForceScrollArea,
		ForceNoScrollArea
	};
	
    enum eMinimumSizeHintMode
    {
    	MinimumSizeHintFromDockWidget,
    	MinimumSizeHintFromContent
    };

	enum eToggleViewActionMode
	{
		ActionModeToggle,
		ActionModeShow
	};


	CDockWidget(const QString &title, QWidget* parent /TransferThis/ = 0);
	virtual ~CDockWidget();
	virtual QSize minimumSizeHint() const;
	void setWidget(QWidget* widget /Transfer/, ads::CDockWidget::eInsertMode InsertMode = AutoScrollArea);
	QWidget* takeWidget() /TransferBack/;
	QWidget* widget() const;
	ads::CDockWidgetTab* tabWidget() const;
	void setFeatures(ads::CDockWidget::DockWidgetFeatures features);
	void setFeature(ads::CDockWidget::DockWidgetFeature flag, bool on);
	ads::CDockWidget::DockWidgetFeatures features() const;
	ads::CDockManager* dockManager() const;
	ads::CDockContainerWidget* dockContainer() const;
	ads::CDockAreaWidget* dockAreaWidget() const;
	bool isFloating() const;
	bool isInFloatingContainer() const;
	bool isClosed() const;
	QAction* toggleViewAction() const;
	void setToggleViewActionMode(ads::CDockWidget::eToggleViewActionMode Mode);
	void setMinimumSizeHintMode(ads::CDockWidget::eMinimumSizeHintMode Mode);
    bool isCentralWidget() const;
	void setIcon(const QIcon& Icon);
	QIcon icon() const;
	QToolBar* toolBar() const;
	QToolBar* createDefaultToolBar();
	void setToolBar(QToolBar* ToolBar /Transfer/ );
	void setToolBarStyle(Qt::ToolButtonStyle Style, ads::CDockWidget::eState State);
	Qt::ToolButtonStyle toolBarStyle(ads::CDockWidget::eState State) const;
	void setToolBarIconSize(const QSize& IconSize, ads::CDockWidget::eState State);
	QSize toolBarIconSize(eState State) const;
    void setTitleBarActions(QList<QAction*> actions);
    virtual QList<QAction*> titleBarActions() const;

	void setTabToolTip(const QString &text);
    bool isFullScreen() const;
    bool isTabbed() const;
    bool isCurrentTab() const;

public:
	virtual bool event(QEvent *e);

public slots:
	void toggleView(bool Open = true);
	void setAsCurrentTab();
	void raise();
    void setFloating();
    void deleteDockWidget();
    void closeDockWidget();
    void showFullScreen();
    void showNormal();

signals:
	void viewToggled(bool Open);
	void closed();
	void titleChanged(const QString& Title);
	void topLevelChanged(bool topLevel);
    void closeRequested();
	void visibilityChanged(bool visible);
    void featuresChanged(ads::CDockWidget::DockWidgetFeatures features);
};

};

%End