A special kind of KMainWindow that is able to have dockwidget child widgets (and member of the dockwidget class set). More...

#include <k3dockwidget.h>

Inheritance diagram for K3DockMainWindow:

[legend]

List of all members.

Signals
void	dockWidgetHasUndocked (K3DockWidget *)
Public Member Functions
	K3DockMainWindow (QWidget parent=0L, const char name=0L, Qt::WFlags f=Qt::Window)
virtual	~K3DockMainWindow ()
void	activateDock ()
K3DockWidget *	createDockWidget (const QString &name, const QPixmap &pixmap, QWidget *parent=0L, const QString &strCaption=QString(), const QString &strTabPageLabel=QLatin1String(" "))
Q3PopupMenu *	dockHideShowMenu () const
K3DockWidget *	getMainDockWidget () const
void	makeDockInvisible (K3DockWidget *dock)
void	makeDockVisible (K3DockWidget *dock)
void	makeWidgetDockVisible (QWidget *widget)
K3DockManager *	manager () const
void	readDockConfig (QDomElement &base)
void	readDockConfig (KConfig *c=0L, const QString &group=QString())
void	setMainDockWidget (K3DockWidget *dockwidget)
void	setView (QWidget *widget)
void	writeDockConfig (QDomElement &base)
void	writeDockConfig (KConfig *c=0L, const QString &group=QString())
Protected Slots
void	slotDockWidgetUndocked ()
Protected Member Functions
virtual void	virtual_hook (int id, void *data)
Protected Attributes
K3DockManager *	dockManager
K3DockWidget *	mainDockWidget

Detailed Description

A special kind of KMainWindow that is able to have dockwidget child widgets (and member of the dockwidget class set).

The main widget should be a K3DockWidget where other K3DockWidget can be docked to the left, right, top, bottom or to the middle. Note: dock to the middle means to drop on a dockwidget and to unite them to a new widget, a tab control.

Furthermore, the K3DockMainWindow has got the K3DockManager and some data about the dock states.

If you've got some dockwidgets, you can dock them to the dockmainwindow to initialize a start scene: Here an example:

 DockApplication::DockApplication( const char* name) : K3DockMainWindow( name)
 {
   ...
   K3DockWidget* mainDock;
   mainDock = createDockWidget( "Falk's MainDockWidget", mainPixmap, 0L, "main_dock_widget");
   AnyContentsWidget* cw = new AnyContentsWidget( mainDock);
   mainDock->setWidget( cw);
   // allow others to dock to the 4 sides
   mainDock->setDockSite(K3DockWidget::DockCorner);
   // forbit docking abilities of mainDock itself
   mainDock->setEnableDocking(K3DockWidget::DockNone);
   setView( mainDock); // central widget in a KDE mainwindow
   setMainDockWidget( mainDock); // master dockwidget
   ...
   K3DockWidget* dockLeft;
   dockLeft = createDockWidget( "Intially left one", anyOtherPixmap, 0L, i18n("The left dockwidget"));
   AnotherWidget* aw = new AnotherWidget( dockLeft);
   dockLeft->setWidget( aw);
   dockLeft->manualDock( mainDock,              // dock target
                         K3DockWidget::DockLeft, // dock site
                         20 );                  // relation target/this (in percent)
   ...

Docking is fully dynamic at runtime. That means you can always move dockwidgets via drag and drop.

And last but not least you can use the popupmenu for showing or hiding any controlled dockwidget of this class and insert it to your main menu bar or anywhere else.

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

Definition at line 1278 of file k3dockwidget.h.

Constructor & Destructor Documentation

K3DockMainWindow::K3DockMainWindow	(	QWidget *	parent = `0L`,
		const char *	name = `0L`,
		Qt::WFlags	f = `Qt::Window`
	)

Constructs a dockmainwindow.

A special kind of KMainWindow that is able to have dockwidget child widgets.

It calls its base class constructor and does additional things concerning to the dock stuff:

information about the dock state of this' children gets initialized
a dockmanager is created...
...and gets initialized
the main dockwidget is set to 0

Parameters:

parent	Parent widget for the dock main widget
name	internal object name
f	Qt::WidgetFlags widget flags

The main widget should be a dockwidget where other dockwidgets can be docked to the left, right, top, bottom or to the middle. Furthermore, the K3DockMainWindow has got the KDocManager and some data about the dock states.

Author:: Max Judin.

Definition at line 105 of file k3dockwidget.cpp.

K3DockMainWindow::~K3DockMainWindow ( ) [virtual]

Destructs a dockmainwindow.

Definition at line 115 of file k3dockwidget.cpp.

Member Function Documentation

void K3DockMainWindow::activateDock ( )

It runs through all dockwidgets which are under control of the dockmanager and calls show() for every encapsulated widget and show() for the dockwidget itself if it is not in tab mode.

Additionally, if the main dockwidget is not a QDialog, it will be shown.

Definition at line 155 of file k3dockwidget.cpp.

K3DockWidget * K3DockMainWindow::createDockWidget	(	const QString &	name,
		const QPixmap &	pixmap,
		QWidget *	parent = `0L`,
		const QString &	strCaption = `QString()`,
		const QString &	strTabPageLabel = `QLatin1String( " " )`
	)

This is one of the most important methods! The K3DockMainWindow creates a new dockwidget object here that usually should encapsulate the user's widget.

The new dockwidget is automatically taken under control by the dockmanager of the dockmainwindow.

Parameters:

name	QObject name (default dockwidget caption)
pixmap	window icon (for instance shown when docked as tabwidget entry)
parent	parent widget for the new dockwidget
strCaption	window title (shown when toplevel)
strTabPageLabel	title of the tab page (visible when in tab page mode), if it is "", only the icon will be shown; if it is 0L, the label is set to strCaption

Returns:: a pointer to the new created dockwidget

Definition at line 150 of file k3dockwidget.cpp.

Q3PopupMenu * K3DockMainWindow::dockHideShowMenu ( ) const

Returns a popup menu that contains entries for all controlled dockwidgets making hiding and showing them possible.

Returns:: the wanted popup menu

Definition at line 160 of file k3dockwidget.cpp.

void K3DockMainWindow::dockWidgetHasUndocked ( K3DockWidget * ) [signal]

Signals a certain dockwidget is undocked now.

K3DockWidget * K3DockMainWindow::getMainDockWidget ( ) const

Returns the main dockwidget.

Returns:: pointer to the main dockwidget

Definition at line 132 of file k3dockwidget.cpp.

void K3DockMainWindow::makeDockInvisible ( K3DockWidget * dock )

This method hides the given dockwidget.

Parameters:

dock	the dockwidget that is to be shown

Definition at line 171 of file k3dockwidget.cpp.

void K3DockMainWindow::makeDockVisible ( K3DockWidget * dock )

This method shows the given dockwidget.

The clue is that it also considers the dockwidget could be a tab page and must set to be the activate one.

Parameters:

dock	the dockwidget that is to be shown

Definition at line 165 of file k3dockwidget.cpp.

void K3DockMainWindow::makeWidgetDockVisible ( QWidget * widget )

This is an overloaded member function, provided for convenience.

It differs from the above function only in what argument(s) it accepts.

Definition at line 177 of file k3dockwidget.cpp.

K3DockManager * K3DockMainWindow::manager ( ) const

Returns the dockmanager of this.

(see K3DockManager)

Returns:: pointer to the wanted dockmanager

Definition at line 120 of file k3dockwidget.cpp.

void K3DockMainWindow::readDockConfig ( QDomElement & base )

Reads the current dock window layout from a DOM tree below the given element.

Definition at line 187 of file k3dockwidget.cpp.

void K3DockMainWindow::readDockConfig	(	KConfig *	c = `0L`,
		const QString &	group = `QString()`
	)

It reads the current dock state from the given section of KConfig.

Parameters:

c	KDE class for saving configurations
group	name of section to read from

Definition at line 198 of file k3dockwidget.cpp.

void K3DockMainWindow::setMainDockWidget ( K3DockWidget * dockwidget )

Sets a new main dockwidget.

Additionally, the toolbar is re-initialized.

Parameters:

dockwidget dockwidget that become the new main dockwidget

Definition at line 125 of file k3dockwidget.cpp.

void K3DockMainWindow::setView ( QWidget * widget )

This method calls the base class method.

If the given widget inherits K3DockWidget, applyToWidget(this) is called.

Parameters:

widget any widget that should become the main view

Definition at line 137 of file k3dockwidget.cpp.

void K3DockMainWindow::slotDockWidgetUndocked ( ) [protected, slot]

Called whenever one of the dockwidgets of this has been undocked.

Definition at line 204 of file k3dockwidget.cpp.

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

Reimplemented from KXMLGUIBuilder.

Definition at line 3463 of file k3dockwidget.cpp.

void K3DockMainWindow::writeDockConfig	(	KConfig *	c = `0L`,
		const QString &	group = `QString()`
	)

It writes the current dock state in the given section of KConfig.

Parameters:

c	KDE class for saving configurations
group	name of section to write to

Definition at line 193 of file k3dockwidget.cpp.

void K3DockMainWindow::writeDockConfig ( QDomElement & base )

Saves the current dock window layout into a DOM tree below the given element.

Definition at line 182 of file k3dockwidget.cpp.

Member Data Documentation

K3DockManager* K3DockMainWindow::dockManager [protected]

A pointer to the manager for the dock process.

Definition at line 1429 of file k3dockwidget.h.

K3DockWidget* K3DockMainWindow::mainDockWidget [protected]

A pointer to the main dockwidget (where one can manualDock() to.

Definition at line 1424 of file k3dockwidget.h.

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

KDE3Support

K3DockMainWindow Class Reference

Signals

Public Member Functions

Protected Slots

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

KDE3Support

kdelibs