KDEUI

KMainWindow Class Reference

#include <kmainwindow.h>

Inheritance diagram for KMainWindow:

[legend]

List of all members.

Detailed Description

KDE top level main window

Top level widget that provides toolbars, a status line and a frame.

It should be used as a top level (parent-less) widget. It manages the geometry for all its children, including your main widget.

Normally, you will inherit from KMainWindow, then construct (or use some existing) widget as your main view. You can set only one main view.

You can add as many toolbars as you like. There can be only one menubar and only one statusbar.

The toolbars, menubar, and statusbar can be created by the KMainWindow and - unlike the old KMainWindow - may, but do not have to, be deleted by you. KMainWindow will handle that internally.

Height and width can be operated independently from each other. Simply define the minimum/maximum height/width of your main widget and KMainWindow will take this into account. For fixed size windows set your main widget to a fixed size.

Fixed aspect ratios (heightForWidth()) and fixed width widgets are not supported.

KMainWindow will set icon, mini icon and caption, which it gets from KApplication. It provides full session management, and will save its position, geometry and positions of toolbars and menubar on logout. If you want to save additional data, reimplement saveProperties() and (to read them again on next login) readProperties(). To save special data about your data, reimplement saveGlobalProperties(). To warn user that application or windows have unsaved data on close or logout, reimplement queryClose() and/or queryExit().

There are also kRestoreMainWindows convenience functions which can restore all your windows on next login.

Note that a KMainWindow per-default is created with the WDestructiveClose flag, i.e. it is automatically destroyed when the window is closed. If you do not want this behavior, specify 0 as widget flag in the constructor.

See also:: KApplication

Author:: Reginald Stadlbauer (reggie@kde.org) Stephan Kulow (coolo@kde.org), Matthias Ettrich (ettrich@kde.org), Chris Schlaeger (cs@kde.org), Sven Radej (radej@kde.org). Maintained by Sven Radej (radej@kde.org)

Definition at line 105 of file kmainwindow.h.


Public Slots
virtual void	setCaption (const QString &caption)
virtual void	setCaption (const QString &caption, bool modified)
virtual void	setPlainCaption (const QString &caption)
void	appHelpActivated (void)
void	setSettingsDirty ()
Public Member Functions
	KMainWindow (QWidget *parent=0, Qt::WindowFlags f=KDE_DEFAULT_WINDOWFLAGS)
virtual	~KMainWindow ()
KMenu *	helpMenu (const QString &aboutAppText=QString(), bool showWhatsThis=true)
KMenu *	customHelpMenu (bool showWhatsThis=true)
bool	restore (int number, bool show=true)
bool	hasMenuBar ()
KMenuBar *	menuBar ()
KStatusBar *	statusBar ()
KToolBar *	toolBar (const QString &name=QString())
QList< KToolBar * >	toolBars () const
void	setAutoSaveSettings (const QString &groupName=QLatin1String("MainWindow"), bool saveWindowSize=true)
void	resetAutoSaveSettings ()
bool	autoSaveSettings () const
QString	autoSaveGroup () const
virtual void	applyMainWindowSettings (const KConfigGroup &config, bool force=false)
void	saveMainWindowSettings (const KConfigGroup &config)
bool	initialGeometrySet () const
void	ignoreInitialGeometry ()
QString	dbusName () const
Static Public Member Functions
static bool	canBeRestored (int number)
static const QString	classNameOfToplevel (int number)
static QList< KMainWindow * >	memberList ()
Protected Slots
virtual void	showAboutApplication ()
void	saveAutoSaveSettings ()
Protected Member Functions
virtual bool	event (QEvent *event)
virtual void	closeEvent (QCloseEvent *)
virtual bool	queryExit ()
virtual bool	queryClose ()
virtual void	saveProperties (KConfigGroup &)
virtual void	readProperties (const KConfigGroup &)
virtual void	saveGlobalProperties (KConfig *sessionConfig)
virtual void	readGlobalProperties (KConfig *sessionConfig)
void	savePropertiesInternal (KConfig *, int)
bool	readPropertiesInternal (KConfig *, int)
bool	settingsDirty () const
void	saveWindowSize (const KConfigGroup &config) const
void	restoreWindowSize (const KConfigGroup &config)
void	parseGeometry (bool parsewidth)
	KMainWindow (KMainWindowPrivate &dd, QWidget *parent, Qt::WFlags f)
Protected Attributes
KMainWindowPrivate *const	k_ptr
Properties
bool	hasMenuBar
bool	autoSaveSettings
QString	autoSaveGroup
bool	initialGeometrySet
Friends
class	KMWSessionManager

Constructor & Destructor Documentation

KMainWindow::KMainWindow	(	QWidget *	parent = `0`,
		Qt::WindowFlags	f = `KDE_DEFAULT_WINDOWFLAGS`
	)			`[explicit]`

Construct a main window.

Parameters:

	parent	The widget parent. This is usually 0 but it may also be the window group leader. In that case, the KMainWindow becomes sort of a secondary window.
	f	Specify the widget flags. The default is WType_TopLevel and WDestructiveClose. TopLevel indicates that a main window is a toplevel window, regardless of whether it has a parent or not. DestructiveClose indicates that a main window is automatically destroyed when its window is closed. Pass 0 if you do not want this behavior.

See also:: http://doc.trolltech.com/3.2/qt.html#WidgetFlags-enum

KMainWindows must be created on the heap with 'new', like:

 KMainWindow *kmw = new KMainWindow(...);
 kmw->setObjectName(...);

IMPORTANT: For session management and window management to work properly, all main windows in the application should have a different name. If you don't do it, KMainWindow will create a unique name, but it's recommended to explicitly pass a window name that will also describe the type of the window. If there can be several windows of the same type, append '#' (hash) to the name, and KMainWindow will replace it with numbers to make the names unique. For example, for a mail client which has one main window showing the mails and folders, and which can also have one or more windows for composing mails, the name for the folders window should be e.g. "mainwindow" and for the composer windows "composer#".

KMainWindow::~KMainWindow ( ) [virtual]

Destructor.

Will also destroy the toolbars, and menubar if needed.

Definition at line 395 of file kmainwindow.cpp.

KMainWindow::KMainWindow	(	KMainWindowPrivate &	dd,
		QWidget *	parent,
		Qt::WFlags	f
	)			`[protected]`

Definition at line 212 of file kmainwindow.cpp.

Member Function Documentation

KMenu * KMainWindow::helpMenu	(	const QString &	aboutAppText = `QString()`,
		bool	showWhatsThis = `true`
	)

Retrieve the standard help menu.

It contains entires for the help system (activated by F1), an optional "What's This?" entry (activated by Shift F1), an application specific dialog box, and an "About KDE" dialog box.

Example (adding a standard help menu to your application):

 KMenu *help = helpMenu( <myTextString> );
 menuBar()->insertItem( i18n("&Help"), help );

Parameters:

	aboutAppText	The string that is used in the application specific dialog box. If you leave this string empty the information in the global KAboutData of the application will be used to make a standard dialog box.
	showWhatsThis	Set this to false if you do not want to include the "What's This" menu entry.

Returns:: A standard help menu.

Definition at line 401 of file kmainwindow.cpp.

KMenu * KMainWindow::customHelpMenu ( bool showWhatsThis = true )

Returns the help menu.

Creates a standard help menu if none exists yet.

It contains entries for the help system (activated by F1), an optional "What's This?" entry (activated by Shift F1), an application specific dialog box, and an "About KDE" dialog box. You must create the application specific dialog box yourself. When the "About application" menu entry is activated, a signal will trigger the showAboutApplication slot. See showAboutApplication for more information.

Example (adding a help menu to your application):

 menuBar()->insertItem( i18n("&Help"), customHelpMenu() );

Parameters:

showWhatsThis Set this to false if you do not want to include the "What's This" menu entry.

Returns:: A standard help menu.

Definition at line 417 of file kmainwindow.cpp.

bool KMainWindow::canBeRestored ( int number ) [static]

Session Management

Try to restore the toplevel widget as defined by the number (1..X).

If the session did not contain so high a number, the configuration is not changed and false returned.

That means clients could simply do the following:

 if (qApp->isSessionRestored()){
   int n = 1;
   while (KMainWindow::canBeRestored(n)){
     (new childMW)->restore(n);
     n++;
   }
 } else {
   // create default application as usual
 }

Note that QWidget::show() is called implicitly in restore.

With this you can easily restore all toplevel windows of your application.

If your application uses different kinds of toplevel windows, then you can use KMainWindow::classNameOfToplevel(n) to determine the exact type before calling the childMW constructor in the example from above.

If your client has only one kind of toplevel widgets (which should be pretty usual) then you should use the RESTORE-macro for backwards compatibility with 3.1 and 3.0 branches:

 if (qApp->isSessionRestored())
   RESTORE(childMW)
 else {
   // create default application as usual
 }

The macro expands to the term above but is easier to use and less code to write.

For new code or if you have more than one kind of toplevel widget (each derived from KMainWindow, of course), you can use the templated kRestoreMainWindows global functions:

 if (qApp->isSessionRestored())
   kRestoreMainWindows< childMW1, childMW2, childMW3 >();
 else {
   // create default application as usual
 }

Currently, these functions are provided for up to three template arguments. If you need more, tell us. To help you in deciding whether or not you can use kRestoreMainWindows, a define KDE_RESTORE_MAIN_WINDOWS_NUM_TEMPLATE_ARGS is provided.

See also:: restore()
classNameOfToplevel()

Definition at line 429 of file kmainwindow.cpp.

const QString KMainWindow::classNameOfToplevel ( int number ) [static]

Returns the className() of the number of the toplevel window which should be restored.

This is only useful if your application uses different kinds of toplevel windows.

Definition at line 442 of file kmainwindow.cpp.

bool KMainWindow::restore	(	int	number,
		bool	show = `true`
	)

Restore the session specified by number.

Returns false if this fails, otherwise returns true and shows the window. You should call canBeRestored() first. If show is true (default), this widget will be shown automatically.

Definition at line 460 of file kmainwindow.cpp.

bool KMainWindow::hasMenuBar ( )

Returns true, if there is a menubar.

KMenuBar * KMainWindow::menuBar ( )

Returns a pointer to the menu bar.

If there is no menu bar yet one will be created.

Reimplemented from QMainWindow.

Definition at line 968 of file kmainwindow.cpp.

KStatusBar * KMainWindow::statusBar ( )

Returns a pointer to the status bar.

If there is no status bar yet, one will be created.

Note that tooltips for kactions in actionCollection() are not automatically connected to this statusBar. See the KActionCollection documentation for more details.

See also:: KActionCollection

Reimplemented from QMainWindow.

Definition at line 980 of file kmainwindow.cpp.

QList< KMainWindow * > KMainWindow::memberList ( ) [static]

List of members of KMainWindow class.

Definition at line 1036 of file kmainwindow.cpp.

KToolBar * KMainWindow::toolBar ( const QString & name = QString() )

Returns a pointer to the toolbar with the specified name.

This refers to toolbars created dynamically from the XML UI framework. If the toolbar does not exist one will be created.

Parameters:

name

The internal name of the toolbar. If no name is specified "mainToolBar" is assumed.

Returns:: A pointer to the toolbar

Definition at line 1006 of file kmainwindow.cpp.

QList< KToolBar * > KMainWindow::toolBars ( ) const

Returns:: A list of all toolbars for this window

Definition at line 1025 of file kmainwindow.cpp.

void KMainWindow::setAutoSaveSettings	(	const QString &	groupName = `QLatin1String("MainWindow")`,
		bool	saveWindowSize = `true`
	)

Call this to enable "auto-save" of toolbar/menubar/statusbar settings (and optionally window size).

If the *bars were moved around/shown/hidden when the window is closed, saveMainWindowSettings( KConfigGroup(KGlobal::config(), groupName) ) will be called.

Parameters:

	groupName	a name that identifies this "type of window". You can have several types of window in the same application.
	saveWindowSize	set it to true to include the window size when saving.

Typically, you will call setAutoSaveSettings() in your KMainWindow-inherited class constructor, and it will take care of restoring and saving automatically. Make sure you call this _after all_ your *bars have been created.

To make sure that KMainWindow propertly obtains the default size of the window you should do the following:

Remove hard coded resize() calls in the constructor or main, they should be removed in favor of letting the automatic resizing determine the default window size. Hard coded window sizes will be wrong for users that have big fonts, use different styles, long/small translations, large toolbars, and other factors.
Put the setAutoSaveSettings ( or setupGUI() ) call after all widgets have been created and placed inside the main window (i.e. for 99% of apps setCentralWidget())
Widgets that inherit from QWidget (like game boards) should overload "virtual QSize sizeHint() const;" to specify a default size rather than letting QWidget::adjust use the default size of 0x0.

Definition at line 868 of file kmainwindow.cpp.

void KMainWindow::resetAutoSaveSettings ( )

Disable the auto-save-settings feature.

You don't normally need to call this, ever.

Definition at line 880 of file kmainwindow.cpp.

bool KMainWindow::autoSaveSettings ( ) const

Returns:: the current autosave setting, i.e.

true if setAutoSaveSettings() was called, false by default or if resetAutoSaveSettings() was called.

QString KMainWindow::autoSaveGroup ( ) const

Returns:: the group used for setting-autosaving.

Only meaningful if setAutoSaveSettings() was called. This can be useful for forcing a save or an apply, e.g. before and after using KEditToolbar.

void KMainWindow::applyMainWindowSettings	(	const KConfigGroup &	config,
		bool	force = `false`
	)			`[virtual]`

Read settings for statusbar, menubar and toolbar from their respective groups in the config file and apply them.

Parameters:

	config	Config group to read the settings from.
	force	if set, even default settings are re-applied

Reimplemented in KXmlGuiWindow.

Definition at line 663 of file kmainwindow.cpp.

void KMainWindow::saveMainWindowSettings ( const KConfigGroup & config )

Save settings for statusbar, menubar and toolbar to their respective groups in the config group config.

Parameters:

config

Config group to save the settings to.

Definition at line 583 of file kmainwindow.cpp.

bool KMainWindow::initialGeometrySet ( ) const

Returns:: true if a -geometry argument was given on the command line, and this is the first window created (the one on which this option applies)

void KMainWindow::ignoreInitialGeometry ( )

For internal use only.

Used from Konqueror when reusing the main window.

Definition at line 836 of file kmainwindow.cpp.

QString KMainWindow::dbusName ( ) const

Returns the path under which this window's D-Bus object is exported.

Since:: 4.0.1

Definition at line 1038 of file kmainwindow.cpp.

void KMainWindow::setCaption ( const QString & caption ) [virtual, slot]

Makes a KDE compliant caption.

Parameters:

caption

Your caption. Do not include the application name in this string. It will be added automatically according to the KDE standard.

Definition at line 473 of file kmainwindow.cpp.

void KMainWindow::setCaption	(	const QString &	caption,
		bool	modified
	)			`[virtual, slot]`

Makes a KDE compliant caption.

Parameters:

	caption	Your caption. Do not include the application name in this string. It will be added automatically according to the KDE standard.
	modified	Specify whether the document is modified. This displays an additional sign in the title bar, usually "**".

Definition at line 478 of file kmainwindow.cpp.

void KMainWindow::setPlainCaption ( const QString & caption ) [virtual, slot]

Make a plain caption without any modifications.

Parameters:

caption

Your caption. This is the string that will be displayed in the window title.

Definition at line 490 of file kmainwindow.cpp.

void KMainWindow::appHelpActivated ( void ) [slot]

Open the help page for the application.

The application name is used as a key to determine what to display and the system will attempt to open <appName>/index.html.

This method is intended for use by a help button in the toolbar or components outside the regular help menu. Use helpMenu() when you want to provide access to the help system from the help menu.

Example (adding a help button to the first toolbar):

 toolBar(0)->addAction(KIcon("help-contents"), i18n("Help"),
                       this, SLOT(appHelpActivated()));

Definition at line 495 of file kmainwindow.cpp.

void KMainWindow::setSettingsDirty ( ) [slot]

Tell the main window that it should save its settings when being closed.

This is part of the auto-save-settings feature. For everything related to toolbars this happens automatically, but you have to call setSettingsDirty() in the slot that toggles the visibility of the statusbar.

Definition at line 842 of file kmainwindow.cpp.

bool KMainWindow::event ( QEvent * event ) [protected, virtual]

Reimplemented to catch QEvent::Polish in order to adjust the object name if needed, once all constructor code for the main window has run.

Also reimplemented to catch when a QDockWidget is added or removed.

Reimplemented in KXmlGuiWindow.

Definition at line 913 of file kmainwindow.cpp.

void KMainWindow::closeEvent ( QCloseEvent * e ) [protected, virtual]

Reimplemented to call the queryClose() and queryExit() handlers.

We recommend that you reimplement the handlers rather than closeEvent(). If you do it anyway, ensure to call the base implementation to keep queryExit() running.

Definition at line 506 of file kmainwindow.cpp.

bool KMainWindow::queryExit ( ) [protected, virtual]

Called before the very last window is closed, either by the user or indirectly by the session manager.

It is not recommended to do any user interaction in this function other than indicating severe errors. Better ask the user on queryClose() (see below).

A typical usage of queryExit() is to write configuration data back. Note that the application may continue to run after queryExit() (the user may have canceled a shutdown), so you should not do any cleanups here. The purpose of queryExit() is purely to prepare the application (with possible user interaction) so it can safely be closed later (without user interaction).

If you need to do serious things on exit (like shutting a dial-up connection down), connect to the signal QCoreApplication::aboutToQuit().

Default implementation returns true. Returning false will cancel the exiting. In the latter case, the last window will remain visible. If KApplication::sessionSaving() is true, refusing the exit will also cancel KDE logout.

See also:: queryClose()
KApplication::sessionSaving()

Definition at line 536 of file kmainwindow.cpp.

bool KMainWindow::queryClose ( ) [protected, virtual]

Called before the window is closed, either by the user or indirectly by the session manager.

The purpose of this function is to prepare the window in a way that it is safe to close it, i.e. without the user losing some data.

Default implementation returns true. Returning false will cancel the closing, and, if KApplication::sessionSaving() is true, it will also cancel KDE logout.

Reimplement this function to prevent the user from losing data. Example:

       switch ( KMessageBox::warningYesNoCancel( this,
                i18n("Save changes to document foo?")) ) {
       case KMessageBox::Yes :
         // save document here. If saving fails, return false;
         return true;
       case KMessageBox::No :
         return true;
       default: // cancel
         return false;

Note that you should probably not actually close the document from within this method, as it may be called by the session manager before the session is saved. If the document is closed before the session save occurs, its location might not be properly saved. In addition, the session shutdown may be canceled, in which case the document should remain open.

See also:: queryExit()
KApplication::sessionSaving()

Definition at line 541 of file kmainwindow.cpp.

virtual void KMainWindow::saveProperties ( KConfigGroup & ) [inline, protected, virtual]

Save your instance-specific properties.

The function is invoked when the session manager requests your application to save its state.

Please reimplement these function in childclasses.

Note: No user interaction is allowed in this function!

Definition at line 597 of file kmainwindow.h.

virtual void KMainWindow::readProperties ( const KConfigGroup & ) [inline, protected, virtual]

Read your instance-specific properties.

Definition at line 602 of file kmainwindow.h.

void KMainWindow::saveGlobalProperties ( KConfig * sessionConfig ) [protected, virtual]

Save your application-wide properties.

The function is invoked when the session manager requests your application to save its state.

This function is similar to saveProperties() but is only called for the very first main window, regardless how many main window are open.

Override it if you need to save other data about your documents on session end. sessionConfig is a config to which that data should be saved. Normally, you don't need this function. But if you want to save data about your documents that are not in opened windows you might need it.

Default implementation does nothing.

Definition at line 546 of file kmainwindow.cpp.

void KMainWindow::readGlobalProperties ( KConfig * sessionConfig ) [protected, virtual]

The counterpart of saveGlobalProperties().

Read the application-specific properties in again.

Definition at line 550 of file kmainwindow.cpp.

void KMainWindow::savePropertiesInternal	(	KConfig *	config,
		int	number
	)			`[protected]`

Definition at line 558 of file kmainwindow.cpp.

bool KMainWindow::readPropertiesInternal	(	KConfig *	config,
		int	number
	)			`[protected]`

Definition at line 639 of file kmainwindow.cpp.

bool KMainWindow::settingsDirty ( ) const [protected]

For inherited classes.

Definition at line 862 of file kmainwindow.cpp.

void KMainWindow::saveWindowSize ( const KConfigGroup & config ) const [protected]

For inherited classes.

Definition at line 735 of file kmainwindow.cpp.

void KMainWindow::restoreWindowSize ( const KConfigGroup & config ) [protected]

For inherited classes Note that a -geometry on the command line has priority.

Definition at line 777 of file kmainwindow.cpp.

void KMainWindow::parseGeometry ( bool parsewidth ) [protected]

parse the geometry from the geometry command line argument

Definition at line 353 of file kmainwindow.cpp.

void KMainWindow::showAboutApplication ( ) [protected, virtual, slot]

This slot does nothing.

It must be reimplemented if you want to use a custom About Application dialog box. This slot is connected to the About Application entry in the menu returned by customHelpMenu.

Example:

 void MyMainLevel::setupInterface()
 {
   ..
   menuBar()->insertItem( i18n("&Help"), customHelpMenu() );
   ..
 }

 void MyMainLevel::showAboutApplication()
 {
   <activate your custom dialog>
 }

Definition at line 554 of file kmainwindow.cpp.

void KMainWindow::saveAutoSaveSettings ( ) [protected, slot]

This slot should only be called in case you reimplement closeEvent() and if you are using the "auto-save" feature.

In all other cases, setSettingsDirty() should be called instead to benefit from the delayed saving.

See also:: setAutoSaveSettings
setSettingsDirty

Example:

 void MyMainWindow::closeEvent( QCloseEvent *e )
 {
   // Save settings if auto-save is enabled, and settings have changed
   if ( settingsDirty() && autoSaveSettings() )
     saveAutoSaveSettings();
   ..
 }

Definition at line 900 of file kmainwindow.cpp.

Friends And Related Function Documentation

friend class KMWSessionManager [friend]

Definition at line 107 of file kmainwindow.h.

Member Data Documentation

KMainWindowPrivate* const KMainWindow::k_ptr [protected]

Definition at line 701 of file kmainwindow.h.

Property Documentation

bool KMainWindow::hasMenuBar [read]

Reimplemented in KXmlGuiWindow.

Definition at line 110 of file kmainwindow.h.

bool KMainWindow::autoSaveSettings [read]

Reimplemented in KXmlGuiWindow.

Definition at line 111 of file kmainwindow.h.

QString KMainWindow::autoSaveGroup [read]

Reimplemented in KXmlGuiWindow.

Definition at line 112 of file kmainwindow.h.

bool KMainWindow::initialGeometrySet [read]

Reimplemented in KXmlGuiWindow.

Definition at line 113 of file kmainwindow.h.

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

KDEUI

KMainWindow Class Reference

Detailed Description

Public Slots

Public Member Functions

Static Public Member Functions

Protected Slots

Protected Member Functions

Protected Attributes

Properties

Friends

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

Property Documentation

KDEUI

kdelibs