# kdeui Library API Documentation

Overview | Class Hierarchy | Classes | Classes (annotated) | Members | Source Files

# KMainWindow Class Reference

Top level widget that provides toolbars, a status line and a frame. KDE top level main window. More...

`#include <kmainwindow.h>`

Inheritance diagram for KMainWindow:

[legend]
Collaboration diagram for KMainWindow:

[legend]
List of all members.

## Public Slots

virtual void | setCaption (const QString &caption)
| Makes a KDE compliant caption.
virtual void | setCaption (const QString &caption, bool modified)
| Makes a KDE compliant caption.
virtual void | setPlainCaption (const QString &caption)
| Make a plain caption without any modifications.
void | appHelpActivated (void)
| Open the help page for the application.
virtual void | slotStateChanged (const QString &newstate)
| Apply a state change.
void | slotStateChanged (const QString &newstate, KXMLGUIClient::ReverseStateChange)
| Apply a state change.
void | setSettingsDirty ()

## Public Member Functions

| KMainWindow (QWidget *parent=0, const char *name=0, WFlags f=WType_TopLevel|WDestructiveClose)
| Construct a main window.
virtual | ~KMainWindow ()
| Destructor.
KPopupMenu * | helpMenu (const QString &aboutAppText=QString::null, bool showWhatsThis=TRUE)
| Retrieve the standard help menu.
KPopupMenu * | customHelpMenu (bool showWhatsThis=TRUE)
| Returns the help menu.
bool | restore (int number, bool show=TRUE)
| Restore the session specified by `number`.
virtual KXMLGUIFactory * | guiFactory ()
void | createGUI (const QString &xmlfile=QString::null, bool _conserveMemory=TRUE)
| Create a GUI given a local XML file.
void | setHelpMenuEnabled (bool showHelpMenu=true)
| Enables the build of a standard help menu when calling createGUI().
bool | isHelpMenuEnabled ()
| Return `true` when the help menu is enabled.
bool | hasMenuBar ()

Returns true, if there is a menubar

Since:
  3.1.

KMenuBar * | menuBar ()
| Returns a pointer to the menu bar.
KStatusBar * | statusBar ()
| Returns a pointer to the status bar.
KToolBar * | toolBar (const char *name=0)
| Returns a pointer to the toolbar with the specified name.
QPtrListIterator< KToolBar > | toolBarIterator ()
KAccel * | accel ()
void | setFrameBorderWidth (int)
void | setAutoSaveSettings (const QString &groupName=QString::fromLatin1("MainWindow"), bool saveWindowSize=true)
| Call this to enable "auto-save" of toolbar/menubar/statusbar settings (and optionally window size).
void | resetAutoSaveSettings ()
| Disable the auto-save-settings feature.
bool | autoSaveSettings () const
QString | autoSaveGroup () const
void | applyMainWindowSettings (KConfig *config, const QString &groupName=QString::null)
| Read settings for statusbar, menubar and toolbar from their respective groups in the config file and apply them.
void | saveMainWindowSettings (KConfig *config, const QString &groupName=QString::null)
| Save settings for statusbar, menubar and toolbar to their respective groups in the config file `config`.
void | setStandardToolBarMenuEnabled (bool enable)
| Sets whether KMainWindow should provide a menu that allows showing/hiding the available toolbars ( using KToggleToolBarAction ) .
bool | isStandardToolBarMenuEnabled () const

Since:
  3.1

KAction * | toolBarMenuAction ()

Returns a pointer to the mainwindows action responsible for the toolbars menu

Since:
  3.1.

virtual void | finalizeGUI (KXMLGUIClient *client)

Since:
  3.1

void | finalizeGUI (bool force)
bool | initialGeometrySet () const
QSize | sizeForCentralWidgetSize (QSize size)

## Static Public Member Functions

bool | canBeRestored (int number)
const QString | classNameOfToplevel (int number)
| Returns the className() of the `number` of the toplevel window which should be restored.

## Static Public Attributes

QPtrList< KMainWindow > * | memberList = 0L
| List of members of KMainWindow class.

## Protected Slots

virtual void | showAboutApplication ()
| This slot does nothing.

## Protected Member Functions

void | paintEvent (QPaintEvent *e)
void | childEvent (QChildEvent *e)
void | resizeEvent (QResizeEvent *e)
virtual void | closeEvent (QCloseEvent *)
| Reimplemented to call the queryClose() and queryExit() handlers.
virtual bool | queryExit ()
| Called before the very last window is closed, either by the user or indirectly by the session manager.
virtual bool | queryClose ()
| Called before the window is closed, either by the user or indirectly by the session manager.
virtual void | saveProperties (KConfig *)
| Save your instance-specific properties.
virtual void | readProperties (KConfig *)
| Read your instance-specific properties.
virtual void | saveGlobalProperties (KConfig *sessionConfig)
| Save your application-wide properties.
virtual void | readGlobalProperties (KConfig *sessionConfig)
| The counterpart of saveGlobalProperties().
void | savePropertiesInternal (KConfig *, int)
bool | readPropertiesInternal (KConfig *, int)
bool | settingsDirty () const
| For inherited classes.
QString | settingsGroup () const
| For inherited classes.
void | saveWindowSize (KConfig *config) const
| For inherited classes Note that the group must be set before calling.
void | restoreWindowSize (KConfig *config)
| For inherited classes Note that the group must be set before calling, and that a -geometry on the command line has priority.
void | parseGeometry (bool parsewidth)
| parse the geometry from the geometry command line argument
virtual void | virtual_hook (int id, void *data)

## Friends

class | KMWSessionManaged

## Detailed Description

Top level widget that provides toolbars, a status line and a frame. KDE top level main window.

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 is also a macro RESTORE 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 97 of file kmainwindow.h.

## Constructor & Destructor Documentation

KMainWindow::KMainWindow | ( | QWidget * | parent = 0,
|  | const char * | name = 0,
|  | WFlags | f = WType_TopLevel|WDestructiveClose
| ) |

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.

  name

  The object name. For session management and window management to work properly, all main windows in the application should have a different name. When passing 0 (the default), 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 append 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#".

  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.

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

     KMainWindow *kmw = new KMainWindow (...

Definition at line 158 of file kmainwindow.cpp.

References KStdAccel::name().

KMainWindow::~KMainWindow | ( |  | ) | `[virtual]`

| Destructor. Will also destroy the toolbars, and menubar if needed. Definition at line 288 of file kmainwindow.cpp. References memberList, and QPtrList< KMainWindow >::remove().

## Member Function Documentation

KPopupMenu * KMainWindow::helpMenu | ( | const QString & | aboutAppText = QString::null,
|  | 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):

     KPopupMenu *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 298 of file kmainwindow.cpp.

References KXMLGUIClient::instance(), QString::isEmpty(), KHelpMenu::menu(), and showAboutApplication().

KPopupMenu * 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 315 of file kmainwindow.cpp.

References KHelpMenu::menu(), and showAboutApplication().

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 (kapp->isRestored()){
       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:

     if (kapp->isRestored())
       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.

See also:
  restore()

  classNameOfToplevel()

Definition at line 326 of file kmainwindow.cpp.

References QString::fromLatin1(), KIO::number(), KConfigBase::readNumEntry(), and KConfigBase::setGroup().

Referenced by restore().

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 338 of file kmainwindow.cpp. References QString::fromLatin1(), KConfigBase::hasKey(), KIO::number(), QString::prepend(), KConfigBase::readEntry(), KConfigBase::setGroup(), and QString::setNum().

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 355 of file kmainwindow.cpp. References canBeRestored(), and KIO::number().

void KMainWindow::createGUI | ( | const QString & | xmlfile = QString::null,
|  | bool | _conserveMemory = TRUE
| ) |

Create a GUI given a local XML file.

If `xmlfile` is NULL, then it will try to construct a local XML filename like appnameui.rc where 'appname' is your app's name. If that file does not exist, then the XML UI code will only use the global (standard) XML file for the layout purposes.

Note that when passing true for the conserveMemory argument subsequent calls to guiFactory()->addClient/removeClient may not work as expected. Also retrieving references to containers like popup menus or toolbars using the container method will not work.

Parameters:

  xmlfile | The local xmlfile (relative or absolute)
  _conserveMemory | Specify whether createGUI() should call KXMLGuiClient::conserveMemory() to free all memory allocated by the QDomDocument and by the KXMLGUIFactory.

Definition at line 375 of file kmainwindow.cpp.

References KXMLGUIClient::actionCollection(), KXMLGUIFactory::addClient(), QDomElement::attribute(), QPtrList< KToolBar >::clear(), QMenuBar::clear(), KXMLGUIClient::conserveMemory(), QDomDocument::documentElement(), KXMLGUIClient::domDocument(), KXMLGUIClient::instance(), QString::isNull(), locate(), KXMLGUIFactory::removeClient(), KXMLGUIFactory::resetContainer(), QPtrList< KToolBar >::setAutoDelete(), KXMLGUIClient::setXMLFile(), QDomElement::tagName(), and toolBarIterator().

void KMainWindow::setHelpMenuEnabled | ( | bool | showHelpMenu = true | ) |

| Enables the build of a standard help menu when calling createGUI(). The default behavior is to build one, you must call this function to disable it Definition at line 452 of file kmainwindow.cpp.

bool KMainWindow::isHelpMenuEnabled | ( |  | ) |

| Return `true` when the help menu is enabled. Definition at line 457 of file kmainwindow.cpp.

bool KMainWindow::hasMenuBar | ( |  | ) |

Returns true, if there is a menubar

Since:
  3.1.

Definition at line 885 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 890 of file kmainwindow.cpp. References QMainWindow::menuBar(). Referenced by sizeForCentralWidgetSize().

KStatusBar * KMainWindow::statusBar | ( |  | ) |

| Returns a pointer to the status bar. If there is no status bar yet one will be created. Definition at line 902 of file kmainwindow.cpp. References QMainWindow::statusBar(). Referenced by KXMLGUIBuilder::createContainer().

KToolBar * KMainWindow::toolBar | ( | const char * | name = 0 | ) |

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 or `0L` if it doesn't exist

Definition at line 960 of file kmainwindow.cpp.

References KStdAccel::name().

Referenced by KToggleToolBarAction::plug(), and sizeForCentralWidgetSize().

QPtrListIterator< KToolBar > KMainWindow::toolBarIterator | ( |  | ) |

Returns:
  An iterator over the list of all toolbars for this window.

Definition at line 975 of file kmainwindow.cpp.

References QPtrList< KToolBar >::append(), QPtrList< KToolBar >::clear(), QPtrList::first(), QPtrList::next(), and QMainWindow::toolBars().

Referenced by applyMainWindowSettings(), createGUI(), and saveMainWindowSettings().

KAccel * KMainWindow::accel | ( |  | ) |

Returns:
  A KAccel instance bound to this mainwindow. Used automatically by KAction to make keybindings work in all cases.

Definition at line 990 of file kmainwindow.cpp.

void KMainWindow::setAutoSaveSettings | ( | const QString & | groupName = QString::fromLatin1("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( 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.

Definition at line 839 of file kmainwindow.cpp.

References applyMainWindowSettings(), KGlobal::config(), and QMainWindow::dockWindowPositionChanged().

void KMainWindow::resetAutoSaveSettings | ( |  | ) |

| Disable the auto-save-settings feature. You don't normally need to call this, ever. Definition at line 851 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.

Since:
  3.1

Definition at line 858 of file kmainwindow.cpp.

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.

Since:
  3.1

Definition at line 863 of file kmainwindow.cpp.

void KMainWindow::applyMainWindowSettings | ( | KConfig * | config,
|  | const QString & | groupName = QString::null
| ) |

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

Parameters:

  config | Config file to read the settings from.
  groupName | Group name to use. If not specified, the last used group name is used.

Definition at line 700 of file kmainwindow.cpp.

References KToolBar::applySettings(), QPtrListIterator::current(), finalizeGUI(), QString::fromLatin1(), QMenuBar::hide(), QString::isEmpty(), QString::number(), QString::prepend(), KConfigBase::readListEntry(), restoreWindowSize(), KConfigBase::setGroup(), QMenuBar::show(), and toolBarIterator().

Referenced by setAutoSaveSettings().

void KMainWindow::saveMainWindowSettings | ( | KConfig * | config,
|  | const QString & | groupName = QString::null
| ) |

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

Parameters:

  config | Config file to save the settings to.
  groupName | Group name to use. If not specified, the last used group name is used

Definition at line 596 of file kmainwindow.cpp.

References QPtrListIterator::current(), QString::fromLatin1(), QString::isEmpty(), QString::number(), QString::prepend(), KToolBar::saveSettings(), saveWindowSize(), KConfigBase::setGroup(), toolBarIterator(), and KConfigBase::writeEntry().

void KMainWindow::setStandardToolBarMenuEnabled | ( | bool | enable | ) |

Sets whether KMainWindow should provide a menu that allows showing/hiding the available toolbars ( using KToggleToolBarAction ) .

In case there is only one toolbar configured a simple 'Show ' menu item is shown.

The menu / menu item is implemented using xmlgui. It will be inserted in your menu structure in the 'Settings' menu.

If your application uses a non-standard xmlgui resource file then you can specify the exact position of the menu / menu item by adding a <Merge name="StandardToolBarMenuHandler" /> line to the settings menu section of your resource file ( usually appname.rc ).

Note that you should enable this feature before calling createGUI() ( or similar ) . You enable/disable it anytime if you pass false to the conserveMemory argument of createGUI.

Since:
  3.1

Definition at line 649 of file kmainwindow.cpp.

References KXMLGUIFactory::addClient(), KXMLGUIClient::factory(), and KXMLGUIFactory::removeClient().

bool KMainWindow::isStandardToolBarMenuEnabled | ( |  | ) | const

Since:
  3.1

Definition at line 671 of file kmainwindow.cpp.

KAction * KMainWindow::toolBarMenuAction | ( |  | ) |

Returns a pointer to the mainwindows action responsible for the toolbars menu

Since:
  3.1.

Definition at line 244 of file kmainwindow.cpp.

void KMainWindow::finalizeGUI | ( | KXMLGUIClient * | client | ) | `[virtual]`

Since:
  3.1

Reimplemented from KXMLGUIBuilder.

Definition at line 1040 of file kmainwindow.cpp.

Referenced by applyMainWindowSettings().

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)

Definition at line 807 of file kmainwindow.cpp.

QSize KMainWindow::sizeForCentralWidgetSize | ( | QSize | size | ) |

Returns:
  the size the mainwindow should have so that the central widget will be of `size`.

Definition at line 1002 of file kmainwindow.cpp.

References KToolBar::barPos(), QMainWindow::dockWindowsMovable(), QSize::height(), QMenuBar::heightForWidth(), menuBar(), KToolBar::sizeHint(), toolBar(), and QSize::width().

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

References setPlainCaption().

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

References setPlainCaption().

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

References QString::utf8().

Referenced by setCaption().

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 /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):

     KIconLoader &loader = *KGlobal::iconLoader();
     QPixmap pixmap = loader.loadIcon( "help" );
     toolBar(0)->insertButton( pixmap, 0, SIGNAL(clicked()),
       this, SLOT(appHelpActivated()), true, i18n("Help") );

Definition at line 481 of file kmainwindow.cpp.

References KHelpMenu::appHelpActivated().

void KMainWindow::slotStateChanged | ( | const QString & | newstate | ) | `[virtual, slot]`

Apply a state change.

Enable and disable actions as defined in the XML rc file

Since:
  3.1

Definition at line 491 of file kmainwindow.cpp.

References KXMLGUIClient::stateChanged().

void KMainWindow::slotStateChanged | ( | const QString & | newstate,
|  | KXMLGUIClient::ReverseStateChange |
| ) | `[slot]`

Apply a state change.

Enable and disable actions as defined in the XML rc file, can "reverse" the state (disable the actions which should be enabled, and vice-versa) if specified.

Since:
  3.1

Definition at line 499 of file kmainwindow.cpp.

References KXMLGUIClient::stateChanged().

void KMainWindow::closeEvent | ( | QCloseEvent * |  | ) | `[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.

Reimplemented in UIServer.

Definition at line 515 of file kmainwindow.cpp.

References QCloseEvent::accept(), QPtrListIterator::current(), QCloseEvent::ignore(), memberList, queryClose(), queryExit(), and QPtrListIterator::toFirst().

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

However, queryExit() is useful to do some final cleanups. A typical example would be to write configuration data back.

Note that the application may continue to run after queryExit() (the user may have cancelled a shutdown). 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 KApplication::shutDown().

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

Referenced by closeEvent().

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;

See also:
  queryExit()

  KApplication::sessionSaving()

Definition at line 549 of file kmainwindow.cpp.

Referenced by closeEvent().

virtual void KMainWindow::saveProperties | ( | KConfig * |  | ) | `[inline, protected, virtual]`

| Save your instance-specific properties. The function is invoked when the session manager requests your application to save its state. You must not change the group of the `kconfig` object, since KMainWindow uses one group for each window. Please reimplement these function in childclasses. Note: No user interaction is allowed in this function! Definition at line 635 of file kmainwindow.h.

virtual void KMainWindow::readProperties | ( | KConfig * |  | ) | `[inline, protected, virtual]`

| Read your instance-specific properties. Definition at line 640 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 554 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 558 of file kmainwindow.cpp.

bool KMainWindow::settingsDirty | ( |  | ) | const`[protected]`

| For inherited classes. Definition at line 829 of file kmainwindow.cpp.

QString KMainWindow::settingsGroup | ( |  | ) | const`[protected]`

| For inherited classes. Definition at line 834 of file kmainwindow.cpp.

void KMainWindow::saveWindowSize | ( | KConfig * | config | ) | const`[protected]`

| For inherited classes Note that the group must be set before calling. Definition at line 774 of file kmainwindow.cpp. References QApplication::desktop(), QString::fromLatin1(), QRect::height(), QRect::width(), and KConfigBase::writeEntry(). Referenced by saveMainWindowSettings().

void KMainWindow::restoreWindowSize | ( | KConfig * | config | ) | `[protected]`

For inherited classes Note that the group must be set before calling, and that a -geometry on the command line has priority.

Definition at line 782 of file kmainwindow.cpp.

References QApplication::desktop(), QString::fromLatin1(), QRect::height(), QSize::isEmpty(), parseGeometry(), KConfigBase::readNumEntry(), QRect::width(), and KConfigBase::writeEntry().

Referenced by applyMainWindowSettings().

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

| parse the geometry from the geometry command line argument Definition at line 252 of file kmainwindow.cpp. References QApplication::desktop(), QSize::height(), KIO::move(), and QSize::width(). Referenced by restoreWindowSize().

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

     }

Definition at line 568 of file kmainwindow.cpp.

Referenced by customHelpMenu(), and helpMenu().

## Member Data Documentation

QPtrList< KMainWindow > * KMainWindow::memberList = 0L`[static]`

| List of members of KMainWindow class. Definition at line 70 of file kmainwindow.cpp. Referenced by closeEvent(), and ~KMainWindow().

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

- kmainwindow.h
- kmainwindow.cpp

This file is part of the documentation for kdelibs Version 3.1.5.
Documentation copyright © 1996-2002 the KDE developers.
Generated on Wed Jan 28 13:02:49 2004 by doxygen 1.3.4 written by Dimitri van Heesch, © 1997-2001