KParts::MainWindow Class Reference

#include <mainwindow.h>

Inheritance diagram for KParts::MainWindow:

Public Member Functions
	MainWindow (TQWidget *parent, const char *name=0L, WFlags f=(WFlags)(WType_TopLevel|WDestructiveClose))
	MainWindow (const char *name=0L, WFlags f=(WFlags) WDestructiveClose)
	MainWindow (int cflags, TQWidget *parent, const char *name=0L, WFlags f=(WFlags)(WType_TopLevel|WDestructiveClose))
virtual	~MainWindow ()
Public Member Functions inherited from TDEMainWindow
	TDEMainWindow (TQWidget *parent=0, const char *name=0, WFlags f=(WFlags)(WType_TopLevel|WDestructiveClose))
	TDEMainWindow (int cflags, TQWidget *parent=0, const char *name=0, WFlags f=(WFlags)(WType_TopLevel|WDestructiveClose))
TDEPopupMenu *	helpMenu (const TQString &aboutAppText=TQString::null, bool showWhatsThis=true)
TDEPopupMenu *	customHelpMenu (bool showWhatsThis=true)
virtual void	show ()
virtual void	hide ()
bool	restore (int number, bool show=true)
void	createGUI (const TQString &xmlfile=TQString::null, bool _conserveMemory=true)
void	setHelpMenuEnabled (bool showHelpMenu=true)
bool	isHelpMenuEnabled ()
bool	hasMenuBar ()
KMenuBar *	menuBar ()
KStatusBar *	statusBar ()
TDEToolBar *	toolBar (const char *name=0)
TQPtrListIterator< TDEToolBar >	toolBarIterator ()
TDEAccel *	accel ()
void	setAutoSaveSettings (const TQString &groupName=TQString::fromLatin1("MainWindow"), bool saveWindowSize=true)
void	resetAutoSaveSettings ()
bool	autoSaveSettings () const
TQString	autoSaveGroup () const
void	applyMainWindowSettings (TDEConfig *config, const TQString &groupName, bool force)
void	saveMainWindowSettings (TDEConfig *config, const TQString &groupName=TQString::null)
void	setStandardToolBarMenuEnabled (bool enable)
bool	isStandardToolBarMenuEnabled () const
void	createStandardStatusBarAction ()
void	setupGUI (int options=ToolBar|Keys|StatusBar|Save|Create, const TQString &xmlfile=TQString::null)
void	setupGUI (TQSize defaultSize, int options=ToolBar|Keys|StatusBar|Save|Create, const TQString &xmlfile=TQString::null)
TDEAction *	toolBarMenuAction ()
void	setupToolbarMenuActions ()
virtual void	finalizeGUI (KXMLGUIClient *client)
void	finalizeGUI (bool force)
bool	initialGeometrySet () const
void	ignoreInitialGeometry ()
TQSize	sizeForCentralWidgetSize (TQSize size) TDE_DEPRECATED
virtual void	setIcon (const TQPixmap &)
Public Member Functions inherited from KXMLGUIBuilder
virtual TQWidget *	createContainer (TQWidget *parent, int index, const TQDomElement &element, int &id)
virtual void	removeContainer (TQWidget *container, TQWidget *parent, TQDomElement &element, int id)
Public Member Functions inherited from KXMLGUIClient
	KXMLGUIClient (KXMLGUIClient *parent)
TDEAction *	action (const char *name) const
virtual TDEAction *	action (const TQDomElement &element) const
virtual TDEActionCollection *	actionCollection () const
virtual TDEInstance *	instance () const
virtual TQDomDocument	domDocument () const
virtual TQString	xmlFile () const
void	setXMLGUIBuildDocument (const TQDomDocument &doc)
TQDomDocument	xmlguiBuildDocument () const
void	setFactory (KXMLGUIFactory *factory)
KXMLGUIFactory *	factory () const
KXMLGUIClient *	parentClient () const
void	insertChildClient (KXMLGUIClient *child)
void	removeChildClient (KXMLGUIClient *child)
const TQPtrList< KXMLGUIClient > *	childClients ()
void	setClientBuilder (KXMLGUIBuilder *builder)
KXMLGUIBuilder *	clientBuilder () const
void	reloadXML ()
void	plugActionList (const TQString &name, const TQPtrList< TDEAction > &actionList)
void	unplugActionList (const TQString &name)
void	beginXMLPlug (TQWidget *)
void	endXMLPlug ()
void	prepareXMLUnplug (TQWidget *)
Public Member Functions inherited from KParts::PartBase
	PartBase ()
virtual	~PartBase ()
void	setPartObject (TQObject *object)
TQObject *	partObject () const

Protected Slots
void	createGUI (KParts::Part *part)
virtual void	slotSetStatusBarText (const TQString &)
void	saveNewToolbarConfig ()
Protected Slots inherited from TDEMainWindow
void	saveNewToolbarConfig ()
virtual void	showAboutApplication ()
void	saveAutoSaveSettings ()

Protected Member Functions
virtual void	createShellGUI (bool create=true)
Protected Member Functions inherited from TDEMainWindow
virtual void	closeEvent (TQCloseEvent *)
virtual bool	queryExit ()
virtual bool	queryClose ()
virtual void	saveProperties (TDEConfig *)
virtual void	readProperties (TDEConfig *)
virtual void	saveGlobalProperties (TDEConfig *sessionConfig)
virtual void	readGlobalProperties (TDEConfig *sessionConfig)
bool	settingsDirty () const
TQString	settingsGroup () const
void	saveWindowSize (TDEConfig *config) const
void	restoreWindowSize (TDEConfig *config)
void	parseGeometry (bool parsewidth)
Protected Member Functions inherited from KXMLGUIClient
virtual void	setXMLFile (const TQString &file, bool merge=false, bool setXMLDoc=true)
virtual void	setXML (const TQString &document, bool merge=false)
virtual void	setDOMDocument (const TQDomDocument &document, bool merge=false)
virtual void	conserveMemory ()
virtual void	stateChanged (const TQString &newstate, ReverseStateChange reverse=StateNoReverse)
Protected Member Functions inherited from KParts::PartBase
virtual void	setInstance (TDEInstance *instance)
virtual void	setInstance (TDEInstance *instance, bool loadPlugins)
void	loadPlugins (TQObject *parent, KXMLGUIClient *parentGUIClient, TDEInstance *instance)
void	setPluginLoadingMode (PluginLoadingMode loadingMode)

Additional Inherited Members
Public Types inherited from TDEMainWindow
enum	CreationFlags
enum	StandardWindowOptions
Public Slots inherited from TDEMainWindow
int	configureToolbars ()
virtual void	setCaption (const TQString &caption)
virtual void	setCaption (const TQString &caption, bool modified)
virtual void	setPlainCaption (const TQString &caption)
void	appHelpActivated (void)
virtual void	slotStateChanged (const TQString &newstate)
void	slotStateChanged (const TQString &newstate, KXMLGUIClient::ReverseStateChange)
void	setSettingsDirty ()
Static Public Member Functions inherited from TDEMainWindow
static bool	canBeRestored (int number)
static const TQString	classNameOfToplevel (int number)
static TQPtrList< TDEMainWindow > *	getMemberList ()
Public Attributes inherited from TDEMainWindow
	ToolBar
	Keys
	StatusBar
	Save
	Create
Static Public Attributes inherited from TDEMainWindow
static TQPtrList< TDEMainWindow > *	memberList
Protected Types inherited from KParts::PartBase
enum	PluginLoadingMode { DoNotLoadPlugins = 0 , LoadPlugins = 1 , LoadPluginsIfEnabled = 2 }

Detailed Description

A KPart-aware main window, whose user interface is described in XML.

Inherit your main 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 TDEMainWindow as host: the builder and servant interface (for menu merging).

Definition at line 47 of file mainwindow.h.

Constructor & Destructor Documentation

MainWindow() [1/3]

MainWindow::MainWindow	(	TQWidget *	parent,
		const char *	name = 0L,
		WFlags	f = (WFlags)(WType_TopLevel | WDestructiveClose)
	)

Constructor, same signature as TDEMainWindow.

Definition at line 60 of file mainwindow.cpp.

MainWindow() [2/3]

MainWindow::MainWindow	(	const char *	name = 0L,
		WFlags	f = (WFlags)WDestructiveClose
	)

Compatibility Constructor.

Definition at line 67 of file mainwindow.cpp.

MainWindow() [3/3]

MainWindow::MainWindow	(	int	cflags,
		TQWidget *	parent,
		const char *	name = 0L,
		WFlags	f = (WFlags)(WType_TopLevel | WDestructiveClose)
	)

Constructor with creation flags, see TDEMainWindow.

Since

3.2

Definition at line 74 of file mainwindow.cpp.

~MainWindow()

MainWindow::~MainWindow ( )

virtual

Destructor.

Definition at line 81 of file mainwindow.cpp.

Member Function Documentation

createGUI

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

protectedslot

Create the GUI (by merging the host's and the active part's) You must call this in order to see any GUI being created.

In a main window with multiple parts being shown (e.g. as in Konqueror) 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 86 of file mainwindow.cpp.

saveNewToolbarConfig

void KParts::MainWindow::saveNewToolbarConfig ( )

protectedslot

Rebuilds the GUI after KEditToolbar changed the toolbar layout.

See also

configureToolbars() KDE4: make this virtual. (For now we rely on the fact that it's called as a slot, so the metaobject finds it here).

Definition at line 185 of file mainwindow.cpp.

slotSetStatusBarText

void MainWindow::slotSetStatusBarText ( const TQString &  text )

protectedvirtualslot

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

Definition at line 145 of file mainwindow.cpp.

---

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

• mainwindow.h
• mainwindow.cpp