KDockWidgetHeader Class Reference

#include <kdockwidget.h>

Inheritance diagram for KDockWidgetHeader:

Public Member Functions
	KDockWidgetHeader (KDockWidget *parent, const char *name=0L)
virtual	~KDockWidgetHeader ()
virtual void	setTopLevel (bool t)
void	setDragPanel (KDockWidgetHeaderDrag *nd)
KDockWidgetHeaderDrag *	dragPanel ()
bool	dragEnabled () const
void	setDragEnabled (bool b)
void	showUndockButton (bool show)
void	forceCloseButtonHidden (bool enable=true)
virtual void	saveConfig (TDEConfig *c)
virtual void	loadConfig (TDEConfig *c)
void	addButton (KDockButton_Private *)
void	removeButton (KDockButton_Private *)
Public Member Functions inherited from KDockWidgetAbstractHeader
	KDockWidgetAbstractHeader (KDockWidget *parent, const char *name=0L)
virtual	~KDockWidgetAbstractHeader ()
virtual void	setTopLevel (bool)
virtual void	saveConfig (TDEConfig *)
virtual void	loadConfig (TDEConfig *)

Protected Slots
void	slotStayClicked ()

Protected Member Functions
virtual void	virtual_hook (int id, void *data)
virtual void	virtual_hook (int id, void *data)

Protected Attributes
TQHBoxLayout *	layout
KDockButton_Private *	closeButton
KDockButton_Private *	stayButton
KDockButton_Private *	dockbackButton
KDockWidgetHeaderDrag *	drag

Detailed Description

The header (additional bar) for a KDockWidget 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.

Author

Max Judin (documentation: Falk Brettschneider).

Definition at line 241 of file kdockwidget.h.

Constructor & Destructor Documentation

KDockWidgetHeader()

KDockWidgetHeader::KDockWidgetHeader	(	KDockWidget *	parent,
		const char *	name = 0L
	)

Constructs this.

Parameters

parent	the parent widget (usually a dockwidget)
name	the object instance name

Definition at line 216 of file kdockwidget.cpp.

~KDockWidgetHeader()

virtual KDockWidgetHeader::~KDockWidgetHeader ( )

inlinevirtual

Destructs this.

Definition at line 258 of file kdockwidget.h.

Member Function Documentation

addButton()

void KDockWidgetHeader::addButton

(

KDockButton_Private *

btn

)

Definition at line 351 of file kdockwidget.cpp.

dragEnabled()

bool KDockWidgetHeader::dragEnabled

(

)

const

Definition at line 397 of file kdockwidget.cpp.

dragPanel()

KDockWidgetHeaderDrag * KDockWidgetHeader::dragPanel

(

)

Get the drag panel of this header.

Since

3.4

Definition at line 312 of file kdockwidget.cpp.

forceCloseButtonHidden()

void KDockWidgetHeader::forceCloseButtonHidden

(

bool

enable = true

)

Since

3.2

Definition at line 306 of file kdockwidget.cpp.

loadConfig()

void KDockWidgetHeader::loadConfig ( TDEConfig *  c )

virtual

Loads the current button state from a KDE config container object.

Parameters

c	the configuration safe

Reimplemented from KDockWidgetAbstractHeader.

Definition at line 428 of file kdockwidget.cpp.

removeButton()

void KDockWidgetHeader::removeButton

(

KDockButton_Private *

btn

)

Definition at line 384 of file kdockwidget.cpp.

saveConfig()

void KDockWidgetHeader::saveConfig ( TDEConfig *  c )

virtual

Saves the current button state to a KDE config container object.

Parameters

c	the configuration safe

Reimplemented from KDockWidgetAbstractHeader.

Definition at line 423 of file kdockwidget.cpp.

setDragEnabled()

void KDockWidgetHeader::setDragEnabled

(

bool

b

)

Definition at line 415 of file kdockwidget.cpp.

setDragPanel()

void KDockWidgetHeader::setDragPanel

(

KDockWidgetHeaderDrag *

nd

)

Sets the drag panel of this header.

Parameters

nd	A pointer to the new drag panel

Definition at line 316 of file kdockwidget.cpp.

setTopLevel()

void KDockWidgetHeader::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 KDockWidgetAbstractHeader.

Definition at line 272 of file kdockwidget.cpp.

showUndockButton()

void KDockWidgetHeader::showUndockButton

(

bool

show

)

Since

3.1

Definition at line 402 of file kdockwidget.cpp.

slotStayClicked

void KDockWidgetHeader::slotStayClicked ( )

protectedslot

Sets dragging the dockwidget off when the stay button is pressed down and vice versa.

Definition at line 392 of file kdockwidget.cpp.

virtual_hook()

void KDockWidgetHeader::virtual_hook ( int  id, void *  data  )

protectedvirtual

Reimplemented from KDockWidgetAbstractHeader.

Definition at line 3310 of file kdockwidget.cpp.

Member Data Documentation

closeButton

KDockButton_Private* KDockWidgetHeader::closeButton

protected

a little button for closing (undocking and hiding) the dockwidget

Definition at line 336 of file kdockwidget.h.

dockbackButton

KDockButton_Private* KDockWidgetHeader::dockbackButton

protected

a little button for dock back the dockwidget to it's previous dockwidget

Definition at line 346 of file kdockwidget.h.

drag

KDockWidgetHeaderDrag* KDockWidgetHeader::drag

protected

the drag panel (double line)

Definition at line 351 of file kdockwidget.h.

layout

TQHBoxLayout* KDockWidgetHeader::layout

protected

A layout manager for placing the embedded buttons (close and stay)

Definition at line 331 of file kdockwidget.h.

stayButton

KDockButton_Private* KDockWidgetHeader::stayButton

protected

a little button for enabling/disabling dragging the dockwidget with the mouse

Definition at line 341 of file kdockwidget.h.

---

The documentation for this class was generated from the following files:

• kdockwidget.h
• kdockwidget.cpp