# class KMainWindow | KDE top level main window. More...
Definition | `#include <kmainwindow.h>`
Inherits | KXMLGUIBuilder [public ], KXMLGUIClient [virtual public ], QMainWindow (qt) [public ]
Inherited by | KDockMainWindow, KTMainWindow
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

#### Public Methods

- KMainWindow ( QWidget* parent = 0, const char *name = 0, WFlags f = WType_TopLevel | WDestructiveClose )
- virtual ~KMainWindow ()
- KPopupMenu* helpMenu ( const QString &aboutAppText = QString::null, bool showWhatsThis = TRUE )
- KPopupMenu* customHelpMenu ( bool showWhatsThis = TRUE )
- bool restore ( int number, bool show = TRUE )
- virtual KXMLGUIFactory * guiFactory ()
- void createGUI ( const QString &xmlfile = QString::null, bool _conserveMemory = TRUE )
- void setHelpMenuEnabled (bool showHelpMenu = true)
- bool isHelpMenuEnabled ()
- KMenuBar * menuBar ()
- KStatusBar * statusBar ()
- KToolBar * toolBar ( const char *name=0 )
- QListIterator<KToolBar> toolBarIterator ()
- void setFrameBorderWidth ( int )
- void setAutoSaveSettings ( const QString & groupName = QString::fromLatin1("MainWindow"), bool saveWindowSize = true )
- void resetAutoSaveSettings ()
- void applyMainWindowSettings (KConfig *config, const QString &groupName = QString::null)
- void saveMainWindowSettings (KConfig *config, const QString &groupName = QString::null)
- void finalizeGUI ( bool force )
- bool initialGeometrySet () const

#### 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 Static Methods

- static bool canBeRestored ( int number )
- static const QString classNameOfToplevel ( int number )

#### Public Members

- static QList<KMainWindow>* memberList

#### Protected Methods

- void paintEvent ( QPaintEvent* e )
- void childEvent ( QChildEvent* e)
- void resizeEvent ( QResizeEvent* e)
- virtual void closeEvent ( QCloseEvent *)
- virtual bool queryExit ()
- virtual bool queryClose ()
- virtual void saveProperties ( KConfig* )
- virtual void readProperties ( KConfig* )
- virtual void saveGlobalProperties ( KConfig* sessionConfig )
- virtual void readGlobalProperties ( KConfig* sessionConfig )
- void savePropertiesInternal ( KConfig*, int )
- bool readPropertiesInternal ( KConfig*, int )
- bool settingsDirty () const
- QString settingsGroup () const
- void saveWindowSize ( KConfig * config ) const
- void restoreWindowSize ( KConfig * config )
- void parseGeometry (bool parsewidth)

#### Protected Slots

- void showAboutApplication ( void )

## Detailed Description

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

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

Construct a main window.

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

     KMainWindow *kmw = new KMainWindow (...</pre>

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 to work properly, all main windows in the application have to have a different name. When passing 0 (the default), KMainWindow will create such a name for you. So simply never pass anything else ;-)
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 behaviour.

~KMainWindow () | ### ~KMainWindow

[virtual]

Destructor.

Will also destroy the toolbars, and menubar if needed.

KPopupMenu* helpMenu ( const QString &aboutAppText = QString::null, bool showWhatsThis = TRUE ) | ### helpMenu

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.

KPopupMenu* customHelpMenu ( bool showWhatsThis = TRUE ) | ### customHelpMenu

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

bool canBeRestored ( int number ) | ### canBeRestored

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

const QString classNameOfToplevel ( int number ) | ### classNameOfToplevel

[static]

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

bool restore ( int number, bool show = TRUE ) | ### restore

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.

KXMLGUIFactory * guiFactory () | ### guiFactory

[virtual]

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

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.

Parameters:

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

void setHelpMenuEnabled (bool showHelpMenu = true) | ### setHelpMenuEnabled

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

bool isHelpMenuEnabled () | ### isHelpMenuEnabled

Return `true` when the help menu is enabled

KMenuBar * menuBar () | ### menuBar

Retrieve a pointer to the menu bar.

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

Reimplemented from QMainWindow.

KStatusBar * statusBar () | ### statusBar

Retrieve a pointer to the status bar.

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

Reimplemented from QMainWindow.

static QList<KMainWindow>* memberList | ### memberList

KToolBar * toolBar ( const char *name=0 ) | ### toolBar

Retrieve 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

QListIterator<KToolBar> toolBarIterator () | ### toolBarIterator

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

void setFrameBorderWidth ( int ) | ### setFrameBorderWidth

void setAutoSaveSettings ( const QString & groupName = QString::fromLatin1("MainWindow"), bool saveWindowSize = true ) | ### setAutoSaveSettings

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.

Typically, you will call setAutoSaveSettings() in your KMainWindow-inherited class constructor, and it will take care of restoring and saving automatically.

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.

void resetAutoSaveSettings () | ### resetAutoSaveSettings

Disable the auto-save-settings feature. You don't normally need to call this, ever.

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

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 | For internal use only.

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

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 | For internal use only.

void finalizeGUI ( bool force ) | ### finalizeGUI

Reimplemented from KXMLGUIBuilder.

bool initialGeometrySet () | ### 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 setCaption ( const QString &caption ) | ### setCaption

[virtual slot]

Makes a KDE compliant caption.

Parameters:

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

void setCaption ( const QString &caption, bool modified ) | ### setCaption

[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 additionnal sign in the title bar, usually "**".

void setPlainCaption ( const QString &caption ) | ### setPlainCaption

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

void appHelpActivated ( void ) | ### appHelpActivated

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

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

void setSettingsDirty () | ### setSettingsDirty

[slot]

void paintEvent ( QPaintEvent* e ) | ### paintEvent

[protected]

Reimplemented from QMainWindow.

void childEvent ( QChildEvent* e) | ### childEvent

[protected]

Reimplemented from QMainWindow.

void resizeEvent ( QResizeEvent* e) | ### resizeEvent

[protected]

Reimplemented from QMainWindow.

void closeEvent ( QCloseEvent *) | ### closeEvent

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

bool queryExit () | ### queryExit

[protected virtual]

Called before the very last window is closed, either by the user or indirectely 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.

See also: queryClose()

bool queryClose () | ### queryClose

[protected virtual]

Called before the window is closed, either by the user or indirectely 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.

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

void saveProperties ( KConfig* ) | ### saveProperties

[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!

void readProperties ( KConfig* ) | ### readProperties

[protected virtual]

Read your instance-specific properties.

void saveGlobalProperties ( KConfig* sessionConfig ) | ### saveGlobalProperties

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

void readGlobalProperties ( KConfig* sessionConfig ) | ### readGlobalProperties

[protected virtual]

The counterpart of saveGlobalProperties().

Read the application-specific properties in again.

void savePropertiesInternal ( KConfig*, int ) | ### savePropertiesInternal

[protected]

bool readPropertiesInternal ( KConfig*, int ) | ### readPropertiesInternal

[protected]

bool settingsDirty () | ### settingsDirty

[protected const]

For inherited classes

QString settingsGroup () | ### settingsGroup

[protected const]

For inherited classes

void saveWindowSize ( KConfig * config ) | ### saveWindowSize

[protected const]

For inherited classes Note that the group must be set before calling

void restoreWindowSize ( KConfig * config ) | ### restoreWindowSize

[protected]

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) | ### parseGeometry

[protected]

void showAboutApplication ( void ) | ### showAboutApplication

[protected slots 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( void )
     {
       <activate your custom dialog>
     }

- 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)
- Generated: root@sparc.ports.openbsd.org on Wed May 2 09:37:45 2001, using kdoc 2.0a53.