The IDockWidgetCatalog interface provide methods to work with dockable widgets in application. More...

#include <IDockWidgetCatalog.h>

Signals
void	dockWidgetAdded (QDockWidget *widget)

Public Member Functions
virtual QDockWidget *	addDockWidget (QWidget *widget, const QString &windowTitle="")=0

virtual QDockWidget *	addDockWidget (QWidget *widget, const QString &windowTitle, Qt::DockWidgetArea area)=0

virtual void	deleteDockWidget (QDockWidget *dockWidget)=0

virtual QList< QDockWidget * >	dockWidgets () const =0

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

	QObject (QObject parent, const char name)

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	event (QEvent *e)

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

Additional Inherited Members
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)

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)

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

Properties inherited from QObject
	objectName

Detailed Description

The IDockWidgetCatalog interface provide methods to work with dockable widgets in application.

IDockWidgetCatalog knows about all the dockable windows available to an application. This class allows you to add new dock window, and it is also used in Custimozation dialog. Use IInteractionService::catalogs().dockWidgetCatalog() to get a reference to this object to insert widgets specific to your extensions.

To add checkable action that can be used to show or close this dock widget to the menu use IMenuCatalog:

*   QMenu *windowsMenu = menuCatalog.findMenuEverywhere(tr("Windows"));
*   windowsMenu->addAction(dockWidgetCatalog->addDockWidget(new MyWidget()));
* 

Member Function Documentation

virtual QDockWidget* IDockWidgetCatalog::addDockWidget	(	QWidget *	widget,
		const QString &	windowTitle = `""`
	)

pure virtual

Creates new QDockWidget, sets widget to it and adds new dockable widget to the main window into the left area. Null pointer will be skipped.

Note, that catalog takes ownership of the new dock widget.

Implemented in DockWidgetCatalog.

virtual QDockWidget* IDockWidgetCatalog::addDockWidget	(	QWidget *	widget,
		const QString &	windowTitle,
		Qt::DockWidgetArea	area
	)

pure virtual

Creates new QDockWidget, sets widget to it and adds new dockable widget to the main window into the area area. Null pointer will be skipped.

Note, that catalog takes ownership of the new dock widget.

Implemented in DockWidgetCatalog.

virtual void IDockWidgetCatalog::deleteDockWidget ( QDockWidget * dockWidget )

pure virtual

Removes specified dockable widget from containter and calls delete.

Usualy you should not use this method directly - it is used only by IComponentConfigurationDelegate to deconfigure component and revert changes is did.

Implemented in DockWidgetCatalog.

virtual QList<QDockWidget *> IDockWidgetCatalog::dockWidgets ( ) const

pure virtual

Returns all dockable widgets added to the catalog.

Implemented in DockWidgetCatalog.

void IDockWidgetCatalog::dockWidgetAdded ( QDockWidget * widget )

signal

This signal is emitted after the dock widget was added to the catalog.

See Also: addDockWidget.

Signals

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation