KDE3Support
K3DockWidgetHeader Class Reference
#include <k3dockwidget.h>

Detailed Description
The header (additional bar) for a K3DockWidget 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.
Definition at line 233 of file k3dockwidget.h.
Public Member Functions | |
void | addButton (K3DockButton_Private *) |
bool | dragEnabled () const |
K3DockWidgetHeaderDrag * | dragPanel () |
void | forceCloseButtonHidden (bool enable=true) |
K3DockWidgetHeader (K3DockWidget *parent, const char *name=0L) | |
virtual void | loadConfig (KConfigGroup *c) |
void | removeButton (K3DockButton_Private *) |
virtual void | saveConfig (KConfigGroup *c) |
void | setDragEnabled (bool b) |
void | setDragPanel (K3DockWidgetHeaderDrag *nd) |
virtual void | setTopLevel (bool t) |
void | showUndockButton (bool show) |
virtual | ~K3DockWidgetHeader () |
Protected Slots | |
void | slotStayClicked () |
Protected Member Functions | |
virtual void | virtual_hook (int id, void *data) |
Protected Attributes | |
K3DockButton_Private * | closeButton |
K3DockButton_Private * | dockbackButton |
K3DockWidgetHeaderDrag * | drag |
QHBoxLayout * | layout |
K3DockButton_Private * | stayButton |
Constructor & Destructor Documentation
K3DockWidgetHeader::K3DockWidgetHeader | ( | K3DockWidget * | parent, | |
const char * | name = 0L | |||
) |
Constructs this.
- Parameters:
-
parent the parent widget (usually a dockwidget) name the object instance name
Definition at line 253 of file k3dockwidget.cpp.
K3DockWidgetHeader::~K3DockWidgetHeader | ( | ) | [virtual] |
Member Function Documentation
void K3DockWidgetHeader::addButton | ( | K3DockButton_Private * | btn | ) |
add an arbitrary button to the dockwidget header NOT PART OF THE PUBLIC API (you don't have access the class defintion anyways, without special header file copying.
(don't do it))
Definition at line 403 of file k3dockwidget.cpp.
bool K3DockWidgetHeader::dragEnabled | ( | ) | const |
Definition at line 449 of file k3dockwidget.cpp.
K3DockWidgetHeaderDrag * K3DockWidgetHeader::dragPanel | ( | ) |
void K3DockWidgetHeader::forceCloseButtonHidden | ( | bool | enable = true |
) |
Definition at line 357 of file k3dockwidget.cpp.
void K3DockWidgetHeader::loadConfig | ( | KConfigGroup * | c | ) | [virtual] |
Loads the current button state from a KDE config container object.
- Parameters:
-
c the configuration safe
Reimplemented from K3DockWidgetAbstractHeader.
Definition at line 480 of file k3dockwidget.cpp.
void K3DockWidgetHeader::removeButton | ( | K3DockButton_Private * | btn | ) |
remove an arbtrary button from the dockwidget header NOT PART OF THE PUBLIC API (you don't have access the class defintion anyways, without special header file copying.
(don't do it))
Definition at line 436 of file k3dockwidget.cpp.
void K3DockWidgetHeader::saveConfig | ( | KConfigGroup * | c | ) | [virtual] |
Saves the current button state to a KDE config container object.
- Parameters:
-
c the configuration safe
Reimplemented from K3DockWidgetAbstractHeader.
Definition at line 475 of file k3dockwidget.cpp.
void K3DockWidgetHeader::setDragEnabled | ( | bool | b | ) |
Definition at line 467 of file k3dockwidget.cpp.
void K3DockWidgetHeader::setDragPanel | ( | K3DockWidgetHeaderDrag * | nd | ) |
Sets the drag panel of this header.
- Parameters:
-
nd A pointer to the new drag panel
Definition at line 367 of file k3dockwidget.cpp.
void K3DockWidgetHeader::setTopLevel | ( | bool | t | ) | [virtual] |
Hides the close button and stay button when switching to toplevel or vice versa shows them.
- Parameters:
-
t toplevel or not
Reimplemented from K3DockWidgetAbstractHeader.
Definition at line 323 of file k3dockwidget.cpp.
void K3DockWidgetHeader::showUndockButton | ( | bool | show | ) |
Definition at line 454 of file k3dockwidget.cpp.
void K3DockWidgetHeader::slotStayClicked | ( | ) | [protected, slot] |
Sets dragging the dockwidget off when the stay button is pressed down and vice versa.
Definition at line 444 of file k3dockwidget.cpp.
void K3DockWidgetHeader::virtual_hook | ( | int | id, | |
void * | data | |||
) | [protected, virtual] |
Member Data Documentation
K3DockButton_Private* K3DockWidgetHeader::closeButton [protected] |
a little button for closing (undocking and hiding) the dockwidget
Definition at line 323 of file k3dockwidget.h.
K3DockButton_Private* K3DockWidgetHeader::dockbackButton [protected] |
a little button for dock back the dockwidget to its previous dockwidget
Definition at line 333 of file k3dockwidget.h.
K3DockWidgetHeaderDrag* K3DockWidgetHeader::drag [protected] |
QHBoxLayout* K3DockWidgetHeader::layout [protected] |
A layout manager for placing the embedded buttons (close and stay).
Definition at line 318 of file k3dockwidget.h.
K3DockButton_Private* K3DockWidgetHeader::stayButton [protected] |
a little button for enabling/disabling dragging the dockwidget with the mouse
Definition at line 328 of file k3dockwidget.h.
The documentation for this class was generated from the following files: