.TH "KDockWidget" kde3 "11 Jun 2005" "Version Version 3.4.1" "kdeui Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KDockWidget \- Floatable widget that can be dragged around with the mouse and encapsulate the actual widgets (and member of the dockwidget class set).  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kdockwidget.h>\fP
.PP
Inherits \fBQWidget\fP.
.PP
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBDockPosition\fP { \fBDockNone\fP =  0, \fBDockTop\fP =  0x0001, \fBDockLeft\fP =  0x0002, \fBDockRight\fP =  0x0004, \fBDockBottom\fP =  0x0008, \fBDockCenter\fP =  0x0010, \fBDockDesktop\fP =  0x0020, \fBDockToSpecialSites\fP = 0x0040, \fBDockCorner\fP =  DockTop | DockLeft | DockRight | DockBottom, \fBDockFullSite\fP =  DockCorner | DockCenter, \fBDockFullDocking\fP =  DockFullSite | DockDesktop }"
.br
.in -1c
.SS "Public Slots"

.in +1c
.ti -1c
.RI "void \fBsetForcedFixedWidth\fP (int)"
.br
.ti -1c
.RI "void \fBsetForcedFixedHeight\fP (int)"
.br
.ti -1c
.RI "void \fBrestoreFromForcedFixedSize\fP ()"
.br
.ti -1c
.RI "int \fBforcedFixedWidth\fP ()"
.br
.ti -1c
.RI "int \fBforcedFixedHeight\fP ()"
.br
.ti -1c
.RI "void \fBdockBack\fP ()"
.br
.ti -1c
.RI "void \fBchangeHideShowState\fP ()"
.br
.ti -1c
.RI "void \fBundock\fP ()"
.br
.ti -1c
.RI "void \fBtoDesktop\fP ()"
.br
.in -1c
.SS "Signals"

.in +1c
.ti -1c
.RI "void \fBwidgetSet\fP (\fBQWidget\fP *)"
.br
.ti -1c
.RI "void \fBdocking\fP (\fBKDockWidget\fP *dw, \fBKDockWidget::DockPosition\fP dp)"
.br
.ti -1c
.RI "void \fBsetDockDefaultPos\fP ()"
.br
.ti -1c
.RI "void \fBheaderCloseButtonClicked\fP ()"
.br
.ti -1c
.RI "void \fBheaderDockbackButtonClicked\fP ()"
.br
.ti -1c
.RI "void \fBiMBeingClosed\fP ()"
.br
.ti -1c
.RI "void \fBhasUndocked\fP ()"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKDockWidget\fP (\fBKDockManager\fP *dockManager, const char *name, const \fBQPixmap\fP &pixmap, \fBQWidget\fP *parent=0L, const \fBQString\fP &strCaption=QString::null, const \fBQString\fP &strTabPageLabel=\fBQString::fromLatin1\fP(' '), WFlags f=0)"
.br
.ti -1c
.RI "virtual \fB~KDockWidget\fP ()"
.br
.ti -1c
.RI "\fBKDockWidget\fP * \fBmanualDock\fP (\fBKDockWidget\fP *target, \fBDockPosition\fP dockPos, int spliPos=50, \fBQPoint\fP \fBpos\fP=\fBQPoint\fP(0, 0), bool check=false, int tabIndex=-1)"
.br
.ti -1c
.RI "void \fBsetEnableDocking\fP (int \fBpos\fP)"
.br
.ti -1c
.RI "int \fBenableDocking\fP () const "
.br
.ti -1c
.RI "void \fBsetDockSite\fP (int \fBpos\fP)"
.br
.ti -1c
.RI "int \fBdockSite\fP () const "
.br
.ti -1c
.RI "void \fBsetWidget\fP (\fBQWidget\fP *w)"
.br
.ti -1c
.RI "\fBQWidget\fP * \fBgetWidget\fP () const "
.br
.ti -1c
.RI "void \fBsetHeader\fP (\fBKDockWidgetAbstractHeader\fP *ah)"
.br
.ti -1c
.RI "\fBKDockWidgetAbstractHeader\fP * \fBgetHeader\fP ()"
.br
.ti -1c
.RI "void \fBmakeDockVisible\fP ()"
.br
.ti -1c
.RI "bool \fBmayBeHide\fP () const "
.br
.ti -1c
.RI "bool \fBmayBeShow\fP () const "
.br
.ti -1c
.RI "\fBKDockManager\fP * \fBdockManager\fP () const "
.br
.ti -1c
.RI "void \fBsetToolTipString\fP (const \fBQString\fP &ttStr)"
.br
.ti -1c
.RI "const \fBQString\fP & \fBtoolTipString\fP () const "
.br
.ti -1c
.RI "bool \fBisDockBackPossible\fP () const "
.br
.ti -1c
.RI "void \fBsetTabPageLabel\fP (const \fBQString\fP &label)"
.br
.ti -1c
.RI "const \fBQString\fP & \fBtabPageLabel\fP () const "
.br
.ti -1c
.RI "virtual bool \fBevent\fP (\fBQEvent\fP *)"
.br
.ti -1c
.RI "virtual void \fBshow\fP ()"
.br
.ti -1c
.RI "\fBKDockTabGroup\fP * \fBparentDockTabGroup\fP () const "
.br
.ti -1c
.RI "\fBQWidget\fP * \fBparentDockContainer\fP () const "
.br
.ti -1c
.RI "void \fBsetDockWindowType\fP (\fBNET::WindowType\fP windowType)"
.br
.ti -1c
.RI "void \fBsetDockWindowTransient\fP (\fBQWidget\fP *parent, bool transientEnabled)"
.br
.ti -1c
.RI "\fBQWidget\fP * \fBtransientTo\fP ()"
.br
.ti -1c
.RI "\fBKDockWidget\fP * \fBfindNearestDockWidget\fP (\fBDockPosition\fP \fBpos\fP)"
.br
.ti -1c
.RI "void \fBsetPixmap\fP (const \fBQPixmap\fP &pixmap=\fBQPixmap\fP())"
.br
.ti -1c
.RI "const \fBQPixmap\fP & \fBpixmap\fP () const "
.br
.ti -1c
.RI "\fBKDockWidget::DockPosition\fP \fBcurrentDockPosition\fP () const "
.br
.in -1c
.SS "Protected Slots"

.in +1c
.ti -1c
.RI "void \fBloseFormerBrotherDockWidget\fP ()"
.br
.ti -1c
.RI "virtual void \fBpaintEvent\fP (\fBQPaintEvent\fP *)"
.br
.ti -1c
.RI "virtual void \fBmousePressEvent\fP (\fBQMouseEvent\fP *)"
.br
.ti -1c
.RI "virtual void \fBmouseReleaseEvent\fP (\fBQMouseEvent\fP *)"
.br
.ti -1c
.RI "virtual void \fBmouseMoveEvent\fP (\fBQMouseEvent\fP *)"
.br
.ti -1c
.RI "virtual void \fBleaveEvent\fP (\fBQEvent\fP *)"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "void \fBupdateHeader\fP ()"
.br
.ti -1c
.RI "void \fBsetLatestKDockContainer\fP (\fBQWidget\fP *)"
.br
.ti -1c
.RI "\fBQWidget\fP * \fBlatestKDockContainer\fP ()"
.br
.ti -1c
.RI "void \fBsetFormerBrotherDockWidget\fP (\fBKDockWidget\fP *)"
.br
.ti -1c
.RI "virtual void \fBvirtual_hook\fP (int id, void *data)"
.br
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "\fBKDockWidget\fP * \fBformerBrotherDockWidget\fP"
.br
.ti -1c
.RI "\fBDockPosition\fP \fBcurrentDockPos\fP"
.br
.ti -1c
.RI "\fBDockPosition\fP \fBformerDockPos\fP"
.br
.ti -1c
.RI "\fBQString\fP \fBtoolTipStr\fP"
.br
.ti -1c
.RI "\fBQString\fP \fBtabPageTitle\fP"
.br
.in -1c
.SS "Friends"

.in +1c
.ti -1c
.RI "class \fBKDockManager\fP"
.br
.ti -1c
.RI "class \fBKDockSplitter\fP"
.br
.ti -1c
.RI "class \fBKDockMainWindow\fP"
.br
.ti -1c
.RI "class \fBKDockArea\fP"
.br
.ti -1c
.RI "class \fBKMdiMainFrm\fP"
.br
.ti -1c
.RI "class \fBKMDI::MainWindow\fP"
.br
.ti -1c
.RI "class \fBKDockWidgetHeader\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
Floatable widget that can be dragged around with the mouse and encapsulate the actual widgets (and member of the dockwidget class set). 

You just grip the double-lined panel, tear it off its parent widget, drag it somewhere and let it loose. Depending on the position where you leave it, the dockwidget becomes a toplevel window on the desktop (floating mode) or docks to a new widget (dock mode). Note: A KDockWidget can only be docked to a KDockWidget.
.PP
If you want to use this kind of widget, your main application window has to be a \fBKDockMainWindow\fP. That is because it has got several additional dock management features, for instance a \fBKDockManager\fP that has an overview over all dockwidgets and and a dockmovemanager (internal class) that handles the dock process.
.PP
Usually you create an KDockWidget that covers the actual widget in this way: 
.PP
.nf
 ...
 KDockMainWindow* mainWidget;
 ...
 KDockWidget* dock = 0L;
 dock = mainWidget->createDockWidget( 'Any window caption', nicePixmap, 0L, i18n('window caption')); // 0L==no parent
 QWidget* actualWidget = new QWidget( dock);
 dock->setWidget( actualWidget); // embed it
 dock->setToolTipString(i18n('That's me')); // available when appearing as tab page
 ...

.fi
.PP
.PP
See \fBKDockMainWindow\fP how a dockwidget is docked in.
.PP
\fBAuthor:\fP
.RS 4
Max Judin (documentation: Falk Brettschneider). 
.RE
.PP

.PP
Definition at line 423 of file kdockwidget.h.
.SH "Member Enumeration Documentation"
.PP 
.SS "\fBenum\fP \fBKDockWidget::DockPosition\fP"
.PP
The possible positions where a dockwidget can dock to another dockwidget. 
.PP
\fBEnumeration values: \fP
.in +1c
.TP
\fB\fIDockToSpecialSites \fP\fP
\fBSince:\fP
.RS 4
3.1 
.RE
.PP

.PP
Definition at line 459 of file kdockwidget.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KDockWidget::KDockWidget (\fBKDockManager\fP * dockManager, const char * name, const \fBQPixmap\fP & pixmap, \fBQWidget\fP * parent = \fC0L\fP, const \fBQString\fP & strCaption = \fCQString::null\fP, const \fBQString\fP & strTabPageLabel = \fC\fBQString::fromLatin1\fP(' ')\fP, WFlags f = \fC0\fP)"
.PP
Construct a dockwidget. 
.PP
Initially, docking to another and docking to this is allowed for every \fCDockPosition\fP. It is supposed to be no (tab) group. It will taken under control of its dockmanager.
.PP
\fBParameters:\fP
.RS 4
\fIdockManager\fP The responsible manager (dock helper) 
.br
\fIname\fP Object instance name 
.br
\fIpixmap\fP An icon (for instance shown when docked centered) 
.br
\fIparent\fP Parent widget 
.br
\fIstrCaption\fP Title of the dockwidget window (shown when toplevel) 
.br
\fIstrTabPageLabel\fP The title of the tab page (shown when in tab page mode), if it is '', only the icon will be shown, if it is 0L, the label is set to strCaption 
.br
\fIf\fP Qt::WidgetFlags widget flags 
.RE
.PP

.PP
Definition at line 482 of file kdockwidget.cpp.
.PP
References QObject::connect(), and QObject::installEventFilter().
.PP
Referenced by manualDock().
.SS "KDockWidget::~\fBKDockWidget\fP ()\fC [virtual]\fP"
.PP
Destructs a dockwidget. 
.PP
Definition at line 552 of file kdockwidget.cpp.
.PP
References KDockWidgetPrivate::blockHasUndockedSignal, KDockManager::childDock, KDockManager::d, iMBeingClosed(), latestKDockContainer(), KDockWidgetPrivate::pendingDtor, undock(), and KDockManager::undockProcess.
.SH "Member Function Documentation"
.PP 
.SS "\fBKDockWidget\fP * KDockWidget::manualDock (\fBKDockWidget\fP * target, \fBDockPosition\fP dockPos, int spliPos = \fC50\fP, \fBQPoint\fP pos = \fC\fBQPoint\fP(0, 0)\fP, bool check = \fCfalse\fP, int tabIndex = \fC-1\fP)"
.PP
This is a key method of this class! Use it to dock dockwidgets to another dockwidget at the right position within its \fBKDockMainWindow\fP or a toplevel dockwidget. 
.PP
If the target is null, it will become a toplevel dockwidget at position pos; Note: Docking to another dockwidget means exactly: A new parent dockwidget will be created, that replaces the target dockwidget and contains another single helper widget (tab widget or panner) which contains both dockwidgets, this and the target dockwidget. So consider parent<->child relationships change completely during such actions.
.PP
\fBParameters:\fP
.RS 4
\fItarget\fP The dockwidget to dock to 
.br
\fIdockPos\fP One of the DockPositions this is going to dock to 
.br
\fIspliPos\fP The split relation (in percent, or percent*100 in high resolution) between both dockwidgets, target and this 
.br
\fIpos\fP The dock position, mainly of interest for docking to the desktop (as toplevel dockwidget) 
.br
\fIcheck\fP Only for internal use; 
.br
\fItabIndex\fP The position index of the tab widget (when in tab page mode), -1 (default) means append 
.RE
.PP
\fBReturns:\fP
.RS 4
result The group dockwidget that replaces the target dockwidget and will be grandparent of target and \fCthis\fP. 
.RE
.PP

.PP
Definition at line 948 of file kdockwidget.cpp.
.PP
References KDockSplitter::activate(), applyToWidget(), KDockWidgetPrivate::blockHasUndockedSignal, KDockManager::change(), QObject::connect(), currentDockPos, KDockManager::d, KDockSplitter::deactivate(), docking(), dockManager(), eDocking, formerBrotherDockWidget, formerDockPos, QWidget::geometry(), KDockSplitter::getFirst(), QWidget::icon(), QTabWidget::insertTab(), QString::isEmpty(), isGroup, isTabGroup, KDockWidget(), latestKDockContainer(), loseFormerBrotherDockWidget(), QWidget::move(), parentDockContainer(), parentDockTabGroup(), KDockManager::replaceDock(), QWidget::resize(), setDockWindowTransient(), QWidget::setFocusPolicy(), setFormerBrotherDockWidget(), QWidget::setGeometry(), KDockSplitter::setKeepSize(), setLatestKDockContainer(), KDockSplitter::setOpaqueResize(), QTabWidget::setTabToolTip(), setWidget(), QWidget::show(), show(), KDockManager::splitterHighResolution(), KDockManager::splitterKeepSize(), KDockManager::splitterOpaqueResize(), tabPageLabel(), toolTipStr, toolTipString(), KDockTabGroup::transientTo(), and undock().
.PP
Referenced by dockBack(), KDockManager::readConfig(), and toDesktop().
.SS "void KDockWidget::setEnableDocking (int pos)"
.PP
Specify where it is either possible or impossible for this to dock to another dockwidget. 
.PP
\fBParameters:\fP
.RS 4
\fIpos\fP An OR'ed set of \fCDockPositions\fP 
.RE
.PP

.PP
Definition at line 765 of file kdockwidget.cpp.
.PP
References updateHeader().
.PP
Referenced by setHeader().
.SS "int KDockWidget::enableDocking () const\fC [inline]\fP"
.PP
\fBReturns:\fP
.RS 4
Where it is either possible or impossible for this to dock to another dockwidget (an OR'ed set of DockPositions). 
.RE
.PP

.PP
Definition at line 505 of file kdockwidget.h.
.SS "void KDockWidget::setDockSite (int pos)\fC [inline]\fP"
.PP
Specify where it is either possible or impossible for another dockwidget to dock to this. 
.PP
\fBParameters:\fP
.RS 4
\fIpos\fP An OR'ed set of \fCDockPositions\fP 
.RE
.PP

.PP
Definition at line 512 of file kdockwidget.h.
.SS "int KDockWidget::dockSite () const\fC [inline]\fP"
.PP
\fBReturns:\fP
.RS 4
There it is either possible or impossible for another dockwidget to dock to this (an OR'ed set of \fCDockPositions\fP). 
.RE
.PP

.PP
Definition at line 517 of file kdockwidget.h.
.PP
Referenced by isDockBackPossible().
.SS "void KDockWidget::setWidget (\fBQWidget\fP * w)"
.PP
Sets the embedded widget. 
.PP
A \fBQLayout\fP takes care about proper resizing, automatically.
.PP
\fBParameters:\fP
.RS 4
\fIw\fP The pointer to the dockwidget's child widget. 
.RE
.PP

.PP
Definition at line 1430 of file kdockwidget.cpp.
.PP
References KDockManager::d, KDockWidgetPrivate::isContainer, updateHeader(), and widgetSet().
.PP
Referenced by manualDock(), and setHeader().
.SS "\fBQWidget\fP* KDockWidget::getWidget () const\fC [inline]\fP"
.PP
Get the embedded widget. 
.PP
\fBReturns:\fP
.RS 4
The pointer to the dockwidget's child widget, 0L if there's no such child. 
.RE
.PP

.PP
Definition at line 533 of file kdockwidget.h.
.PP
Referenced by findNearestDockWidget(), and KDockManager::readConfig().
.SS "void KDockWidget::setHeader (\fBKDockWidgetAbstractHeader\fP * ah)"
.PP
Sets the header of this dockwidget. 
.PP
A \fBQLayout\fP takes care about proper resizing, automatically. The header contains the drag panel, the close button and the stay button.
.PP
\fBParameters:\fP
.RS 4
\fIah\fP A base class pointer to the dockwidget header 
.RE
.PP

.PP
Definition at line 745 of file kdockwidget.cpp.
.PP
References QWidget::caption(), endl(), kdDebug(), setEnableDocking(), and setWidget().
.SS "\fBKDockWidgetAbstractHeader\fP * KDockWidget::getHeader ()"
.PP
\fBSince:\fP
.RS 4
3.2 get the pointer to the header widget 
.RE
.PP

.PP
Definition at line 741 of file kdockwidget.cpp.
.SS "void KDockWidget::makeDockVisible ()"
.PP
Normally it simply shows the dockwidget. 
.PP
But additionally, if it is docked to a tab widget (\fCDockCenter\fP), it is set as the active (visible) tab page. 
.PP
Definition at line 1516 of file kdockwidget.cpp.
.PP
References dockBack(), QWidget::isVisible(), parentDockContainer(), parentDockTabGroup(), QWidget::parentWidget(), show(), QWidget::show(), and QTabWidget::showPage().
.PP
Referenced by changeHideShowState(), dockBack(), KDockMainWindow::makeDockVisible(), KDockManager::makeWidgetDockVisible(), and show().
.SS "bool KDockWidget::mayBeHide () const"
.PP
\fBReturns:\fP
.RS 4
If it may be possible to hide this.
.RE
.PP
There are reasons that it's impossible: 
.PD 0

.IP "\(bu" 2
It is a (tab) group. 
.IP "\(bu" 2
It is already invisible ;-) 
.IP "\(bu" 2
The parent of this is the \fBKDockMainWindow\fP. 
.IP "\(bu" 2
It isn't able to dock to another widget. 
.PP

.PP
Definition at line 1488 of file kdockwidget.cpp.
.PP
References QWidget::isVisible(), and KDockManager::main.
.PP
Referenced by changeHideShowState().
.SS "bool KDockWidget::mayBeShow () const"
.PP
\fBReturns:\fP
.RS 4
If it may be possible to show this. There are reasons that it's impossible: 
.PD 0

.IP "\(bu" 2
It is a (tab) group. 
.IP "\(bu" 2
It is already visible ;-) 
.IP "\(bu" 2
The parent of this is the \fC\fBKDockMainWindow\fP\fP. 
.PP
.RE
.PP

.PP
Definition at line 1494 of file kdockwidget.cpp.
.PP
References QWidget::isVisible(), and KDockManager::main.
.PP
Referenced by changeHideShowState().
.SS "\fBKDockManager\fP* KDockWidget::dockManager () const\fC [inline]\fP"
.PP
\fBReturns:\fP
.RS 4
The dockmanager that is responsible for this. 
.RE
.PP

.PP
Definition at line 580 of file kdockwidget.h.
.PP
Referenced by manualDock().
.SS "void KDockWidget::setToolTipString (const \fBQString\fP & ttStr)\fC [inline]\fP"
.PP
Stores a string for a tooltip. 
.PP
That tooltip string has only a meaning when this dockwidget is shown as tab page. In this case the tooltip is shown when one holds the mouse cursor on the tab page header. Such tooltip will for instance be useful, if you use only icons there. Note: Setting an empty string switches the tooltip off.
.PP
\fBParameters:\fP
.RS 4
\fIttStr\fP A string for the tooltip on the tab. 
.RE
.PP

.PP
Definition at line 592 of file kdockwidget.h.
.PP
Referenced by KDockManager::readConfig().
.SS "const \fBQString\fP& KDockWidget::toolTipString () const\fC [inline]\fP"
.PP
\fBReturns:\fP
.RS 4
The tooltip string being shown on the appropriate tab page header when in dock-centered mode. 
.RE
.PP

.PP
Definition at line 597 of file kdockwidget.h.
.PP
Referenced by manualDock(), and KDockManager::writeConfig().
.SS "bool KDockWidget::isDockBackPossible () const"
.PP
\fBReturns:\fP
.RS 4
result \fCtrue\fP, if a dockback is possible, otherwise \fCfalse\fP. 
.RE
.PP

.PP
Definition at line 1590 of file kdockwidget.cpp.
.PP
References dockSite(), formerBrotherDockWidget, and formerDockPos.
.PP
Referenced by KDockWidgetHeader::setTopLevel().
.SS "void KDockWidget::setTabPageLabel (const \fBQString\fP & label)\fC [inline]\fP"
.PP
Sets a string that is used for the label of the tab page when in tab page mode. 
.PP
\fBParameters:\fP
.RS 4
\fIlabel\fP The new tab page label. 
.RE
.PP

.PP
Definition at line 608 of file kdockwidget.h.
.PP
Referenced by KDockManager::readConfig().
.SS "const \fBQString\fP& KDockWidget::tabPageLabel () const\fC [inline]\fP"
.PP
\fBReturns:\fP
.RS 4
A string that is used for the label of the tab page when in tab page mode. 
.RE
.PP

.PP
Definition at line 613 of file kdockwidget.h.
.PP
Referenced by event(), manualDock(), and KDockManager::writeConfig().
.SS "bool KDockWidget::event (\fBQEvent\fP *)\fC [virtual]\fP"
.PP
Catches and processes some \fBQWidget\fP events that are interesting for dockwidgets. 
.PP
Reimplemented from \fBQWidget\fP.
.PP
Definition at line 878 of file kdockwidget.cpp.
.PP
References KDockManager::change(), QWidget::event(), event(), QWidget::hide(), iMBeingClosed(), parentDockTabGroup(), QWidget::parentWidget(), KDockWidgetPrivate::pendingFocusInEvent, QWidget::setFocus(), QTabWidget::setTabLabel(), QWidget::show(), and tabPageLabel().
.PP
Referenced by event().
.SS "void KDockWidget::show ()\fC [virtual]\fP"
.PP
Add dockwidget management actions to \fBQWidget::show\fP. 
.PP
Reimplemented from \fBQWidget\fP.
.PP
Definition at line 841 of file kdockwidget.cpp.
.PP
References QWidget::isVisible(), KDockManager::main, makeDockVisible(), setDockDefaultPos(), KDockManager::setDockDefaultPos(), and QWidget::show().
.PP
Referenced by KDockManager::activate(), makeDockVisible(), manualDock(), KDockManager::readConfig(), and undock().
.SS "\fBKDockTabGroup\fP * KDockWidget::parentDockTabGroup () const"
.PP
\fBReturns:\fP
.RS 4
the parent widget of this if it inherits class \fBKDockTabGroup\fP 
.RE
.PP

.PP
Definition at line 1200 of file kdockwidget.cpp.
.PP
References QWidget::parentWidget().
.PP
Referenced by KDockManager::activate(), event(), makeDockVisible(), manualDock(), setPixmap(), and undock().
.SS "\fBQWidget\fP * KDockWidget::parentDockContainer () const"
.PP
\fBSince:\fP
.RS 4
3.1 
.RE
.PP

.PP
Definition at line 1208 of file kdockwidget.cpp.
.PP
References QWidget::parentWidget().
.PP
Referenced by makeDockVisible(), manualDock(), and setPixmap().
.SS "void KDockWidget::setDockWindowType (\fBNET::WindowType\fP windowType)"
.PP
Sets the type of the dock window. 
.PP
\fBParameters:\fP
.RS 4
\fIwindowType\fP is type of dock window 
.RE
.PP

.PP
Definition at line 859 of file kdockwidget.cpp.
.PP
References QWidget::parentWidget(), and KDockWidgetPrivate::windowType.
.SS "\fBQWidget\fP * KDockWidget::transientTo ()"
.PP
Returns the widget this dockwidget is set transient to, otherwise 0 
.PP
\fBSince:\fP
.RS 4
3.2. 
.RE
.PP

.PP
Definition at line 874 of file kdockwidget.cpp.
.PP
References KDockWidgetPrivate::_parent, and KDockWidgetPrivate::transient.
.SS "\fBKDockWidget\fP * KDockWidget::findNearestDockWidget (\fBDockPosition\fP pos)"
.PP
Lookup the nearest dockwidget docked left/right/top/bottom to this one or return 0. 
.PP
\fBParameters:\fP
.RS 4
\fIpos\fP is the position the wanted widget is docked to this one 
.RE
.PP
\fBSince:\fP
.RS 4
3.1 
.RE
.PP

.PP
Definition at line 921 of file kdockwidget.cpp.
.PP
References getWidget().
.SS "void KDockWidget::setPixmap (const \fBQPixmap\fP & pixmap = \fC\fBQPixmap\fP()\fP)"
.PP
Allows changing the pixmap which is used for the caption or dock tabs. 
.PP
\fBParameters:\fP
.RS 4
\fIpixmap\fP is the pixmap to set 
.RE
.PP
\fBSince:\fP
.RS 4
3.2 
.RE
.PP

.PP
Definition at line 532 of file kdockwidget.cpp.
.PP
References QTabWidget::changeTab(), parentDockContainer(), parentDockTabGroup(), pixmap(), QWidget::setIcon(), and QTabWidget::tabLabel().
.SS "const \fBQPixmap\fP & KDockWidget::pixmap () const"
.PP
Returns the dockwidget's associated caption/dock tab pixmap. 
.PP
\fBSince:\fP
.RS 4
3.2 
.RE
.PP

.PP
Definition at line 548 of file kdockwidget.cpp.
.PP
Referenced by setPixmap().
.SS "\fBKDockWidget::DockPosition\fP KDockWidget::currentDockPosition () const"
.PP
\fBReturns:\fP
.RS 4
the current dock position. 
.RE
.PP
\fBSince:\fP
.RS 4
3.3 
.RE
.PP

.PP
Definition at line 1268 of file kdockwidget.cpp.
.PP
References currentDockPos.
.SS "void KDockWidget::setForcedFixedWidth (int)\fC [slot]\fP"
.PP
subject to changes. 
.PP
It doesn't completely work yet without small hacks from within the calling application (Perhaps \fBKDE\fP 3.1.x oder 3.2 width is in pixel. It only affects a widget, which is placed directly into a horizontal \fBKDockSplitter\fP 
.PP
\fBSince:\fP
.RS 4
3.1 
.RE
.PP

.PP
Definition at line 1217 of file kdockwidget.cpp.
.PP
References KDockWidgetPrivate::forcedWidth, and QWidget::setFixedWidth().
.SS "void KDockWidget::setForcedFixedHeight (int)\fC [slot]\fP"
.PP
subject to changes. 
.PP
It doesn't completely work yet without small hacks from within the calling application (Perhaps \fBKDE\fP 3.1.x oder 3.2 height is in pixel. It only affects a widget, which is placed directly into a vertical \fBKDockSplitter\fP 
.PP
\fBSince:\fP
.RS 4
3.1 
.RE
.PP

.PP
Definition at line 1226 of file kdockwidget.cpp.
.PP
References KDockWidgetPrivate::forcedHeight, and QWidget::setFixedHeight().
.SS "void KDockWidget::restoreFromForcedFixedSize ()\fC [slot]\fP"
.PP
\fBSince:\fP
.RS 4
3.1 
.RE
.PP

.PP
Definition at line 1245 of file kdockwidget.cpp.
.PP
References KDockWidgetPrivate::forcedHeight, KDockWidgetPrivate::forcedWidth, QWidget::setMaximumHeight(), QWidget::setMaximumWidth(), QWidget::setMinimumHeight(), and QWidget::setMinimumWidth().
.SS "int KDockWidget::forcedFixedWidth ()\fC [slot]\fP"
.PP
\fBSince:\fP
.RS 4
3.1 
.RE
.PP

.PP
Definition at line 1235 of file kdockwidget.cpp.
.PP
References KDockWidgetPrivate::forcedWidth.
.SS "int KDockWidget::forcedFixedHeight ()\fC [slot]\fP"
.PP
\fBSince:\fP
.RS 4
3.1 
.RE
.PP

.PP
Definition at line 1240 of file kdockwidget.cpp.
.PP
References KDockWidgetPrivate::forcedHeight.
.SS "void KDockWidget::dockBack ()\fC [slot]\fP"
.PP
Docks a dockwidget back to the dockwidget that was the neighbor widget before the current dock position. 
.PP
Definition at line 1558 of file kdockwidget.cpp.
.PP
References formerBrotherDockWidget, formerDockPos, KDockWidgetPrivate::index, KDockManager::main, makeDockVisible(), manualDock(), and KDockWidgetPrivate::splitPosInPercent.
.PP
Referenced by KDockManager::eventFilter(), and makeDockVisible().
.SS "void KDockWidget::changeHideShowState ()\fC [slot]\fP"
.PP
Toggles the visibility state of the dockwidget if it is able to be shown or to be hidden. 
.PP
Definition at line 1500 of file kdockwidget.cpp.
.PP
References KDockManager::main, makeDockVisible(), mayBeHide(), mayBeShow(), and undock().
.SS "void KDockWidget::undock ()\fC [slot]\fP"
.PP
Undocks this. 
.PP
It means it becomes a toplevel widget framed by the system window manager. A small panel at the top of this undocked widget gives the possibility to drag it into another dockwidget by mouse (docking). 
.PP
Definition at line 1273 of file kdockwidget.cpp.
.PP
References KDockSplitter::activate(), applyToWidget(), KDockWidgetPrivate::blockHasUndockedSignal, QObject::blockSignals(), KDockManager::change(), KDockWidgetPrivate::container, QTabWidget::count(), currentDockPos, KDockManager::d, KDockSplitter::deactivate(), KDockManager::drawDragRectangle(), formerDockPos, QWidget::frameGeometry(), KDockSplitter::getAnother(), KDockSplitter::getFirst(), hasUndocked(), QWidget::height(), QWidget::hide(), iMBeingClosed(), KDockWidgetPrivate::index, QTabWidget::indexOf(), QWidget::move(), QTabWidget::page(), parentDockTabGroup(), QWidget::parentWidget(), KDockWidgetPrivate::pendingDtor, QTabWidget::removePage(), KDockManager::replaceDock(), QWidget::resize(), KDockSplitter::separatorPos(), setFormerBrotherDockWidget(), QWidget::show(), show(), KDockWidgetPrivate::splitPosInPercent, KDockManager::undockProcess, and QWidget::width().
.PP
Referenced by changeHideShowState(), KDockMainWindow::makeDockInvisible(), manualDock(), KDockManager::readConfig(), and ~KDockWidget().
.SS "void KDockWidget::toDesktop ()\fC [slot]\fP"
.PP
Docks the widget to the desktop (as a toplevel widget) 
.PP
\fBSince:\fP
.RS 4
3.1. 
.RE
.PP

.PP
Definition at line 1258 of file kdockwidget.cpp.
.PP
References manualDock(), QWidget::mapToGlobal(), QPoint::setX(), QPoint::setY(), QPoint::x(), and QPoint::y().
.PP
Referenced by KDockManager::eventFilter().
.SS "void KDockWidget::updateHeader ()\fC [protected]\fP"
.PP
Checks some conditions and shows or hides the dockwidget header (drag panel). 
.PP
The header is hidden if: 
.PD 0

.IP "\(bu" 2
the parent widget is the \fBKDockMainWindow\fP 
.IP "\(bu" 2
this is a (tab) group dockwidget 
.IP "\(bu" 2
it is not able to dock to another dockwidget 
.PP

.PP
Definition at line 773 of file kdockwidget.cpp.
.PP
References KDockManager::main, QWidget::setCursor(), QWidget::setMouseTracking(), KDockWidgetAbstractHeader::setTopLevel(), and QWidget::style().
.PP
Referenced by KDockManager::readConfig(), setEnableDocking(), and setWidget().
.SS "void KDockWidget::setLatestKDockContainer (\fBQWidget\fP *)\fC [protected]\fP"
.PP
\fBSince:\fP
.RS 4
3.1 
.RE
.PP

.PP
Definition at line 721 of file kdockwidget.cpp.
.PP
References KDockWidgetPrivate::container.
.PP
Referenced by manualDock().
.SS "\fBQWidget\fP * KDockWidget::latestKDockContainer ()\fC [protected]\fP"
.PP
\fBSince:\fP
.RS 4
3.1 
.RE
.PP

.PP
Definition at line 732 of file kdockwidget.cpp.
.PP
References KDockWidgetPrivate::container.
.PP
Referenced by manualDock(), and ~KDockWidget().
.SS "void KDockWidget::setFormerBrotherDockWidget (\fBKDockWidget\fP *)\fC [protected]\fP"
.PP
\fBSince:\fP
.RS 4
3.2 
.RE
.PP

.PP
Definition at line 1541 of file kdockwidget.cpp.
.PP
References QObject::connect(), formerBrotherDockWidget, iMBeingClosed(), and loseFormerBrotherDockWidget().
.PP
Referenced by manualDock(), KDockManager::readConfig(), and undock().
.SS "void KDockWidget::widgetSet (\fBQWidget\fP *)\fC [signal]\fP"
.PP
\fBSince:\fP
.RS 4
3.2 is emitted after the setWidget method has finished 
.RE
.PP

.PP
Referenced by setWidget().
.SS "void KDockWidget::docking (\fBKDockWidget\fP * dw, \fBKDockWidget::DockPosition\fP dp)\fC [signal]\fP"
.PP
Emitted when another dock widget is docking to this. 
.PP
\fBParameters:\fP
.RS 4
\fIdw\fP the dockwidget that is docking to this 
.br
\fIdp\fP the DockPosition where it wants to dock to 
.RE
.PP

.PP
Referenced by manualDock().
.SS "void KDockWidget::setDockDefaultPos ()\fC [signal]\fP"
.PP
Signals that the dock default position is set. 
.PP
Referenced by show().
.SS "void KDockWidget::headerCloseButtonClicked ()\fC [signal]\fP"
.PP
Emitted when the close button of the panel ( \fBKDockWidgetHeader\fP) has been clicked. 
.PP
.SS "void KDockWidget::headerDockbackButtonClicked ()\fC [signal]\fP"
.PP
Emitted when the dockback button of the panel ( \fBKDockWidgetHeader\fP) has been clicked. 
.PP
.SS "void KDockWidget::iMBeingClosed ()\fC [signal]\fP"
.PP
Emitted when the widget processes a close event. 
.PP
Referenced by event(), loseFormerBrotherDockWidget(), setFormerBrotherDockWidget(), undock(), and ~KDockWidget().
.SS "void KDockWidget::hasUndocked ()\fC [signal]\fP"
.PP
Emitted when the widget has undocked. 
.PP
Referenced by undock().
.SS "void KDockWidget::loseFormerBrotherDockWidget ()\fC [protected, slot]\fP"
.PP
Does several things here when it has noticed that the former brother widget (closest neighbor) gets lost. 
.PP
The former brother widget is needed for a possible dockback action, to speak with the Beatles: 'To get back to where you once belonged' ;-) 
.PP
Definition at line 1549 of file kdockwidget.cpp.
.PP
References QObject::disconnect(), formerBrotherDockWidget, iMBeingClosed(), and QWidget::repaint().
.PP
Referenced by manualDock(), and setFormerBrotherDockWidget().
.SH "Member Data Documentation"
.PP 
.SS "\fBKDockWidget\fP* \fBKDockWidget::formerBrotherDockWidget\fP\fC [protected]\fP"
.PP
earlier closest neighbor widget, so it's possible to dock back to it. 
.PP
Definition at line 805 of file kdockwidget.h.
.PP
Referenced by dockBack(), isDockBackPossible(), loseFormerBrotherDockWidget(), manualDock(), setFormerBrotherDockWidget(), and KDockManager::writeConfig().
.SS "\fBDockPosition\fP \fBKDockWidget::currentDockPos\fP\fC [protected]\fP"
.PP
the current dock position. 
.PP
Definition at line 809 of file kdockwidget.h.
.PP
Referenced by currentDockPosition(), KDockManager::eventFilter(), manualDock(), and undock().
.SS "\fBDockPosition\fP \fBKDockWidget::formerDockPos\fP\fC [protected]\fP"
.PP
the former dock position when it really was at another position before. 
.PP
Definition at line 813 of file kdockwidget.h.
.PP
Referenced by dockBack(), isDockBackPossible(), manualDock(), KDockManager::readConfig(), undock(), and KDockManager::writeConfig().
.SS "\fBQString\fP \fBKDockWidget::toolTipStr\fP\fC [protected]\fP"
.PP
a string used as tooltip for the tab page header when in dock-centered mode. 
.PP
Definition at line 817 of file kdockwidget.h.
.PP
Referenced by manualDock().
.SS "\fBQString\fP \fBKDockWidget::tabPageTitle\fP\fC [protected]\fP"
.PP
a string used as title of the tab page when in tab page mode 
.PP
Definition at line 821 of file kdockwidget.h.

.SH "Author"
.PP 
Generated automatically by Doxygen for kdeui Library from the source code.
