KDockWidget Class Reference

Floatable widget that can be dragged around with the mouse and encapsulate the actual widgets (and member of the dockwidget class set). More...

#include <kdockwidget.h>

Inheritance diagram for KDockWidget:

[legend]

List of all members.


Public Types
enum	DockPosition { DockNone = 0, DockTop = 0x0001, DockLeft = 0x0002, DockRight = 0x0004, DockBottom = 0x0008, DockCenter = 0x0010, DockDesktop = 0x0020, DockToSpecialSites = 0x0040, DockCorner = DockTop \| DockLeft \| DockRight \| DockBottom, DockFullSite = DockCorner \| DockCenter, DockFullDocking = DockFullSite \| DockDesktop }
Public Slots
void	changeHideShowState ()
void	dockBack ()
int	forcedFixedHeight ()
int	forcedFixedWidth ()
void	restoreFromForcedFixedSize ()
void	setForcedFixedHeight (int)
void	setForcedFixedWidth (int)
void	toDesktop ()
void	undock ()
Signals
void	docking (KDockWidget *dw, KDockWidget::DockPosition dp)
void	hasUndocked ()
void	headerCloseButtonClicked ()
void	headerDockbackButtonClicked ()
void	iMBeingClosed ()
void	setDockDefaultPos ()
void	widgetSet (QWidget *)
Public Member Functions
KDockWidget::DockPosition	currentDockPosition () const
KDockManager *	dockManager () const
int	dockSite () const
int	enableDocking () const
virtual bool	event (QEvent *)
KDockWidget *	findNearestDockWidget (DockPosition pos)
KDockWidgetAbstractHeader *	getHeader ()
QWidget *	getWidget () const
bool	isDockBackPossible () const
	KDockWidget (KDockManager dockManager, const char name, const QPixmap &pixmap, QWidget *parent=0L, const QString &strCaption=QString::null, const QString &strTabPageLabel=QString::fromLatin1(" "), WFlags f=0)
void	makeDockVisible ()
KDockWidget *	manualDock (KDockWidget *target, DockPosition dockPos, int spliPos=50, QPoint pos=QPoint(0, 0), bool check=false, int tabIndex=-1)
bool	mayBeHide () const
bool	mayBeShow () const
QWidget *	parentDockContainer () const
KDockTabGroup *	parentDockTabGroup () const
const QPixmap &	pixmap () const
void	setDockSite (int pos)
void	setDockWindowTransient (QWidget *parent, bool transientEnabled)
void	setDockWindowType (NET::WindowType windowType)
void	setEnableDocking (int pos)
void	setHeader (KDockWidgetAbstractHeader *ah)
void	setPixmap (const QPixmap &pixmap=QPixmap())
void	setTabPageLabel (const QString &label)
void	setToolTipString (const QString &ttStr)
void	setWidget (QWidget *w)
virtual void	show ()
const QString &	tabPageLabel () const
const QString &	toolTipString () const
QWidget *	transientTo ()
virtual	~KDockWidget ()
Protected Slots
virtual void	leaveEvent (QEvent *)
void	loseFormerBrotherDockWidget ()
virtual void	mouseMoveEvent (QMouseEvent *)
virtual void	mousePressEvent (QMouseEvent *)
virtual void	mouseReleaseEvent (QMouseEvent *)
virtual void	paintEvent (QPaintEvent *)
Protected Member Functions
QWidget *	latestKDockContainer ()
void	setFormerBrotherDockWidget (KDockWidget *)
void	setLatestKDockContainer (QWidget *)
void	updateHeader ()
virtual void	virtual_hook (int id, void *data)
Protected Attributes
DockPosition	currentDockPos
KDockWidget *	formerBrotherDockWidget
DockPosition	formerDockPos
QString	tabPageTitle
QString	toolTipStr

Detailed Description

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.

If you want to use this kind of widget, your main application window has to be a KDockMainWindow. That is because it has got several additional dock management features, for instance a KDockManager that has an overview over all dockwidgets and and a dockmovemanager (internal class) that handles the dock process.

Usually you create an KDockWidget that covers the actual widget in this way:

 ...
 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
 ...

See KDockMainWindow how a dockwidget is docked in.

Author:: Max Judin (documentation: Falk Brettschneider).

Definition at line 423 of file kdockwidget.h.

Member Enumeration Documentation

enum KDockWidget::DockPosition

The possible positions where a dockwidget can dock to another dockwidget.

Enumerator:

DockNone
DockTop
DockLeft
DockRight
DockBottom
DockCenter
DockDesktop
DockToSpecialSites	Since: 3.1
DockCorner
DockFullSite
DockFullDocking

Definition at line 459 of file kdockwidget.h.

Constructor & Destructor Documentation

KDockWidget::KDockWidget	(	KDockManager *	dockManager,
		const char *	name,
		const QPixmap &	pixmap,
		QWidget *	parent = `0L`,
		const QString &	strCaption = `QString::null`,
		const QString &	strTabPageLabel = `QString::fromLatin1( " " )`,
		WFlags	f = `0`
	)

Construct a dockwidget.

Initially, docking to another and docking to this is allowed for every DockPosition. It is supposed to be no (tab) group. It will taken under control of its dockmanager.

Parameters:

	dockManager	The responsible manager (dock helper)
	name	Object instance name
	pixmap	An icon (for instance shown when docked centered)
	parent	Parent widget
	strCaption	Title of the dockwidget window (shown when toplevel)
	strTabPageLabel	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
	f	Qt::WidgetFlags widget flags

Definition at line 479 of file kdockwidget.cpp.

KDockWidget::~KDockWidget ( ) [virtual]

Destructs a dockwidget.

Definition at line 549 of file kdockwidget.cpp.

Member Function Documentation

void KDockWidget::changeHideShowState ( ) [slot]

Toggles the visibility state of the dockwidget if it is able to be shown or to be hidden.

Definition at line 1518 of file kdockwidget.cpp.

KDockWidget::DockPosition KDockWidget::currentDockPosition ( ) const

Returns:: the current dock position.

Since:: 3.3

Definition at line 1286 of file kdockwidget.cpp.

void KDockWidget::dockBack ( ) [slot]

Docks a dockwidget back to the dockwidget that was the neighbor widget before the current dock position.

Definition at line 1576 of file kdockwidget.cpp.

void KDockWidget::docking	(	KDockWidget *	dw,
		KDockWidget::DockPosition	dp
	)			`[signal]`

Emitted when another dock widget is docking to this.

Parameters:

	dw	the dockwidget that is docking to this
	dp	the DockPosition where it wants to dock to

KDockManager* KDockWidget::dockManager ( ) const [inline]

Returns:: The dockmanager that is responsible for this.

Definition at line 585 of file kdockwidget.h.

int KDockWidget::dockSite ( ) const [inline]

Returns:: There it is either possible or impossible for another dockwidget to dock to this (an OR'ed set of DockPositions).

Definition at line 522 of file kdockwidget.h.

int KDockWidget::enableDocking ( ) const [inline]

Returns:: Where it is either possible or impossible for this to dock to another dockwidget (an OR'ed set of DockPositions).

Definition at line 510 of file kdockwidget.h.

bool KDockWidget::event ( QEvent * event ) [virtual]

Catches and processes some QWidget events that are interesting for dockwidgets.

Reimplemented from QWidget.

Definition at line 877 of file kdockwidget.cpp.

KDockWidget * KDockWidget::findNearestDockWidget ( DockPosition pos )

Lookup the nearest dockwidget docked left/right/top/bottom to this one or return 0.

Parameters:

pos

is the position the wanted widget is docked to this one

Since:: 3.1

Definition at line 920 of file kdockwidget.cpp.

int KDockWidget::forcedFixedHeight ( ) [slot]

Since:: 3.1

Definition at line 1258 of file kdockwidget.cpp.

int KDockWidget::forcedFixedWidth ( ) [slot]

Since:: 3.1

Definition at line 1253 of file kdockwidget.cpp.

KDockWidgetAbstractHeader * KDockWidget::getHeader ( )

Since:: 3.2 get the pointer to the header widget

Definition at line 738 of file kdockwidget.cpp.

QWidget* KDockWidget::getWidget ( ) const [inline]

Get the embedded widget.

Returns:: The pointer to the dockwidget's child widget, 0L if there's no such child.

Definition at line 538 of file kdockwidget.h.

void KDockWidget::hasUndocked ( ) [signal]

Emitted when the widget has undocked.

void KDockWidget::headerCloseButtonClicked ( ) [signal]

Emitted when the close button of the panel ( KDockWidgetHeader) has been clicked.

void KDockWidget::headerDockbackButtonClicked ( ) [signal]

Emitted when the dockback button of the panel ( KDockWidgetHeader) has been clicked.

void KDockWidget::iMBeingClosed ( ) [signal]

Emitted when the widget processes a close event.

bool KDockWidget::isDockBackPossible ( ) const

Returns:: result true, if a dockback is possible, otherwise false.

Definition at line 1608 of file kdockwidget.cpp.

QWidget * KDockWidget::latestKDockContainer ( ) [protected]

Since:: 3.1

Definition at line 729 of file kdockwidget.cpp.

void KDockWidget::leaveEvent ( QEvent * e ) [protected, virtual, slot]

Reimplemented from QWidget.

Definition at line 581 of file kdockwidget.cpp.

void KDockWidget::loseFormerBrotherDockWidget ( ) [protected, slot]

Does several things here when it has noticed that the former brother widget (closest neighbor) gets lost.

The former brother widget is needed for a possible dockback action, to speak with the Beatles: "To get back to where you once belonged" ;-)

Definition at line 1567 of file kdockwidget.cpp.

void KDockWidget::makeDockVisible ( )

Normally it simply shows the dockwidget.

But additionally, if it is docked to a tab widget (DockCenter), it is set as the active (visible) tab page.

Definition at line 1534 of file kdockwidget.cpp.

KDockWidget * KDockWidget::manualDock	(	KDockWidget *	target,
		DockPosition	dockPos,
		int	spliPos = `50`,
		QPoint	pos = `QPoint(0,0)`,
		bool	check = `false`,
		int	tabIndex = `-1`
	)

This is a key method of this class! Use it to dock dockwidgets to another dockwidget at the right position within its KDockMainWindow or a toplevel dockwidget.

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.

Parameters:

	target	The dockwidget to dock to
	dockPos	One of the DockPositions this is going to dock to
	spliPos	The split relation (in percent, or percent*100 in high resolution) between both dockwidgets, target and this
	pos	The dock position, mainly of interest for docking to the desktop (as toplevel dockwidget)
	check	Only for internal use;
	tabIndex	The position index of the tab widget (when in tab page mode), -1 (default) means append

Returns:: result The group dockwidget that replaces the target dockwidget and will be grandparent of target and this.

Note:: Since KDE 3.5 the splitter position spliPos is always a value between [0..100]. If the value is > 100, it will be treated like the old code and normalized to a value between 0 and 100. Example: If the value was 4000, it will be fixed to 40. In short: The old and the new behavior both work, so it is compatible with older KDE-versions.

Definition at line 947 of file kdockwidget.cpp.

bool KDockWidget::mayBeHide ( ) const

Returns:: If it may be possible to hide this.

There are reasons that it's impossible:

It is a (tab) group.
It is already invisible ;-)
The parent of this is the KDockMainWindow.
It isn't able to dock to another widget.

Definition at line 1506 of file kdockwidget.cpp.

bool KDockWidget::mayBeShow ( ) const

Returns:

If it may be possible to show this. There are reasons that it's impossible:

It is a (tab) group.
It is already visible ;-)
The parent of this is the KDockMainWindow.

Definition at line 1512 of file kdockwidget.cpp.

void KDockWidget::mouseMoveEvent ( QMouseEvent * mme ) [protected, virtual, slot]

Reimplemented from QWidget.

Definition at line 659 of file kdockwidget.cpp.

void KDockWidget::mousePressEvent ( QMouseEvent * mme ) [protected, virtual, slot]

Reimplemented from QWidget.

Definition at line 590 of file kdockwidget.cpp.

void KDockWidget::mouseReleaseEvent ( QMouseEvent * ev ) [protected, virtual, slot]

Reimplemented from QWidget.

Definition at line 650 of file kdockwidget.cpp.

void KDockWidget::paintEvent ( QPaintEvent * pe ) [protected, virtual, slot]

Reimplemented from QWidget.

Definition at line 572 of file kdockwidget.cpp.

QWidget * KDockWidget::parentDockContainer ( ) const

Since:: 3.1

Definition at line 1226 of file kdockwidget.cpp.

KDockTabGroup * KDockWidget::parentDockTabGroup ( ) const

Returns:: the parent widget of this if it inherits class KDockTabGroup

Definition at line 1218 of file kdockwidget.cpp.

const QPixmap & KDockWidget::pixmap ( ) const

Returns the dockwidget's associated caption/dock tab pixmap.

Since:: 3.2

Definition at line 545 of file kdockwidget.cpp.

void KDockWidget::restoreFromForcedFixedSize ( ) [slot]

Since:: 3.1

Definition at line 1263 of file kdockwidget.cpp.

void KDockWidget::setDockDefaultPos ( ) [signal]

Signals that the dock default position is set.

void KDockWidget::setDockSite ( int pos ) [inline]

Specify where it is either possible or impossible for another dockwidget to dock to this.

Parameters:

pos An OR'ed set of DockPositions

Definition at line 517 of file kdockwidget.h.

void KDockWidget::setDockWindowTransient	(	QWidget *	parent,
		bool	transientEnabled
	)

Definition at line 866 of file kdockwidget.cpp.

void KDockWidget::setDockWindowType ( NET::WindowType windowType )

Sets the type of the dock window.

Parameters:

windowType

is type of dock window

Definition at line 858 of file kdockwidget.cpp.

void KDockWidget::setEnableDocking ( int pos )

Specify where it is either possible or impossible for this to dock to another dockwidget.

Parameters:

pos An OR'ed set of DockPositions

Definition at line 762 of file kdockwidget.cpp.

void KDockWidget::setForcedFixedHeight ( int h ) [slot]

subject to changes.

It doesn't completely work yet without small hacks from within the calling application (Perhaps KDE 3.1.x oder 3.2 height is in pixel. It only affects a widget, which is placed directly into a vertical KDockSplitter

Since:: 3.1

Definition at line 1244 of file kdockwidget.cpp.

void KDockWidget::setForcedFixedWidth ( int w ) [slot]

subject to changes.

It doesn't completely work yet without small hacks from within the calling application (Perhaps KDE 3.1.x oder 3.2 width is in pixel. It only affects a widget, which is placed directly into a horizontal KDockSplitter

Since:: 3.1

Definition at line 1235 of file kdockwidget.cpp.

void KDockWidget::setFormerBrotherDockWidget ( KDockWidget * dockWidget ) [protected]

Since:: 3.2

Definition at line 1559 of file kdockwidget.cpp.

void KDockWidget::setHeader ( KDockWidgetAbstractHeader * ah )

Sets the header of this dockwidget.

A QLayout takes care about proper resizing, automatically. The header contains the drag panel, the close button and the stay button.

Parameters:

ah

A base class pointer to the dockwidget header

Definition at line 742 of file kdockwidget.cpp.

void KDockWidget::setLatestKDockContainer ( QWidget * container ) [protected]

Since:: 3.1

Definition at line 718 of file kdockwidget.cpp.

void KDockWidget::setPixmap ( const QPixmap & pixmap = QPixmap() )

Allows changing the pixmap which is used for the caption or dock tabs.

Parameters:

pixmap

is the pixmap to set

Since:: 3.2

Definition at line 529 of file kdockwidget.cpp.

void KDockWidget::setTabPageLabel ( const QString & label ) [inline]

Sets a string that is used for the label of the tab page when in tab page mode.

Parameters:

label

The new tab page label.

Definition at line 613 of file kdockwidget.h.

void KDockWidget::setToolTipString ( const QString & ttStr ) [inline]

Stores a string for a tooltip.

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.

Parameters:

ttStr

A string for the tooltip on the tab.

Definition at line 597 of file kdockwidget.h.

void KDockWidget::setWidget ( QWidget * w )

Sets the embedded widget.

A QLayout takes care about proper resizing, automatically.

Parameters:

w

The pointer to the dockwidget's child widget.

Definition at line 1448 of file kdockwidget.cpp.

void KDockWidget::show ( void ) [virtual]

Add dockwidget management actions to QWidget::show.

Reimplemented from QWidget.

Definition at line 840 of file kdockwidget.cpp.

const QString& KDockWidget::tabPageLabel ( ) const [inline]

Returns:: A string that is used for the label of the tab page when in tab page mode.

Definition at line 618 of file kdockwidget.h.

void KDockWidget::toDesktop ( ) [slot]

Docks the widget to the desktop (as a toplevel widget).

Since:: 3.1

Definition at line 1276 of file kdockwidget.cpp.

const QString& KDockWidget::toolTipString ( ) const [inline]

Returns:: The tooltip string being shown on the appropriate tab page header when in dock-centered mode.

Definition at line 602 of file kdockwidget.h.

QWidget * KDockWidget::transientTo ( )

Returns the widget this dockwidget is set transient to, otherwise 0.

Since:: 3.2

Definition at line 873 of file kdockwidget.cpp.

void KDockWidget::undock ( ) [slot]

Undocks this.

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).

Definition at line 1291 of file kdockwidget.cpp.

void KDockWidget::updateHeader ( ) [protected]

Checks some conditions and shows or hides the dockwidget header (drag panel).

The header is hidden if:

the parent widget is the KDockMainWindow
this is a (tab) group dockwidget
it is not able to dock to another dockwidget

Definition at line 772 of file kdockwidget.cpp.

void KDockWidget::virtual_hook	(	int	id,
		void *	data
	)			`[protected, virtual]`

Definition at line 3316 of file kdockwidget.cpp.

void KDockWidget::widgetSet ( QWidget * ) [signal]

Since:: 3.2 is emitted after the setWidget method has finished

Member Data Documentation

DockPosition KDockWidget::currentDockPos [protected]

the current dock position.

Definition at line 814 of file kdockwidget.h.

KDockWidget* KDockWidget::formerBrotherDockWidget [protected]

earlier closest neighbor widget, so it's possible to dock back to it.

Definition at line 810 of file kdockwidget.h.

DockPosition KDockWidget::formerDockPos [protected]

the former dock position when it really was at another position before.

Definition at line 818 of file kdockwidget.h.

QString KDockWidget::tabPageTitle [protected]

a string used as title of the tab page when in tab page mode

Definition at line 826 of file kdockwidget.h.

QString KDockWidget::toolTipStr [protected]

a string used as tooltip for the tab page header when in dock-centered mode.

Definition at line 822 of file kdockwidget.h.

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

kdeui

KDockWidget Class Reference

Public Types

Public Slots

Signals

Public Member Functions

Protected Slots

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

kdeui

API Reference