KParts::DockMainWindow3 Class Reference

#include <dockmainwindow3.h>

Inheritance diagram for KParts::DockMainWindow3:

Public Member Functions
	DockMainWindow3 (QWidget *parent=0L, const char *name=0L, Qt::WindowFlags f=0)
virtual	~DockMainWindow3 ()
Public Member Functions inherited from K3DockMainWindow
	K3DockMainWindow (QWidget *parent=0L, const char *name=0L, Qt::WindowFlags 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())
Public Member Functions inherited from KXmlGuiWindow
	KXmlGuiWindow (QWidget *parent=0, Qt::WindowFlags f=KDE_DEFAULT_WINDOWFLAGS)
virtual	~KMainWindow ()
virtual	~KXMLGUIBuilder ()
virtual	~KXMLGUIClient ()
virtual	~KXmlGuiWindow ()
QAction *	action (const char *name) const
virtual QAction *	action (const QDomElement &element) const
virtual KActionCollection *	actionCollection () const
void	addStateActionDisabled (const QString &state, const QString &action)
void	addStateActionEnabled (const QString &state, const QString &action)
virtual void	applyMainWindowSettings (const KConfigGroup &config, bool force=false)
KConfigGroup	autoSaveConfigGroup () const
QString	autoSaveGroup () const
bool	autoSaveSettings () const
void	beginXMLPlug (QWidget *)
KXMLGUIClient *	builderClient () const
KComponentData	builderComponentData () const
QList< KXMLGUIClient * >	childClients ()
KXMLGUIBuilder *	clientBuilder () const
virtual KComponentData	componentData () const
virtual QStringList	containerTags () const
virtual QWidget *	createContainer (QWidget *parent, int index, const QDomElement &element, QAction *&containerAction)
virtual QAction *	createCustomElement (QWidget *parent, int index, const QDomElement &element)
void	createGUI (const QString &xmlfile=QString())
void	createStandardStatusBarAction ()
KMenu *	customHelpMenu (bool showWhatsThis=true)
virtual QStringList	customTags () const
QString	dbusName () const
virtual QDomDocument	domDocument () const
void	endXMLPlug ()
KXMLGUIFactory *	factory () const
virtual void	finalizeGUI (KXMLGUIClient *client)
void	finalizeGUI (bool force)
StateChange	getActionsToChangeForState (const QString &state)
virtual KXMLGUIFactory *	guiFactory ()
bool	hasMenuBar ()
KMenu *	helpMenu (const QString &aboutAppText=QString(), bool showWhatsThis=true)
void	ignoreInitialGeometry ()
bool	initialGeometrySet () const
void	insertChildClient (KXMLGUIClient *child)
bool	isHelpMenuEnabled () const
bool	isStandardToolBarMenuEnabled () const
	KMainWindow (QWidget *parent=0, Qt::WindowFlags f=KDE_DEFAULT_WINDOWFLAGS)
	KXMLGUIBuilder (QWidget *widget)
	KXMLGUIClient ()
	KXMLGUIClient (KXMLGUIClient *parent)
virtual QString	localXMLFile () const
KMenuBar *	menuBar ()
KXMLGUIClient *	parentClient () const
void	plugActionList (const QString &name, const QList< QAction * > &actionList)
void	prepareXMLUnplug (QWidget *)
void	reloadXML ()
void	removeChildClient (KXMLGUIClient *child)
virtual void	removeContainer (QWidget *container, QWidget *parent, QDomElement &element, QAction *containerAction)
virtual void	removeCustomElement (QWidget *parent, QAction *action)
void	replaceXMLFile (const QString &xmlfile, const QString &localxmlfile, bool merge=false)
void	resetAutoSaveSettings ()
bool	restore (int number, bool show=true)
void	saveMainWindowSettings (const KConfigGroup &config)
void	setAutoSaveSettings (const KConfigGroup &group, bool saveWindowSize=true)
void	setAutoSaveSettings (const QString &groupName=QLatin1String("MainWindow"), bool saveWindowSize=true)
void	setBuilderClient (KXMLGUIClient *client)
void	setBuilderComponentData (const KComponentData &componentData)
void	setClientBuilder (KXMLGUIBuilder *builder)
void	setFactory (KXMLGUIFactory *factory)
void	setHelpMenuEnabled (bool showHelpMenu=true)
void	setStandardToolBarMenuEnabled (bool enable)
void	setupGUI (const QSize &defaultSize, StandardWindowOptions options=Default, const QString &xmlfile=QString())
void	setupGUI (StandardWindowOptions options=Default, const QString &xmlfile=QString())
void	setupToolbarMenuActions ()
void	setXMLGUIBuildDocument (const QDomDocument &doc)
KStatusBar *	statusBar ()
KToolBar *	toolBar (const QString &name=QString())
QAction *	toolBarMenuAction ()
QList< KToolBar * >	toolBars () const
void	unplugActionList (const QString &name)
QWidget *	widget ()
virtual QString	xmlFile () const
QDomDocument	xmlguiBuildDocument () const
Public Member Functions inherited from KMainWindow
	KMainWindow (QWidget *parent=0, Qt::WindowFlags f=KDE_DEFAULT_WINDOWFLAGS)
KConfigGroup	autoSaveConfigGroup () const
QString	autoSaveGroup () const
bool	autoSaveSettings () const
KMenu *	customHelpMenu (bool showWhatsThis=true)
QString	dbusName () const
bool	hasMenuBar ()
KMenu *	helpMenu (const QString &aboutAppText=QString(), bool showWhatsThis=true)
void	ignoreInitialGeometry ()
bool	initialGeometrySet () const
KMenuBar *	menuBar ()
void	resetAutoSaveSettings ()
bool	restore (int number, bool show=true)
void	saveMainWindowSettings (const KConfigGroup &config)
void	setAutoSaveSettings (const QString &groupName=QLatin1String("MainWindow"), bool saveWindowSize=true)
void	setAutoSaveSettings (const KConfigGroup &group, bool saveWindowSize=true)
KStatusBar *	statusBar ()
KToolBar *	toolBar (const QString &name=QString())
QList< KToolBar * >	toolBars () const
Public Member Functions inherited from KXMLGUIBuilder
	KXMLGUIBuilder (QWidget *widget)
KXMLGUIClient *	builderClient () const
KComponentData	builderComponentData () const
void	setBuilderClient (KXMLGUIClient *client)
void	setBuilderComponentData (const KComponentData &componentData)
QWidget *	widget ()
Public Member Functions inherited from KXMLGUIClient
	KXMLGUIClient ()
	KXMLGUIClient (KXMLGUIClient *parent)
QAction *	action (const char *name) const
void	addStateActionDisabled (const QString &state, const QString &action)
void	addStateActionEnabled (const QString &state, const QString &action)
void	beginXMLPlug (QWidget *)
QList< KXMLGUIClient * >	childClients ()
KXMLGUIBuilder *	clientBuilder () const
void	endXMLPlug ()
KXMLGUIFactory *	factory () const
StateChange	getActionsToChangeForState (const QString &state)
void	insertChildClient (KXMLGUIClient *child)
KXMLGUIClient *	parentClient () const
void	plugActionList (const QString &name, const QList< QAction * > &actionList)
void	prepareXMLUnplug (QWidget *)
void	reloadXML ()
void	removeChildClient (KXMLGUIClient *child)
void	replaceXMLFile (const QString &xmlfile, const QString &localxmlfile, bool merge=false)
void	setClientBuilder (KXMLGUIBuilder *builder)
void	setFactory (KXMLGUIFactory *factory)
void	setXMLGUIBuildDocument (const QDomDocument &doc)
void	unplugActionList (const QString &name)
QDomDocument	xmlguiBuildDocument () const
Public Member Functions inherited from KParts::PartBase
	PartBase ()
virtual	~PartBase ()
QObject *	partObject () const
void	setPartObject (QObject *object)

Protected Slots
void	createGUI (KParts::Part *part)
virtual void	slotSetStatusBarText (const QString &)
Protected Slots inherited from K3DockMainWindow
void	slotDockWidgetUndocked ()
Protected Slots inherited from KXmlGuiWindow
void	saveAutoSaveSettings ()
virtual void	saveNewToolbarConfig ()
virtual void	showAboutApplication ()
Protected Slots inherited from KMainWindow
void	saveAutoSaveSettings ()
virtual void	showAboutApplication ()

Protected Member Functions
virtual void	createShellGUI (bool create=true)
Protected Member Functions inherited from K3DockMainWindow
virtual void	virtual_hook (int id, void *data)
Protected Member Functions inherited from KXmlGuiWindow
virtual void	closeEvent (QCloseEvent *)
virtual bool	event (QEvent *event)
	KMainWindow (KMainWindowPrivate &dd, QWidget *parent, Qt::WindowFlags f)
void	loadStandardsXmlFile ()
void	parseGeometry (bool parsewidth)
virtual bool	queryClose ()
virtual bool	queryExit ()
virtual void	readGlobalProperties (KConfig *sessionConfig)
virtual void	readProperties (const KConfigGroup &)
bool	readPropertiesInternal (KConfig *, int)
void	restoreWindowSize (const KConfigGroup &config)
virtual void	saveGlobalProperties (KConfig *sessionConfig)
virtual void	saveProperties (KConfigGroup &)
void	savePropertiesInternal (KConfig *, int)
void	saveWindowSize (const KConfigGroup &config) const
virtual void	setComponentData (const KComponentData &componentData)
virtual void	setDOMDocument (const QDomDocument &document, bool merge=false)
virtual void	setLocalXMLFile (const QString &file)
bool	settingsDirty () const
virtual void	setXML (const QString &document, bool merge=false)
virtual void	setXMLFile (const QString &file, bool merge=false, bool setXMLDoc=true)
virtual void	stateChanged (const QString &newstate, ReverseStateChange reverse=StateNoReverse)
Protected Member Functions inherited from KMainWindow
	KMainWindow (KMainWindowPrivate &dd, QWidget *parent, Qt::WindowFlags f)
void	parseGeometry (bool parsewidth)
bool	readPropertiesInternal (KConfig *, int)
void	restoreWindowSize (const KConfigGroup &config)
void	savePropertiesInternal (KConfig *, int)
void	saveWindowSize (const KConfigGroup &config) const
bool	settingsDirty () const
Protected Member Functions inherited from KXMLGUIClient
void	loadStandardsXmlFile ()
Protected Member Functions inherited from KParts::PartBase
	PartBase (PartBasePrivate &dd)
void	loadPlugins (QObject *parent, KXMLGUIClient *parentGUIClient, const KComponentData &componentData)
virtual void	setComponentData (const KComponentData &componentData, bool loadPlugins)
virtual void	setComponentData (const KComponentData &componentData)
void	setPluginInterfaceVersion (int version)
void	setPluginLoadingMode (PluginLoadingMode loadingMode)

Additional Inherited Members
Public Types inherited from KXmlGuiWindow
enum	ReverseStateChange
enum	StandardWindowOption
Public Types inherited from KParts::PartBase
enum	PluginLoadingMode
Public Slots inherited from KXmlGuiWindow
void	appHelpActivated (void)
virtual void	configureToolbars ()
virtual void	setCaption (const QString &caption)
virtual void	setCaption (const QString &caption, bool modified)
virtual void	setPlainCaption (const QString &caption)
void	setSettingsDirty ()
void	slotStateChanged (const QString &newstate, bool reverse)
virtual void	slotStateChanged (const QString &newstate)
Signals inherited from K3DockMainWindow
void	dockWidgetHasUndocked (K3DockWidget *)
Static Public Member Functions inherited from KXmlGuiWindow
static bool	canBeRestored (int number)
static const QString	classNameOfToplevel (int number)
static QString	findMostRecentXMLFile (const QStringList &files, QString &doc)
static QList< KMainWindow * >	memberList ()
Static Public Member Functions inherited from KXMLGUIClient
static QString	findMostRecentXMLFile (const QStringList &files, QString &doc)
Public Attributes inherited from KXmlGuiWindow
	Create
	Default
	Keys
	Save
	StateNoReverse
	StateReverse
	StatusBar
	ToolBar
Public Attributes inherited from KParts::PartBase
	DoNotLoadPlugins
	LoadPlugins
	LoadPluginsIfEnabled
Protected Attributes inherited from K3DockMainWindow
K3DockManager *	dockManager
K3DockWidget *	mainDockWidget
Protected Attributes inherited from KParts::PartBase
PartBasePrivate *	d_ptr
Properties inherited from KXmlGuiWindow
QString	autoSaveGroup
bool	autoSaveSettings
bool	hasMenuBar
bool	initialGeometrySet
bool	standardToolBarMenuEnabled

Detailed Description

A KPart-aware main window with ability for docking widgets, whose user interface is described in XML.

Inherit your main dock-window from this class and don't forget to call setXMLFile() in the inherited constructor.

It implements all internal interfaces in the case of a K3DockMainWindow3 as host: the builder and servant interface (for menu merging).

Definition at line 47 of file dockmainwindow3.h.

Constructor & Destructor Documentation

DockMainWindow3::DockMainWindow3	(	QWidget *	parent = 0L,
		const char *	name = 0L,
		Qt::WindowFlags	f = 0
	)

Constructor, same signature as K3DockMainWindow3.

Definition at line 60 of file dockmainwindow3.cpp.

DockMainWindow3::~DockMainWindow3 ( )

virtual

Destructor.

Definition at line 68 of file dockmainwindow3.cpp.

Member Function Documentation

void DockMainWindow3::createGUI ( KParts::Part *  part )

protectedslot

Create the GUI (by merging the host's and the active part's)

Called on startup and whenever the active part changes For this you need to connect this slot to the KPartManager::activePartChanged() signal

Parameters

part	The active part (set to 0L if no part).

Definition at line 73 of file dockmainwindow3.cpp.

void DockMainWindow3::createShellGUI ( bool  create = true )

protectedvirtual

Definition at line 130 of file dockmainwindow3.cpp.

void DockMainWindow3::slotSetStatusBarText ( const QString &  text )

protectedvirtualslot

Called when the active part wants to change the statusbar message Reimplement if your dock-mainwindow has a complex statusbar (with several items)

Definition at line 125 of file dockmainwindow3.cpp.

---

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

• dockmainwindow3.h
• dockmainwindow3.cpp