summaryrefslogtreecommitdiffstats
path: root/sip/kdeui/kdockwidget.sip
blob: c65d398557921eb034483cf1a966e3591814daed (plain)
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
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
//
//     Copyright 2006 Jim Bublitz <jbublitz@nwinternet.com>
//     Earlier copyrights 1998 - 2005 Jim Bublitz and/or Phil Thompson
//     may also apply


//                 Generated by preSip
//            module tdeui  version KDE 3.5.3


// This software 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; either version 2 of
// the License, or (at your option) any later version.
//
// This software 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 library; see the file COPYING.
// If not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.


class KDockWidgetAbstractHeader : QFrame
{
%TypeHeaderCode
#include <kdockwidget.h>
%End


public:
                         KDockWidgetAbstractHeader (KDockWidget* /TransferThis/, const char* = 0);
    virtual void         setTopLevel (bool);
    virtual void         saveConfig (KConfig*);
    virtual void         loadConfig (KConfig*);

protected:
//igx     virtual void         virtual_hook (int, void*);

};  // class KDockWidgetAbstractHeader


class KDockWidgetAbstractHeaderDrag : QFrame
{
%TypeHeaderCode
#include <kdockwidget.h>
%End


public:
                         KDockWidgetAbstractHeaderDrag (KDockWidgetAbstractHeader* /TransferThis/, KDockWidget*, const char* = 0);
    KDockWidget*         dockWidget ();

protected:
//igx     virtual void         virtual_hook (int, void*);

};  // class KDockWidgetAbstractHeaderDrag


class KDockWidgetHeaderDrag : KDockWidgetAbstractHeaderDrag
{
%TypeHeaderCode
#include <kdockwidget.h>
%End


public:
                         KDockWidgetHeaderDrag (KDockWidgetAbstractHeader* /TransferThis/, KDockWidget*, const char* = 0);

protected:
    virtual void         paintEvent (QPaintEvent*);

protected:
//igx     virtual void         virtual_hook (int, void*);

};  // class KDockWidgetHeaderDrag


class KDockWidgetHeader : KDockWidgetAbstractHeader
{
%TypeHeaderCode
#include <kdockwidget.h>
%End


public:
                         KDockWidgetHeader (KDockWidget* /TransferThis/, const char* = 0);
    virtual void         setTopLevel (bool);
    void                 setDragPanel (KDockWidgetHeaderDrag*);

%If ( KDE_3_4_0 -  )
    KDockWidgetHeaderDrag* dragPanel ();
%End

    bool                 dragEnabled ();
    void                 setDragEnabled (bool);

%If ( KDE_3_1_0 -  )
    void                 showUndockButton (bool);

%If ( KDE_3_2_0 -  )
    void                 forceCloseButtonHidden (bool = 1);
%End

%End

    virtual void         saveConfig (KConfig*);
    virtual void         loadConfig (KConfig*);

%If ( KDE_3_2_0 -  )
//ig     void                 addButton (KDockButton_Private*);
//ig     void                 removeButton (KDockButton_Private*);
%End


protected slots:
    void                 slotStayClicked ();

protected:

protected:
//igx     virtual void         virtual_hook (int, void*);

};  // class KDockWidgetHeader


class KDockTabGroup : QTabWidget
{
%TypeHeaderCode
#include <kdockwidget.h>
%End


public:
                         KDockTabGroup (QWidget* /TransferThis/ = 0, const char* = 0);

%If ( KDE_3_2_0 -  )
    QWidget*             transientTo ();
%End


protected:
//igx     virtual void         virtual_hook (int, void*);

};  // class KDockTabGroup


class KDockWidget : QWidget
{
%TypeHeaderCode
#include <kdockwidget.h>
%End


public:
                         KDockWidget (KDockManager*, const char*, const QPixmap&, QWidget* /TransferThis/ = 0, const QString& = 0, const QString& = " ", WFlags = 0);

%If ( KDE_3_1_0 -  )

    enum DockPosition
    {
        DockNone, 
        DockTop, 
        DockLeft, 
        DockRight, 
        DockBottom, 
        DockCenter, 
        DockDesktop, 
        DockToSpecialSites, 
        DockCorner, 
        DockFullSite, 
        DockFullDocking
    };

%End

    KDockWidget*         manualDock (KDockWidget*, KDockWidget::DockPosition, int = 50, QPoint = QPoint (0 ,0 ), bool = 0, int = -1);
    void                 setEnableDocking (int);
    int                  enableDocking ();
    void                 setDockSite (int);
    int                  dockSite ();
    void                 setWidget (QWidget*);
    QWidget*             getWidget ();
    void                 setHeader (KDockWidgetAbstractHeader*);

%If ( KDE_3_2_0 -  )
    KDockWidgetAbstractHeader* getHeader ();
%End

    void                 makeDockVisible ();
    bool                 mayBeHide ();
    bool                 mayBeShow ();
    KDockManager*        dockManager ();
    void                 setToolTipString (const QString&);
    const QString&       toolTipString ();
    bool                 isDockBackPossible ();
    void                 setTabPageLabel (const QString&);
    const QString&       tabPageLabel ();
    virtual bool         event (QEvent*);
    virtual void         show ();
    KDockTabGroup*       parentDockTabGroup ();

%If ( KDE_3_1_0 -  )
    QWidget*             parentDockContainer () const;
%End

    void                 setDockWindowType (NET::WindowType);
    void                 setDockWindowTransient (QWidget* /Transfer/, bool);

%If ( KDE_3_2_0 -  )
    QWidget*             transientTo ();
%End


%If ( KDE_3_1_0 -  )
    KDockWidget*         findNearestDockWidget (KDockWidget::DockPosition);

%If ( KDE_3_2_0 -  )
    void                 setPixmap (const QPixmap& = QPixmap ());
    const QPixmap&       pixmap () const;

%If ( KDE_3_3_0 -  )
    KDockWidget::DockPosition currentDockPosition () const;
%End

%End

%End


public slots:

%If ( KDE_3_1_0 -  )
    void                 setForcedFixedWidth (int);
    void                 setForcedFixedHeight (int);
    void                 restoreFromForcedFixedSize ();
    int                  forcedFixedWidth ();
    int                  forcedFixedHeight ();
%End

    void                 dockBack ();
    void                 changeHideShowState ();
    void                 undock ();

%If ( KDE_3_1_0 -  )
    void                 toDesktop ();
%End


protected:
    void                 updateHeader ();

%If ( KDE_3_1_0 -  )
    void                 setLatestKDockContainer (QWidget*);
    QWidget*             latestKDockContainer ();

%If ( KDE_3_2_1 -  )
    void                 setFormerBrotherDockWidget (KDockWidget*);
%End

%End


signals:

%If ( KDE_3_2_0 -  )
    void                 widgetSet (QWidget*);
%End

    void                 docking (KDockWidget*, KDockWidget::DockPosition);
    void                 setDockDefaultPos ();
    void                 headerCloseButtonClicked ();
    void                 headerDockbackButtonClicked ();
    void                 iMBeingClosed ();
    void                 hasUndocked ();

protected slots:
    void                 loseFormerBrotherDockWidget ();

%If ( KDE_3_1_0 -  )
    virtual void         paintEvent (QPaintEvent*);
    virtual void         mousePressEvent (QMouseEvent*);
    virtual void         mouseReleaseEvent (QMouseEvent*);
    virtual void         mouseMoveEvent (QMouseEvent*);
    virtual void         leaveEvent (QEvent*);
%End


protected:

protected:
//igx     virtual void         virtual_hook (int, void*);

public:

%If (  - KDE_3_1_0 )

    enum DockPosition
    {
        DockNone, 
        DockTop, 
        DockLeft, 
        DockRight, 
        DockBottom, 
        DockCenter, 
        DockDesktop, 
        DockCorner, 
        DockFullSite, 
        DockFullDocking
    };

%End


};  // class KDockWidget


class KDockManager : QObject
{
%TypeHeaderCode
#include <kdockwidget.h>
%End


public:

%If ( KDE_3_2_0 -  )

    enum EnReadDockConfigMode
    {
        Unknown, 
        WrapExistingWidgetsOnly, 
        RestoreAllDockwidgets
    };

%End


public:
                         KDockManager (QWidget*, const char* = 0);

%If ( KDE_3_2_0 -  )
    void                 dumpDockWidgets ();
%End

    void                 writeConfig (KConfig* = 0, QString = QString ::null );
    void                 readConfig (KConfig* = 0, QString = QString ::null );

%If ( KDE_3_1_0 -  )
    void                 setMainDockWidget2 (KDockWidget*);
%End

    void                 writeConfig (QDomElement&);
    void                 readConfig (QDomElement&);
    void                 activate ();
    virtual bool         eventFilter (QObject*, QEvent*);
    KDockWidget*         findWidgetParentDock (QWidget*);
    void                 makeWidgetDockVisible (QWidget*);
    QPopupMenu*          dockHideShowMenu ();
    KDockWidget*         getDockWidgetFromName (const QString&);
    void                 setSplitterOpaqueResize (bool = 1);
    bool                 splitterOpaqueResize () const;
    void                 setSplitterKeepSize (bool = 1);
    bool                 splitterKeepSize () const;
    void                 setSplitterHighResolution (bool = 1);
    bool                 splitterHighResolution () const;

%If ( KDE_3_2_0 -  )
    void                 setSpecialLeftDockContainer (KDockWidget*);
    void                 setSpecialTopDockContainer (KDockWidget*);
    void                 setSpecialRightDockContainer (KDockWidget*);
    void                 setSpecialBottomDockContainer (KDockWidget*);
    void                 removeFromAutoCreateList (KDockWidget*);
    void                 finishReadDockConfig ();
    void                 setReadDockConfigMode (int);
%End


signals:
    void                 change ();
    void                 replaceDock (KDockWidget*, KDockWidget*);
    void                 setDockDefaultPos (KDockWidget*);

protected:
//igx     virtual void         virtual_hook (int, void*);

};  // class KDockManager


class KDockMainWindow : KMainWindow
{
%TypeHeaderCode
#include <kdockwidget.h>
%End


public:
                         KDockMainWindow (QWidget* /TransferThis/ = 0, const char* = 0, WFlags = WType_TopLevel |WDestructiveClose );
    KDockManager*        manager ();
    void                 setMainDockWidget (KDockWidget*);
    KDockWidget*         getMainDockWidget ();
    KDockWidget*         createDockWidget (const QString&, const QPixmap&, QWidget* /Transfer/ = 0, const QString& = 0, const QString& = " ");
    void                 writeDockConfig (QDomElement&);
    void                 readDockConfig (QDomElement&);
    void                 writeDockConfig (KConfig* = 0, QString = QString ::null );
    void                 readDockConfig (KConfig* = 0, QString = QString ::null );
    void                 activateDock ();
    QPopupMenu*          dockHideShowMenu ();
    void                 makeDockVisible (KDockWidget*);
    void                 makeDockInvisible (KDockWidget*);
    void                 makeWidgetDockVisible (QWidget*);
    void                 setView (QWidget*);

signals:
    void                 dockWidgetHasUndocked (KDockWidget*);

protected:

protected slots:
    void                 slotDockWidgetUndocked ();

protected:
//igx     virtual void         virtual_hook (int, void*);

};  // class KDockMainWindow


class KDockArea : QWidget
{
%TypeHeaderCode
#include <kdockwidget.h>
%End


public:
                         KDockArea (QWidget* /TransferThis/ = 0, const char* = 0);
    KDockManager*        manager ();
    void                 setMainDockWidget (KDockWidget*);
    KDockWidget*         getMainDockWidget ();
    KDockWidget*         createDockWidget (const QString&, const QPixmap&, QWidget* /Transfer/ = 0, const QString& = 0, const QString& = " ");
    void                 writeDockConfig (QDomElement&);
    void                 readDockConfig (QDomElement&);
    void                 writeDockConfig (KConfig* = 0, QString = QString ::null );
    void                 readDockConfig (KConfig* = 0, QString = QString ::null );
    void                 activateDock ();
    QPopupMenu*          dockHideShowMenu ();
    void                 makeDockVisible (KDockWidget*);
    void                 makeDockInvisible (KDockWidget*);
    void                 makeWidgetDockVisible (QWidget*);

signals:
    void                 dockWidgetHasUndocked (KDockWidget*);

protected:

protected slots:
    void                 slotDockWidgetUndocked ();

public:
    virtual void         resizeEvent (QResizeEvent*);

protected:
//igx     virtual void         virtual_hook (int, void*);

};  // class KDockArea