#include <k3dockwidget.h>

Inheritance diagram for K3DockWidget:

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 (K3DockWidget *dw, K3DockWidget::DockPosition dp)

void	hasUndocked ()

void	headerCloseButtonClicked ()

void	headerDockbackButtonClicked ()

void	iMBeingClosed ()

void	setDockDefaultPos ()

void	widgetSet (QWidget *)

Public Member Functions
	K3DockWidget (K3DockManager dockManager, const char name, const QPixmap &pixmap, QWidget *parent=0L, const QString &strCaption=QString(), const QString &strTabPageLabel=QLatin1String(" "), Qt::WindowFlags f=0)

virtual	~K3DockWidget ()

K3DockWidget::DockPosition	currentDockPosition () const

K3DockManager *	dockManager () const

int	dockSite () const

int	enableDocking () const

virtual bool	event (QEvent *)

K3DockWidget *	findNearestDockWidget (DockPosition pos)

K3DockWidgetAbstractHeader *	getHeader ()

QWidget *	getWidget () const

bool	isDockBackPossible () const

void	makeDockVisible ()

K3DockWidget *	manualDock (K3DockWidget *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

K3DockTabGroup *	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 (K3DockWidgetAbstractHeader *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 ()

Public Member Functions inherited from QWidget
	QWidget (QWidget *parent, QFlags< Qt::WindowType > f)

	QWidget (QWidget parent, const char name, QFlags< Qt::WindowType > f)

	~QWidget ()

bool	acceptDrops () const

QString	accessibleDescription () const

QString	accessibleName () const

QList< QAction * >	actions () const

void	activateWindow ()

void	addAction (QAction *action)

void	addActions (QList< QAction * > actions)

void	adjustSize ()

bool	autoFillBackground () const

Qt::BackgroundMode	backgroundMode () const

QPoint	backgroundOffset () const

BackgroundOrigin	backgroundOrigin () const

QPalette::ColorRole	backgroundRole () const

QSize	baseSize () const

QString	caption () const

QWidget *	childAt (int x, int y, bool includeThis) const

QWidget *	childAt (const QPoint &p, bool includeThis) const

QWidget *	childAt (int x, int y) const

QWidget *	childAt (const QPoint &p) const

QRect	childrenRect () const

QRegion	childrenRegion () const

void	clearFocus ()

void	clearMask ()

bool	close (bool alsoDelete)

bool	close ()

QColorGroup	colorGroup () const

void	constPolish () const

QMargins	contentsMargins () const

QRect	contentsRect () const

Qt::ContextMenuPolicy	contextMenuPolicy () const

QCursor	cursor () const

void	customContextMenuRequested (const QPoint &pos)

void	drawText (const QPoint &p, const QString &s)

void	drawText (int x, int y, const QString &s)

WId	effectiveWinId () const

void	ensurePolished () const

void	erase ()

void	erase (const QRect &rect)

void	erase (const QRegion &rgn)

void	erase (int x, int y, int w, int h)

Qt::FocusPolicy	focusPolicy () const

QWidget *	focusProxy () const

QWidget *	focusWidget () const

const QFont &	font () const

QFontInfo	fontInfo () const

QFontMetrics	fontMetrics () const

QPalette::ColorRole	foregroundRole () const

QRect	frameGeometry () const

QSize	frameSize () const

const QRect &	geometry () const

void	getContentsMargins (int left, int top, int right, int bottom) const

virtual HDC	getDC () const

void	grabGesture (Qt::GestureType gesture, QFlags< Qt::GestureFlag > flags)

void	grabKeyboard ()

void	grabMouse ()

void	grabMouse (const QCursor &cursor)

int	grabShortcut (const QKeySequence &key, Qt::ShortcutContext context)

QGraphicsEffect *	graphicsEffect () const

QGraphicsProxyWidget *	graphicsProxyWidget () const

bool	hasEditFocus () const

bool	hasFocus () const

bool	hasMouse () const

bool	hasMouseTracking () const

int	height () const

virtual int	heightForWidth (int w) const

void	hide ()

const QPixmap *	icon () const

void	iconify ()

QString	iconText () const

QInputContext *	inputContext ()

Qt::InputMethodHints	inputMethodHints () const

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery query) const

void	insertAction (QAction before, QAction action)

void	insertActions (QAction before, QList< QAction > actions)

bool	isActiveWindow () const

bool	isAncestorOf (const QWidget *child) const

bool	isDesktop () const

bool	isDialog () const

bool	isEnabled () const

bool	isEnabledTo (QWidget *ancestor) const

bool	isEnabledToTLW () const

bool	isFullScreen () const

bool	isHidden () const

bool	isInputMethodEnabled () const

bool	isMaximized () const

bool	isMinimized () const

bool	isModal () const

bool	isPopup () const

bool	isShown () const

bool	isTopLevel () const

bool	isUpdatesEnabled () const

bool	isVisible () const

bool	isVisibleTo (QWidget *ancestor) const

bool	isVisibleToTLW () const

bool	isWindow () const

bool	isWindowModified () const

QLayout *	layout () const

Qt::LayoutDirection	layoutDirection () const

QLocale	locale () const

void	lower ()

Qt::HANDLE	macCGHandle () const

Qt::HANDLE	macQDHandle () const

QPoint	mapFrom (QWidget *parent, const QPoint &pos) const

QPoint	mapFromGlobal (const QPoint &pos) const

QPoint	mapFromParent (const QPoint &pos) const

QPoint	mapTo (QWidget *parent, const QPoint &pos) const

QPoint	mapToGlobal (const QPoint &pos) const

QPoint	mapToParent (const QPoint &pos) const

QRegion	mask () const

int	maximumHeight () const

QSize	maximumSize () const

int	maximumWidth () const

int	minimumHeight () const

QSize	minimumSize () const

virtual QSize	minimumSizeHint () const

int	minimumWidth () const

void	move (int x, int y)

void	move (const QPoint &)

QWidget *	nativeParentWidget () const

QWidget *	nextInFocusChain () const

QRect	normalGeometry () const

void	overrideWindowFlags (QFlags< Qt::WindowType > flags)

bool	ownCursor () const

bool	ownFont () const

bool	ownPalette () const

virtual QPaintEngine *	paintEngine () const

const QPalette &	palette () const

QWidget *	parentWidget (bool sameWindow) const

QWidget *	parentWidget () const

QPlatformWindow *	platformWindow () const

QPlatformWindowFormat	platformWindowFormat () const

void	polish ()

QPoint	pos () const

QWidget *	previousInFocusChain () const

void	raise ()

void	recreate (QWidget *parent, QFlags< Qt::WindowType > f, const QPoint &p, bool showIt)

QRect	rect () const

virtual void	releaseDC (HDC hdc) const

void	releaseKeyboard ()

void	releaseMouse ()

void	releaseShortcut (int id)

void	removeAction (QAction *action)

void	render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, QFlags< QWidget::RenderFlag > renderFlags)

void	render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, QFlags< QWidget::RenderFlag > renderFlags)

void	repaint (int x, int y, int w, int h, bool b)

void	repaint (const QRegion &rgn, bool b)

void	repaint ()

void	repaint (int x, int y, int w, int h)

void	repaint (const QRegion &rgn)

void	repaint (bool b)

void	repaint (const QRect &rect)

void	repaint (const QRect &r, bool b)

void	reparent (QWidget *parent, QFlags< Qt::WindowType > f, const QPoint &p, bool showIt)

void	reparent (QWidget *parent, const QPoint &p, bool showIt)

void	resize (int w, int h)

void	resize (const QSize &)

bool	restoreGeometry (const QByteArray &geometry)

QByteArray	saveGeometry () const

void	scroll (int dx, int dy)

void	scroll (int dx, int dy, const QRect &r)

void	setAcceptDrops (bool on)

void	setAccessibleDescription (const QString &description)

void	setAccessibleName (const QString &name)

void	setActiveWindow ()

void	setAttribute (Qt::WidgetAttribute attribute, bool on)

void	setAutoFillBackground (bool enabled)

void	setBackgroundColor (const QColor &color)

void	setBackgroundMode (Qt::BackgroundMode widgetBackground, Qt::BackgroundMode paletteBackground)

void	setBackgroundOrigin (BackgroundOrigin background)

void	setBackgroundPixmap (const QPixmap &pixmap)

void	setBackgroundRole (QPalette::ColorRole role)

void	setBaseSize (const QSize &)

void	setBaseSize (int basew, int baseh)

void	setCaption (const QString &c)

void	setContentsMargins (int left, int top, int right, int bottom)

void	setContentsMargins (const QMargins &margins)

void	setContextMenuPolicy (Qt::ContextMenuPolicy policy)

void	setCursor (const QCursor &)

void	setDisabled (bool disable)

void	setEditFocus (bool enable)

void	setEnabled (bool)

void	setEraseColor (const QColor &color)

void	setErasePixmap (const QPixmap &pixmap)

void	setFixedHeight (int h)

void	setFixedSize (const QSize &s)

void	setFixedSize (int w, int h)

void	setFixedWidth (int w)

void	setFocus (Qt::FocusReason reason)

void	setFocus ()

void	setFocusPolicy (Qt::FocusPolicy policy)

void	setFocusProxy (QWidget *w)

void	setFont (const QFont &)

void	setFont (const QFont &f, bool b)

void	setForegroundRole (QPalette::ColorRole role)

void	setGeometry (int x, int y, int w, int h)

void	setGeometry (const QRect &)

void	setGraphicsEffect (QGraphicsEffect *effect)

void	setHidden (bool hidden)

void	setIcon (const QPixmap &i)

void	setIconText (const QString &it)

void	setInputContext (QInputContext *context)

void	setInputMethodEnabled (bool enabled)

void	setInputMethodHints (QFlags< Qt::InputMethodHint > hints)

void	setKeyCompression (bool b)

void	setLayout (QLayout *layout)

void	setLayoutDirection (Qt::LayoutDirection direction)

void	setLocale (const QLocale &locale)

void	setMask (const QBitmap &bitmap)

void	setMask (const QRegion &region)

void	setMaximumHeight (int maxh)

void	setMaximumSize (const QSize &)

void	setMaximumSize (int maxw, int maxh)

void	setMaximumWidth (int maxw)

void	setMinimumHeight (int minh)

void	setMinimumSize (int minw, int minh)

void	setMinimumSize (const QSize &)

void	setMinimumWidth (int minw)

void	setMouseTracking (bool enable)

void	setPalette (const QPalette &)

void	setPalette (const QPalette &p, bool b)

void	setPaletteBackgroundColor (const QColor &color)

void	setPaletteBackgroundPixmap (const QPixmap &pixmap)

void	setPaletteForegroundColor (const QColor &color)

void	setParent (QWidget *parent)

void	setParent (QWidget *parent, QFlags< Qt::WindowType > f)

void	setPlatformWindow (QPlatformWindow *window)

void	setPlatformWindowFormat (const QPlatformWindowFormat &format)

void	setShortcutAutoRepeat (int id, bool enable)

void	setShortcutEnabled (int id, bool enable)

void	setShown (bool shown)

void	setSizeIncrement (const QSize &)

void	setSizeIncrement (int w, int h)

void	setSizePolicy (QSizePolicy::Policy hor, QSizePolicy::Policy ver, bool hfw)

void	setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)

void	setSizePolicy (QSizePolicy)

void	setStatusTip (const QString &)

void	setStyle (QStyle *style)

QStyle *	setStyle (const QString &style)

void	setStyleSheet (const QString &styleSheet)

void	setToolTip (const QString &)

void	setUpdatesEnabled (bool enable)

void	setupUi (QWidget *widget)

virtual void	setVisible (bool visible)

void	setWhatsThis (const QString &)

void	setWindowFilePath (const QString &filePath)

void	setWindowFlags (QFlags< Qt::WindowType > type)

void	setWindowIcon (const QIcon &icon)

void	setWindowIconText (const QString &)

void	setWindowModality (Qt::WindowModality windowModality)

void	setWindowModified (bool)

void	setWindowOpacity (qreal level)

void	setWindowRole (const QString &role)

void	setWindowState (QFlags< Qt::WindowState > windowState)

void	setWindowSurface (QWindowSurface *surface)

void	setWindowTitle (const QString &)

void	show ()

void	showFullScreen ()

void	showMaximized ()

void	showMinimized ()

void	showNormal ()

QSize	size () const

virtual QSize	sizeHint () const

QSize	sizeIncrement () const

QSizePolicy	sizePolicy () const

void	stackUnder (QWidget *w)

QString	statusTip () const

QStyle *	style () const

QString	styleSheet () const

bool	testAttribute (Qt::WidgetAttribute attribute) const

QString	toolTip () const

QWidget *	topLevelWidget () const

bool	underMouse () const

void	ungrabGesture (Qt::GestureType gesture)

void	unsetCursor ()

void	unsetFont ()

void	unsetLayoutDirection ()

void	unsetLocale ()

void	unsetPalette ()

void	update (const QRect &rect)

void	update (const QRegion &rgn)

void	update (int x, int y, int w, int h)

void	update ()

void	updateGeometry ()

bool	updatesEnabled () const

QRect	visibleRect () const

QRegion	visibleRegion () const

QString	whatsThis () const

int	width () const

QWidget *	window () const

QString	windowFilePath () const

Qt::WindowFlags	windowFlags () const

QIcon	windowIcon () const

QString	windowIconText () const

Qt::WindowModality	windowModality () const

qreal	windowOpacity () const

QString	windowRole () const

Qt::WindowStates	windowState () const

QWindowSurface *	windowSurface () const

QString	windowTitle () const

Qt::WindowType	windowType () const

WId	winId () const

int	x () const

const QX11Info &	x11Info () const

Qt::HANDLE	x11PictureHandle () const

int	y () const

Public Member Functions inherited from QObject
	QObject (QObject *parent)

	QObject (QObject parent, const char name)

virtual	~QObject ()

bool	blockSignals (bool block)

QObject *	child (const char objName, const char inheritsClass, bool recursiveSearch) const

const QObjectList &	children () const

const char *	className () const

bool	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const QObject receiver, const char method)

bool	disconnect (const char signal, const QObject receiver, const char *method)

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name) const

QList< T >	findChildren (const QRegExp &regExp) const

QList< T >	findChildren (const QString &name) const

bool	inherits (const char *className) const

void	insertChild (QObject *object)

void	installEventFilter (QObject *filterObj)

bool	isA (const char *className) const

bool	isWidgetType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

const char *	name () const

const char *	name (const char *defaultName) const

QString	objectName () const

QObject *	parent () const

QVariant	property (const char *name) const

void	removeChild (QObject *object)

void	removeEventFilter (QObject *obj)

void	setName (const char *name)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval)

QThread *	thread () const

Public Member Functions inherited from QPaintDevice
virtual	~QPaintDevice ()

int	colorCount () const

int	depth () const

int	height () const

int	heightMM () const

int	logicalDpiX () const

int	logicalDpiY () const

int	numColors () const

virtual QPaintEngine *	paintEngine () const =0

bool	paintingActive () const

int	physicalDpiX () const

int	physicalDpiY () const

int	width () const

int	widthMM () const

int	x11Cells () const

Qt::HANDLE	x11Colormap () const

bool	x11DefaultColormap () const

bool	x11DefaultVisual () const

int	x11Depth () const

Display *	x11Display () const

int	x11Screen () const

void *	x11Visual () const

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 *	latestK3DockContainer ()

void	setFormerBrotherDockWidget (K3DockWidget *)

void	setLatestK3DockContainer (QWidget *)

void	updateHeader ()

virtual void	virtual_hook (int id, void *data)

Protected Member Functions inherited from QWidget
virtual void	actionEvent (QActionEvent *event)

virtual void	changeEvent (QEvent *event)

virtual void	closeEvent (QCloseEvent *event)

virtual void	contextMenuEvent (QContextMenuEvent *event)

void	create (WId window, bool initializeWindow, bool destroyOldWindow)

void	destroy (bool destroyWindow, bool destroySubWindows)

virtual void	dragEnterEvent (QDragEnterEvent *event)

virtual void	dragLeaveEvent (QDragLeaveEvent *event)

virtual void	dragMoveEvent (QDragMoveEvent *event)

virtual void	dropEvent (QDropEvent *event)

virtual void	enterEvent (QEvent *event)

virtual void	focusInEvent (QFocusEvent *event)

bool	focusNextChild ()

virtual bool	focusNextPrevChild (bool next)

virtual void	focusOutEvent (QFocusEvent *event)

bool	focusPreviousChild ()

virtual void	hideEvent (QHideEvent *event)

virtual void	inputMethodEvent (QInputMethodEvent *event)

virtual void	keyPressEvent (QKeyEvent *event)

virtual void	keyReleaseEvent (QKeyEvent *event)

virtual void	languageChange ()

virtual void	leaveEvent (QEvent *event)

virtual bool	macEvent (EventHandlerCallRef caller, EventRef event)

virtual int	metric (PaintDeviceMetric m) const

virtual void	mouseDoubleClickEvent (QMouseEvent *event)

virtual void	mouseMoveEvent (QMouseEvent *event)

virtual void	mousePressEvent (QMouseEvent *event)

virtual void	mouseReleaseEvent (QMouseEvent *event)

virtual void	moveEvent (QMoveEvent *event)

virtual void	paintEvent (QPaintEvent *event)

virtual bool	qwsEvent (QWSEvent *event)

void	resetInputContext ()

virtual void	resizeEvent (QResizeEvent *event)

virtual void	showEvent (QShowEvent *event)

virtual void	tabletEvent (QTabletEvent *event)

void	updateMicroFocus ()

virtual void	wheelEvent (QWheelEvent *event)

virtual bool	winEvent (MSG message, long result)

virtual bool	x11Event (XEvent *event)

Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char signal, const QObject object, const char *method)

virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const char *signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const char *signal)

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Protected Member Functions inherited from QPaintDevice
	QPaintDevice ()

Protected Attributes
DockPosition	currentDockPos

K3DockWidget *	formerBrotherDockWidget

DockPosition	formerDockPos

QString	tabPageTitle

QString	toolTipStr

Additional Inherited Members
Static Public Member Functions inherited from QWidget
QWidget *	find (WId id)

QWidget *	keyboardGrabber ()

QWidget *	mouseGrabber ()

void	setTabOrder (QWidget first, QWidget second)

QWidgetMapper *	wmapper ()

Static Public Member Functions inherited from QObject
bool	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Static Public Member Functions inherited from QPaintDevice
int	x11AppCells (int screen)

Qt::HANDLE	x11AppColormap (int screen)

bool	x11AppDefaultColormap (int screen)

bool	x11AppDefaultVisual (int screen)

int	x11AppDepth (int screen)

Display *	x11AppDisplay ()

int	x11AppDpiX (int screen)

int	x11AppDpiY (int screen)

Qt::HANDLE	x11AppRootWindow (int screen)

int	x11AppScreen ()

void *	x11AppVisual (int screen)

void	x11SetAppDpiX (int dpi, int screen)

void	x11SetAppDpiY (int dpi, int screen)

Public Attributes inherited from QWidget
typedef	RenderFlags

Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

Properties inherited from QWidget
	acceptDrops

	accessibleDescription

	accessibleName

	autoFillBackground

	baseSize

	childrenRect

	childrenRegion

	contextMenuPolicy

	cursor

	enabled

	focus

	focusPolicy

	font

	frameGeometry

	frameSize

	fullScreen

	geometry

	height

	inputMethodHints

	isActiveWindow

	layoutDirection

	locale

	maximized

	maximumHeight

	maximumSize

	maximumWidth

	minimized

	minimumHeight

	minimumSize

	minimumSizeHint

	minimumWidth

	modal

	mouseTracking

	normalGeometry

	palette

	pos

	rect

	size

	sizeHint

	sizeIncrement

	sizePolicy

	statusTip

	styleSheet

	toolTip

	updatesEnabled

	visible

	whatsThis

	width

	windowFilePath

	windowFlags

	windowIcon

	windowIconText

	windowModality

	windowModified

	windowOpacity

	windowTitle

	x

	y

Properties inherited from QObject
	objectName

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 K3DockWidget can only be docked to a K3DockWidget.

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

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

...
K3DockMainWindow* mainWidget;
...
K3DockWidget* 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 K3DockMainWindow how a dockwidget is docked in.

Author: Max Judin (documentation: Falk Brettschneider).

Definition at line 415 of file k3dockwidget.h.

Member Enumeration Documentation

enum K3DockWidget::DockPosition

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

Enumerator
DockNone
DockTop
DockLeft
DockRight
DockBottom
DockCenter
DockDesktop
DockToSpecialSites
DockCorner
DockFullSite
DockFullDocking

Definition at line 451 of file k3dockwidget.h.

Constructor & Destructor Documentation

K3DockWidget::K3DockWidget	(	K3DockManager *	dockManager,
		const char *	name,
		const QPixmap &	pixmap,
		QWidget *	parent = `0L`,
		const QString &	strCaption = `QString()`,
		const QString &	strTabPageLabel = `QLatin1String( " " )`,
		Qt::WindowFlags	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 534 of file k3dockwidget.cpp.

K3DockWidget::~K3DockWidget ( )

virtual

Destructs a dockwidget.

Definition at line 604 of file k3dockwidget.cpp.

Member Function Documentation

void K3DockWidget::changeHideShowState ( )

slot

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

Definition at line 1622 of file k3dockwidget.cpp.

K3DockWidget::DockPosition K3DockWidget::currentDockPosition ( ) const

Returns: the current dock position.

Definition at line 1363 of file k3dockwidget.cpp.

void K3DockWidget::dockBack ( )

slot

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

Definition at line 1680 of file k3dockwidget.cpp.

void K3DockWidget::docking	(	K3DockWidget *	dw,
		K3DockWidget::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

K3DockManager * K3DockWidget::dockManager ( ) const

Returns: The dockmanager that is responsible for this.

Definition at line 1607 of file k3dockwidget.cpp.

int K3DockWidget::dockSite ( ) const

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

Definition at line 840 of file k3dockwidget.cpp.

int K3DockWidget::enableDocking ( ) const

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

Definition at line 830 of file k3dockwidget.cpp.

bool K3DockWidget::event ( QEvent * event )

virtual

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

Reimplemented from QWidget.

Definition at line 952 of file k3dockwidget.cpp.

K3DockWidget * K3DockWidget::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

Definition at line 995 of file k3dockwidget.cpp.

int K3DockWidget::forcedFixedHeight ( )

slot

Definition at line 1335 of file k3dockwidget.cpp.

int K3DockWidget::forcedFixedWidth ( )

slot

Definition at line 1330 of file k3dockwidget.cpp.

K3DockWidgetAbstractHeader * K3DockWidget::getHeader ( )

get the pointer to the header widget

Definition at line 796 of file k3dockwidget.cpp.

QWidget * K3DockWidget::getWidget ( ) const

Get the embedded widget.

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

Definition at line 1569 of file k3dockwidget.cpp.

void K3DockWidget::hasUndocked ( )

signal

Emitted when the widget has undocked.

void K3DockWidget::headerCloseButtonClicked ( )

signal

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

void K3DockWidget::headerDockbackButtonClicked ( )

signal

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

void K3DockWidget::iMBeingClosed ( )

signal

Emitted when the widget processes a close event.

bool K3DockWidget::isDockBackPossible ( ) const

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

Definition at line 1710 of file k3dockwidget.cpp.

QWidget * K3DockWidget::latestK3DockContainer ( )

protected

Definition at line 787 of file k3dockwidget.cpp.

void K3DockWidget::leaveEvent ( QEvent * e )

protectedvirtualslot

Definition at line 639 of file k3dockwidget.cpp.

void K3DockWidget::loseFormerBrotherDockWidget ( )

protectedslot

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 1671 of file k3dockwidget.cpp.

void K3DockWidget::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 1638 of file k3dockwidget.cpp.

K3DockWidget * K3DockWidget::manualDock	(	K3DockWidget *	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 K3DockMainWindow 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 1023 of file k3dockwidget.cpp.

bool K3DockWidget::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 K3DockMainWindow.
It isn't able to dock to another widget.

Definition at line 1595 of file k3dockwidget.cpp.

bool K3DockWidget::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 K3DockMainWindow.

Definition at line 1601 of file k3dockwidget.cpp.

void K3DockWidget::mouseMoveEvent ( QMouseEvent * mme )

protectedvirtualslot

Definition at line 717 of file k3dockwidget.cpp.

void K3DockWidget::mousePressEvent ( QMouseEvent * mme )

protectedvirtualslot

Definition at line 648 of file k3dockwidget.cpp.

void K3DockWidget::mouseReleaseEvent ( QMouseEvent * ev )

protectedvirtualslot

Definition at line 708 of file k3dockwidget.cpp.

void K3DockWidget::paintEvent ( QPaintEvent * pe )

protectedvirtualslot

Definition at line 627 of file k3dockwidget.cpp.

QWidget * K3DockWidget::parentDockContainer ( ) const

Definition at line 1303 of file k3dockwidget.cpp.

K3DockTabGroup * K3DockWidget::parentDockTabGroup ( ) const

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

Definition at line 1295 of file k3dockwidget.cpp.

const QPixmap & K3DockWidget::pixmap ( ) const

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

Definition at line 600 of file k3dockwidget.cpp.

void K3DockWidget::restoreFromForcedFixedSize ( )

slot

Definition at line 1340 of file k3dockwidget.cpp.

void K3DockWidget::setDockDefaultPos ( )

signal

Signals that the dock default position is set.

void K3DockWidget::setDockSite ( int pos )

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 835 of file k3dockwidget.cpp.

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

Definition at line 941 of file k3dockwidget.cpp.

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

Sets the type of the dock window.

Parameters

windowType is type of dock window

Definition at line 933 of file k3dockwidget.cpp.

void K3DockWidget::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 820 of file k3dockwidget.cpp.

void K3DockWidget::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 K3DockSplitter

Definition at line 1321 of file k3dockwidget.cpp.

void K3DockWidget::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 K3DockSplitter

Definition at line 1312 of file k3dockwidget.cpp.

void K3DockWidget::setFormerBrotherDockWidget ( K3DockWidget * dockWidget )

protected

Definition at line 1663 of file k3dockwidget.cpp.

void K3DockWidget::setHeader ( K3DockWidgetAbstractHeader * 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 800 of file k3dockwidget.cpp.

void K3DockWidget::setLatestK3DockContainer ( QWidget * container )

protected

Definition at line 776 of file k3dockwidget.cpp.

void K3DockWidget::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

Definition at line 584 of file k3dockwidget.cpp.

void K3DockWidget::setTabPageLabel ( const QString & label )

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 1718 of file k3dockwidget.cpp.

void K3DockWidget::setToolTipString ( const QString & ttStr )

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 1612 of file k3dockwidget.cpp.

void K3DockWidget::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 1525 of file k3dockwidget.cpp.

void K3DockWidget::show ( void )

virtual

Add dockwidget management actions to QWidget::show.

Definition at line 914 of file k3dockwidget.cpp.

const QString & K3DockWidget::tabPageLabel ( ) const

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

Definition at line 1723 of file k3dockwidget.cpp.

void K3DockWidget::toDesktop ( )

slot

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

Definition at line 1353 of file k3dockwidget.cpp.

const QString & K3DockWidget::toolTipString ( ) const

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

Definition at line 1617 of file k3dockwidget.cpp.

QWidget * K3DockWidget::transientTo ( )

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

Definition at line 948 of file k3dockwidget.cpp.

void K3DockWidget::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 1368 of file k3dockwidget.cpp.

void K3DockWidget::updateHeader ( )

protected

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

The header is hidden if:

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

Definition at line 845 of file k3dockwidget.cpp.

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

protectedvirtual

Definition at line 3457 of file k3dockwidget.cpp.

void K3DockWidget::widgetSet ( QWidget * )

signal

is emitted after the setWidget method has finished

Member Data Documentation

DockPosition K3DockWidget::currentDockPos

protected

the current dock position.

Definition at line 789 of file k3dockwidget.h.

K3DockWidget* K3DockWidget::formerBrotherDockWidget

protected

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

Definition at line 785 of file k3dockwidget.h.

DockPosition K3DockWidget::formerDockPos

protected

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

Definition at line 793 of file k3dockwidget.h.

QString K3DockWidget::tabPageTitle

protected

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

Definition at line 801 of file k3dockwidget.h.

QString K3DockWidget::toolTipStr

protected

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

Definition at line 797 of file k3dockwidget.h.

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

KDE3Support

Public Types

Public Slots

Signals

Public Member Functions

Protected Slots

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

KDE3Support

kdelibs API Reference

Search