.TH "KDockWidgetHeader" kde3 "11 Jun 2005" "Version Version 3.4.1" "kdeui Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KDockWidgetHeader \- The header (additional bar) for a \fBKDockWidget\fP s (and member of the dockwidget class set).  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kdockwidget.h>\fP
.PP
Inherits \fBKDockWidgetAbstractHeader\fP.
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKDockWidgetHeader\fP (\fBKDockWidget\fP *parent, const char *name=0L)"
.br
.ti -1c
.RI "virtual \fB~KDockWidgetHeader\fP ()"
.br
.ti -1c
.RI "virtual void \fBsetTopLevel\fP (bool t)"
.br
.ti -1c
.RI "void \fBsetDragPanel\fP (\fBKDockWidgetHeaderDrag\fP *nd)"
.br
.ti -1c
.RI "\fBKDockWidgetHeaderDrag\fP * \fBdragPanel\fP ()"
.br
.ti -1c
.RI "bool \fBdragEnabled\fP () const "
.br
.ti -1c
.RI "void \fBsetDragEnabled\fP (bool b)"
.br
.ti -1c
.RI "void \fBshowUndockButton\fP (bool show)"
.br
.ti -1c
.RI "void \fBforceCloseButtonHidden\fP (bool enable=true)"
.br
.ti -1c
.RI "virtual void \fBsaveConfig\fP (\fBKConfig\fP *c)"
.br
.ti -1c
.RI "virtual void \fBloadConfig\fP (\fBKConfig\fP *c)"
.br
.ti -1c
.RI "void \fBaddButton\fP (\fBKDockButton_Private\fP *)"
.br
.ti -1c
.RI "void \fBremoveButton\fP (\fBKDockButton_Private\fP *)"
.br
.in -1c
.SS "Protected Slots"

.in +1c
.ti -1c
.RI "void \fBslotStayClicked\fP ()"
.br
.in -1c
.SS "Protected Member Functions"

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

.in +1c
.ti -1c
.RI "\fBQHBoxLayout\fP * \fBlayout\fP"
.br
.ti -1c
.RI "\fBKDockButton_Private\fP * \fBcloseButton\fP"
.br
.ti -1c
.RI "\fBKDockButton_Private\fP * \fBstayButton\fP"
.br
.ti -1c
.RI "\fBKDockButton_Private\fP * \fBdockbackButton\fP"
.br
.ti -1c
.RI "\fBKDockWidgetHeaderDrag\fP * \fBdrag\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
The header (additional bar) for a \fBKDockWidget\fP s (and member of the dockwidget class set). 

It have got the buttons located there. And it is for recording and reading the button states. More or less a minor helper class for the dockwidget class set.
.PP
\fBAuthor:\fP
.RS 4
Max Judin (documentation: Falk Brettschneider). 
.RE
.PP

.PP
Definition at line 238 of file kdockwidget.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KDockWidgetHeader::KDockWidgetHeader (\fBKDockWidget\fP * parent, const char * name = \fC0L\fP)"
.PP
Constructs this. 
.PP
\fBParameters:\fP
.RS 4
\fIparent\fP the parent widget (usually a dockwidget) 
.br
\fIname\fP the object instance name 
.RE
.PP

.PP
Definition at line 216 of file kdockwidget.cpp.
.PP
References QToolTip::add(), closeButton, dockbackButton, drag, layout, QPushButton::pixmap(), QPushButton::setPixmap(), QPushButton::setToggleButton(), slotStayClicked(), and stayButton.
.SS "virtual KDockWidgetHeader::~\fBKDockWidgetHeader\fP ()\fC [inline, virtual]\fP"
.PP
Destructs this. 
.PP
Definition at line 254 of file kdockwidget.h.
.SH "Member Function Documentation"
.PP 
.SS "void KDockWidgetHeader::setTopLevel (bool t)\fC [virtual]\fP"
.PP
Hides the close button and stay button when switching to toplevel or vice versa shows them. 
.PP
\fBParameters:\fP
.RS 4
\fIt\fP toplevel or not 
.RE
.PP

.PP
Reimplemented from \fBKDockWidgetAbstractHeader\fP.
.PP
Definition at line 272 of file kdockwidget.cpp.
.PP
References closeButton, dockbackButton, drag, KDockWidget::isDockBackPossible(), layout, and stayButton.
.SS "void KDockWidgetHeader::setDragPanel (\fBKDockWidgetHeaderDrag\fP * nd)"
.PP
Sets the drag panel of this header. 
.PP
\fBParameters:\fP
.RS 4
\fInd\fP A pointer to the new drag panel 
.RE
.PP

.PP
Definition at line 317 of file kdockwidget.cpp.
.PP
References closeButton, dockbackButton, drag, endl(), kdDebug(), layout, and stayButton.
.SS "\fBKDockWidgetHeaderDrag\fP * KDockWidgetHeader::dragPanel ()"
.PP
Get the drag panel of this header. 
.PP
\fBSince:\fP
.RS 4
3.4 
.RE
.PP

.PP
Definition at line 313 of file kdockwidget.cpp.
.PP
References drag.
.SS "void KDockWidgetHeader::showUndockButton (bool show)"
.PP
\fBSince:\fP
.RS 4
3.1 
.RE
.PP

.PP
Definition at line 405 of file kdockwidget.cpp.
.PP
References endl(), and kdDebug().
.SS "void KDockWidgetHeader::forceCloseButtonHidden (bool enable = \fCtrue\fP)"
.PP
\fBSince:\fP
.RS 4
3.2 
.RE
.PP

.PP
Definition at line 307 of file kdockwidget.cpp.
.PP
References closeButton.
.SS "void KDockWidgetHeader::saveConfig (\fBKConfig\fP * c)\fC [virtual]\fP"
.PP
Saves the current button state to a \fBKDE\fP config container object. 
.PP
\fBParameters:\fP
.RS 4
\fIc\fP the configuration safe 
.RE
.PP

.PP
Reimplemented from \fBKDockWidgetAbstractHeader\fP.
.PP
Definition at line 426 of file kdockwidget.cpp.
.PP
References QPushButton::isOn(), and stayButton.
.SS "void KDockWidgetHeader::loadConfig (\fBKConfig\fP * c)\fC [virtual]\fP"
.PP
\fBLoads\fP the current button state from a \fBKDE\fP config container object. 
.PP
\fBParameters:\fP
.RS 4
\fIc\fP the configuration safe 
.RE
.PP

.PP
Reimplemented from \fBKDockWidgetAbstractHeader\fP.
.PP
Definition at line 431 of file kdockwidget.cpp.
.SS "void KDockWidgetHeader::slotStayClicked ()\fC [protected, slot]\fP"
.PP
Sets dragging the dockwidget off when the stay button is pressed down and vice versa. 
.PP
Definition at line 395 of file kdockwidget.cpp.
.PP
References QPushButton::isOn(), and stayButton.
.PP
Referenced by KDockWidgetHeader().
.SH "Member Data Documentation"
.PP 
.SS "\fBQHBoxLayout\fP* \fBKDockWidgetHeader::layout\fP\fC [protected]\fP"
.PP
A layout manager for placing the embedded buttons (close and stay). 
.PP
Definition at line 327 of file kdockwidget.h.
.PP
Referenced by KDockWidgetHeader(), setDragPanel(), and setTopLevel().
.SS "\fBKDockButton_Private\fP* \fBKDockWidgetHeader::closeButton\fP\fC [protected]\fP"
.PP
a little button for closing (undocking and hiding) the dockwidget 
.PP
Definition at line 332 of file kdockwidget.h.
.PP
Referenced by forceCloseButtonHidden(), KDockWidgetHeader(), setDragPanel(), and setTopLevel().
.SS "\fBKDockButton_Private\fP* \fBKDockWidgetHeader::stayButton\fP\fC [protected]\fP"
.PP
a little button for enabling/disabling dragging the dockwidget with the mouse 
.PP
Definition at line 337 of file kdockwidget.h.
.PP
Referenced by KDockWidgetHeader(), saveConfig(), setDragPanel(), setTopLevel(), and slotStayClicked().
.SS "\fBKDockButton_Private\fP* \fBKDockWidgetHeader::dockbackButton\fP\fC [protected]\fP"
.PP
a little button for dock back the dockwidget to it's previous dockwidget 
.PP
Definition at line 342 of file kdockwidget.h.
.PP
Referenced by KDockWidgetHeader(), setDragPanel(), and setTopLevel().
.SS "\fBKDockWidgetHeaderDrag\fP* \fBKDockWidgetHeader::drag\fP\fC [protected]\fP"
.PP
the drag panel (double line) 
.PP
Definition at line 347 of file kdockwidget.h.
.PP
Referenced by dragPanel(), KDockWidgetHeader(), setDragPanel(), and setTopLevel().

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