# class KXmlGuiWindow

###

Module | kdeui
Namespace |
Class | KXmlGuiWindow
Inherits | KMainWindow,KXMLGUIBuilder,KXMLGUIClient

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

### enums

- StandardWindowOption { ToolBar, Keys, StatusBar, Save, Create, Default }
  typesafe object: StandardWindowOptions

enum details

### methods

- KXmlGuiWindow (parent, f)

  returns ctor
  KDE 4.1.0 and later only

  Argument | Type | Default
  --- | --- | ---
  parent | QWidget | 0
  f | Qt.WindowFlags | 0

  Construct a main window.

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

- KXmlGuiWindow (a0, a1)

  returns ctor
  before KDE 4.1.0 only

  Argument | Type | Default
  --- | --- | ---
  a0 | QWidget | 0
  a1 | Qt.WindowFlags | 0

- applyMainWindowSettings (config, force)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  config | KConfigGroup |
  force | bool | 0

- configureToolbars ( )

  returns Nothing

  Show a standard configure toolbar dialog.

  This slot can be connected directly to the action to configure toolbar. This is very simple to do that by adding a single line

      KStandardAction.configureToolbars( this, SLOT( configureToolbars() ),
      actionCollection() );

- createGUI (xmlfile)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  xmlfile | QString | QString()

  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.

  xmlfile - The local xmlfile (relative or absolute)

- createStandardStatusBarAction ( )

  returns Nothing

  Sets whether KMainWindow should provide a menu that allows showing/hiding of the statusbar ( using KToggleStatusBarAction ).

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

  Note that you should enable this feature before calling createGUI() ( or similar ).

  If an application maintains the action on its own (i.e. never calls this function) a connection needs to be made to let KMainWindow know when that status (hidden/shown) of the statusbar has changed. For example: connect(action, SIGNAL(activated()), kmainwindow, SLOT(setSettingsDirty())); Otherwise the status (hidden/show) of the statusbar might not be saved by KMainWindow.

- event (event)

  returns bool

  Argument | Type | Default
  --- | --- | ---
  event | QEvent |

  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.

- finalizeGUI (client)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  client | KXMLGUIClient |

- finalizeGUI (force)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  force | bool |

  Internal

- guiFactory ( )

  returns KXMLGUIFactory

- isHelpMenuEnabled ( )

  returns bool

  Return true when the help menu is enabled

- isStandardToolBarMenuEnabled ( )

  returns bool

- saveNewToolbarConfig ( )

  returns Nothing

  Rebuilds the GUI after KEditToolbar changed the toolbar layout.

  See also configureToolbars()

- setHelpMenuEnabled (showHelpMenu)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  showHelpMenu | bool | 1

  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

- setStandardToolBarMenuEnabled (enable)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  enable | bool |

  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 \<toolbar name here\>' 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 ) .

- setupGUI (options, xmlfile)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  options | KXmlGuiWindow.StandardWindowOptions | KXmlGuiWindow.Default
  xmlfile | QString | QString()

  Configures the current windows and its actions in the typical KDE fashion. The options are all enabled by default but can be turned off if desired through the params or if the prereqs don't exists.

  Typically this function replaces createGUI().

  See also StandardWindowOptions

- setupGUI (defaultSize, options, xmlfile)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  defaultSize | QSize |
  options | KXmlGuiWindow.StandardWindowOptions | KXmlGuiWindow.Default
  xmlfile | QString | QString()

  Configures the current windows and its actions in the typical KDE fashion. The options are all enabled by default but can be turned off if desired through the params or if the prereqs don't exists.

  defaultSize The default size of the window

  Typically this function replaces createGUI().

  See also StandardWindowOptions

- setupToolbarMenuActions ( )

  returns Nothing

  Internal for KToolBar

- slotStateChanged (newstate)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  newstate | QString |

  Apply a state change

  Enable and disable actions as defined in the XML rc file

- slotStateChanged (newstate, reverse)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  newstate | QString |
  reverse | bool |

  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.

- toolBarMenuAction ( )

  returns QAction

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

### enums - detail

- StandardWindowOption { ToolBar, Keys, StatusBar, Save, Create, Default }

  adds action to show/hide the toolbar(s) and adds action to configure the toolbar(s).

  See also setStandardToolBarMenuEnabled

  typesafe object: StandardWindowOptions

ToolBar - 1 -
Keys - 2 -
StatusBar - 4 -
Save - 8 -
Create - 16 -
Default - ToolBar|Keys|StatusBar|Save|Create -