KMainWindow Class Reference

#include <kmainwindow.h>

Inheritance diagram for KMainWindow:

Public Slots
void	appHelpActivated (void)
virtual void	setCaption (const QString &caption)
virtual void	setCaption (const QString &caption, bool modified)
virtual void	setPlainCaption (const QString &caption)
void	setSettingsDirty ()

Public Member Functions
	KMainWindow (QWidget *parent=0, Qt::WindowFlags f=KDE_DEFAULT_WINDOWFLAGS)
virtual	~KMainWindow ()
virtual void	applyMainWindowSettings (const KConfigGroup &config, bool forceGlobal=false)
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

Static Public Member Functions
static bool	canBeRestored (int number)
static const QString	classNameOfToplevel (int number)
static QList< KMainWindow * >	memberList ()

Protected Slots
void	saveAutoSaveSettings ()
virtual void	showAboutApplication ()

Protected Member Functions
	KMainWindow (KMainWindowPrivate &dd, QWidget *parent, Qt::WindowFlags f)
virtual void	closeEvent (QCloseEvent *)
virtual bool	event (QEvent *event)
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
bool	settingsDirty () const

Protected Attributes
KMainWindowPrivate *const	k_ptr

Properties
QString	autoSaveGroup
bool	autoSaveSettings
bool	hasMenuBar
bool	initialGeometrySet

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().

You have to implement session restoring also in your main() function. There are also kRestoreMainWindows convenience functions which can do this for you and restore all your windows on next login.

Note that KMainWindow uses KGlobal::ref() and KGlobal::deref() so that closing the last mainwindow will quit the application unless there is still something that holds a ref in KGlobal - like a KIO job, or a systray icon.

See also

KApplication

Author

Reginald Stadlbauer (reggi.nosp@m.e@kd.nosp@m.e.org) Stephan Kulow (coolo.nosp@m.@kde.nosp@m..org), Matthias Ettrich (ettri.nosp@m.ch@k.nosp@m.de.or.nosp@m.g), Chris Schlaeger (cs@kd.nosp@m.e.or.nosp@m.g), Sven Radej (radej.nosp@m.@kde.nosp@m..org). Maintained by David Faure (faure.nosp@m.@kde.nosp@m..org)

Definition at line 106 of file kmainwindow.h.

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 window flags. The default is none.

Note that a KMainWindow per-default is created with the WA_DeleteOnClose attribute, i.e. it is automatically destroyed when the window is closed. If you do not want this behavior, call setAttribute(Qt::WA_DeleteOnClose, false);

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#".

Definition at line 217 of file kmainwindow.cpp.

KMainWindow::~KMainWindow ( )

virtual

Destructor.

Will also destroy the toolbars, and menubar if needed.

Definition at line 467 of file kmainwindow.cpp.

KMainWindow::KMainWindow ( KMainWindowPrivate &  dd, QWidget *  parent, Qt::WindowFlags  f  )

protected

Definition at line 223 of file kmainwindow.cpp.

Member Function Documentation

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 569 of file kmainwindow.cpp.

void KMainWindow::applyMainWindowSettings ( const KConfigGroup &  config, bool  forceGlobal = 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.
forceGlobal	see the same argument in KToolBar::applySettings

Reimplemented in KXmlGuiWindow.

Definition at line 746 of file kmainwindow.cpp.

KConfigGroup KMainWindow::autoSaveConfigGroup

(

)

const

Returns

the group used for setting-autosaving. Only meaningful if setAutoSaveSettings() was called. This can be useful for forcing an apply, e.g. after using KEditToolbar.

Since

4.1

Definition at line 1003 of file kmainwindow.cpp.

QString KMainWindow::autoSaveGroup

(

)

const

Returns

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

NOTE: you should rather use saveAutoSaveSettings() for saving or autoSaveConfigGroup() for loading. This method doesn't make sense if setAutoSaveSettings(KConfigGroup) was called.

bool KMainWindow::autoSaveSettings

(

)

const

Returns

the current autosave setting, i.e. true if setAutoSaveSettings() was called, false by default or if resetAutoSaveSettings() was called.

bool KMainWindow::canBeRestored ( int  number )

static

If the session did contain so high a number, true is returned, else false.

See also

restore()

Definition at line 503 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 516 of file kmainwindow.cpp.

void KMainWindow::closeEvent ( QCloseEvent *  e )

protectedvirtual

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 580 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()->addMenu( 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 491 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 1178 of file kmainwindow.cpp.

bool KMainWindow::event ( QEvent *  event )

protectedvirtual

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 1019 of file kmainwindow.cpp.

bool KMainWindow::hasMenuBar

(

)

Returns true, if there is a menubar.

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

Retrieve the standard help menu.

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.

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

KMenu *help = helpMenu( <myTextString> );
menuBar()->addMenu( 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 475 of file kmainwindow.cpp.

void KMainWindow::ignoreInitialGeometry

(

)

Used from Konqueror when reusing the main window.

Definition at line 943 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)

QList< KMainWindow * > KMainWindow::memberList ( )

static

List of members of KMainWindow class.

Definition at line 1176 of file kmainwindow.cpp.

KMenuBar * KMainWindow::menuBar

(

)

Returns a pointer to the menu bar.

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

Definition at line 1092 of file kmainwindow.cpp.

void KMainWindow::parseGeometry ( bool  parsewidth )

protected

parse the geometry from the geometry command line argument

Definition at line 424 of file kmainwindow.cpp.

bool KMainWindow::queryClose ( )

protectedvirtual

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 617 of file kmainwindow.cpp.

bool KMainWindow::queryExit ( )

protectedvirtual

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 @p true. Returning @p 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 queryClose()
  @see KApplication::sessionSaving()

Definition at line 612 of file kmainwindow.cpp.

void KMainWindow::readGlobalProperties ( KConfig *  sessionConfig )

protectedvirtual

The counterpart of saveGlobalProperties().

Read the application-specific properties in again.

Definition at line 626 of file kmainwindow.cpp.

virtual void KMainWindow::readProperties ( const KConfigGroup &  )

inlineprotectedvirtual

Read your instance-specific properties.

Is called indirectly by restore().

Definition at line 592 of file kmainwindow.h.

bool KMainWindow::readPropertiesInternal ( KConfig *  config, int  number  )

protected

Definition at line 712 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 982 of file kmainwindow.cpp.

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

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

You should call canBeRestored() first.

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 if show is true (default), 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.

Note that you don't need to deal with this function. Use the kRestoreMainWindows() convenience template function instead!

See also

kRestoreMainWindows()

RESTORE

readProperties()

canBeRestored()

Definition at line 534 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 831 of file kmainwindow.cpp.

void KMainWindow::saveAutoSaveSettings ( )

protectedslot

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 1009 of file kmainwindow.cpp.

void KMainWindow::saveGlobalProperties ( KConfig *  sessionConfig )

protectedvirtual

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 622 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 659 of file kmainwindow.cpp.

virtual void KMainWindow::saveProperties ( KConfigGroup &  )

inlineprotectedvirtual

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 585 of file kmainwindow.h.

void KMainWindow::savePropertiesInternal ( KConfig *  config, int  number  )

protected

Definition at line 634 of file kmainwindow.cpp.

void KMainWindow::saveWindowSize ( const KConfigGroup &  config ) const

protected

For inherited classes.

Definition at line 845 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 961 of file kmainwindow.cpp.

void KMainWindow::setAutoSaveSettings	(	const KConfigGroup &	group,
		bool	saveWindowSize = true
	)

Overload that lets you specify a KConfigGroup.

This allows the settings to be saved into another file than KGlobal::config().

Since

4.1

Definition at line 966 of file kmainwindow.cpp.

void KMainWindow::setCaption ( const QString &  caption )

virtualslot

Makes a KDE compliant caption (window title).

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 547 of file kmainwindow.cpp.

void KMainWindow::setCaption ( const QString &  caption, bool  modified  )

virtualslot

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 552 of file kmainwindow.cpp.

void KMainWindow::setPlainCaption ( const QString &  caption )

virtualslot

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 564 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 949 of file kmainwindow.cpp.

bool KMainWindow::settingsDirty ( ) const

protected

For inherited classes.

Definition at line 955 of file kmainwindow.cpp.

void KMainWindow::showAboutApplication ( )

protectedvirtualslot

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()->addMenu( customHelpMenu() );
  ..
}

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

Definition at line 630 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

Definition at line 1104 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 1151 of file kmainwindow.cpp.

QList< KToolBar * > KMainWindow::toolBars

(

)

const

Returns

A list of all toolbars for this window

Definition at line 1165 of file kmainwindow.cpp.

Member Data Documentation

KMainWindowPrivate* const KMainWindow::k_ptr

protected

Definition at line 691 of file kmainwindow.h.

Property Documentation

QString KMainWindow::autoSaveGroup

read

Definition at line 114 of file kmainwindow.h.

bool KMainWindow::autoSaveSettings

read

Definition at line 113 of file kmainwindow.h.

bool KMainWindow::hasMenuBar

read

Definition at line 112 of file kmainwindow.h.

bool KMainWindow::initialGeometrySet

read

Definition at line 115 of file kmainwindow.h.

---

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

• kmainwindow.h
• kmainwindow.cpp