.TH "KDockWidgetHeader" 3 "28 Jan 2004" "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
.RI "\fIConstructs this. \fP"
.ti -1c
.RI "virtual \fB~KDockWidgetHeader\fP ()"
.br
.RI "\fIDestructs this. \fP"
.ti -1c
.RI "virtual void \fBsetTopLevel\fP (bool t)"
.br
.RI "\fIHides the close button and stay button when switching to toplevel or vice versa shows them. \fP"
.ti -1c
.RI "void \fBsetDragPanel\fP (\fBKDockWidgetHeaderDrag\fP *nd)"
.br
.RI "\fISets the drag panel of this header. \fP"
.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
.RI "\fI\fBSince:\fP
.RS 4
3.1 
.RE
.PP
\fP"
.ti -1c
.RI "virtual void \fBsaveConfig\fP (\fBKConfig\fP *c)"
.br
.RI "\fISaves the current button state to a \fBKDE\fP config container object. \fP"
.ti -1c
.RI "virtual void \fBloadConfig\fP (\fBKConfig\fP *)"
.br
.RI "\fILoads the current button state from a \fBKDE\fP config container object. \fP"
.in -1c
.SS "Protected Slots"

.in +1c
.ti -1c
.RI "void \fBslotStayClicked\fP ()"
.br
.RI "\fISets dragging the dockwidget off when the stay button is pressed down and vice versa. \fP"
.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
.RI "\fIA layout manager for placing the embedded buttons (close and stay). \fP"
.ti -1c
.RI "\fBKDockButton_Private\fP * \fBcloseButton\fP"
.br
.RI "\fIa little button for closing (undocking and hiding) the dockwidget \fP"
.ti -1c
.RI "\fBKDockButton_Private\fP * \fBstayButton\fP"
.br
.RI "\fIa little button for enabling/disabling dragging the dockwidget with the mouse \fP"
.ti -1c
.RI "\fBKDockButton_Private\fP * \fBdockbackButton\fP"
.br
.RI "\fIa little button for dock back the dockwidget to it's previous dockwidget \fP"
.ti -1c
.RI "\fBKDockWidgetHeaderDrag\fP * \fBdrag\fP"
.br
.RI "\fIthe drag panel (double line) \fP"
.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 233 of file kdockwidget.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KDockWidgetHeader::KDockWidgetHeader (\fBKDockWidget\fP * parent, const char * name = 0L)"
.PP
Constructs this. \fBParameters:\fP
.RS 4
\fIparent\fP the parent widget (usually a dockwidget) 
.br
\fIname\fP the object instance name 
.RE
.PP
Definition at line 210 of file kdockwidget.cpp.
.PP
References closeButton, dockbackButton, drag, layout, KStdAccel::name(), QPushButton::pixmap(), QPushButton::setPixmap(), QPushButton::setToggleButton(), slotStayClicked(), and stayButton.
.SS "virtual KDockWidgetHeader::~\fBKDockWidgetHeader\fP ()\fC [inline, virtual]\fP"
.PP
Destructs this. Definition at line 249 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. \fBParameters:\fP
.RS 4
\fIt\fP toplevel or not 
.RE
.PP
Reimplemented from \fBKDockWidgetAbstractHeader\fP.
.PP
Definition at line 257 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. \fBParameters:\fP
.RS 4
\fInd\fP A pointer to the new drag panel 
.RE
.PP
Definition at line 283 of file kdockwidget.cpp.
.PP
References closeButton, dockbackButton, drag, layout, and stayButton.
.SS "void KDockWidgetHeader::showUndockButton (bool show)"
.PP
\fBSince:\fP
.RS 4
3.1 
.RE
.PP
Definition at line 313 of file kdockwidget.cpp.
.SS "void KDockWidgetHeader::saveConfig (\fBKConfig\fP * c)\fC [virtual]\fP"
.PP
Saves the current button state to a \fBKDE\fP config container object. \fBParameters:\fP
.RS 4
\fIc\fP the configuration safe 
.RE
.PP
Reimplemented from \fBKDockWidgetAbstractHeader\fP.
.PP
Definition at line 333 of file kdockwidget.cpp.
.PP
References QPushButton::isOn(), KStdAccel::name(), stayButton, and KConfigBase::writeEntry().
.SS "void KDockWidgetHeader::loadConfig (\fBKConfig\fP *)\fC [virtual]\fP"
.PP
Loads the current button state from a \fBKDE\fP config container object. \fBParameters:\fP
.RS 4
\fIc\fP the configuration safe 
.RE
.PP
Reimplemented from \fBKDockWidgetAbstractHeader\fP.
.PP
Definition at line 338 of file kdockwidget.cpp.
.PP
References KStdAccel::name(), and KConfigBase::readBoolEntry().
.SS "void KDockWidgetHeader::slotStayClicked ()\fC [protected, slot]\fP"
.PP
Sets dragging the dockwidget off when the stay button is pressed down and vice versa. Definition at line 303 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). Definition at line 297 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 Definition at line 302 of file kdockwidget.h.
.PP
Referenced by 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 Definition at line 307 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 Definition at line 312 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) Definition at line 317 of file kdockwidget.h.
.PP
Referenced by KDockWidgetHeader(), setDragPanel(), and setTopLevel().

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