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:

Public Types | |
enum | CreationFlags { NoDCOPObject = 1 } |
enum | StandardWindowOptions { ToolBar = 1, Keys = 2, StatusBar = 4, Save = 8, Create = 16 } |
Public Slots | |
int | configureToolbars () |
virtual void | setCaption (const QString &caption) |
virtual void | setCaption (const QString &caption, bool modified) |
virtual void | setPlainCaption (const QString &caption) |
void | appHelpActivated (void) |
virtual void | slotStateChanged (const QString &newstate) |
void | slotStateChanged (const QString &newstate, KXMLGUIClient::ReverseStateChange) |
void | setSettingsDirty () |
Public Member Functions | |
KMainWindow (QWidget *parent=0, const char *name=0, WFlags f=WType_TopLevel|WDestructiveClose) | |
KMainWindow (int cflags, 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) |
virtual void | show () |
virtual void | hide () |
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 () |
bool | hasMenuBar () |
KMenuBar * | menuBar () |
KStatusBar * | statusBar () |
KToolBar * | toolBar (const char *name=0) |
QPtrListIterator< KToolBar > | toolBarIterator () |
KAccel * | accel () |
void | setFrameBorderWidth (int) |
void | setAutoSaveSettings (const QString &groupName=QString::fromLatin1("MainWindow"), bool saveWindowSize=true) |
void | resetAutoSaveSettings () |
bool | autoSaveSettings () const |
QString | autoSaveGroup () const |
void | applyMainWindowSettings (KConfig *config, const QString &groupName, bool force) |
void | applyMainWindowSettings (KConfig *config, const QString &groupName=QString::null) |
void | saveMainWindowSettings (KConfig *config, const QString &groupName=QString::null) |
void | setStandardToolBarMenuEnabled (bool enable) |
bool | isStandardToolBarMenuEnabled () const |
void | createStandardStatusBarAction () |
void | setupGUI (int options=ToolBar|Keys|StatusBar|Save|Create, const QString &xmlfile=QString::null) |
KAction * | toolBarMenuAction () |
void | setupToolbarMenuActions () |
virtual void | finalizeGUI (KXMLGUIClient *client) |
void | finalizeGUI (bool force) |
bool | initialGeometrySet () const |
void | ignoreInitialGeometry () |
QSize | sizeForCentralWidgetSize (QSize size) KDE_DEPRECATED |
Static Public Member Functions | |
bool | canBeRestored (int number) |
const QString | classNameOfToplevel (int number) |
Static Public Attributes | |
QPtrList< KMainWindow > * | memberList = 0L |
Protected Slots | |
void | saveNewToolbarConfig () |
virtual void | showAboutApplication () |
void | saveAutoSaveSettings () |
Protected Member Functions | |
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) |
virtual void | virtual_hook (int id, void *data) |
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 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 98 of file kmainwindow.h.
Member Enumeration Documentation
|
Flags that can be passed in an argument to the constructor to change the behavior. NoDCOPObject tells KMainWindow not to create a KMainWindowInterface. This can be useful in particular for inherited classes, which might want to create more specific dcop interfaces. It's a good idea to use KMainWindowInterface as the base class for such interfaces though (to provide the standard mainwindow functionality via DCOP). Definition at line 148 of file kmainwindow.h. |
|
Definition at line 534 of file kmainwindow.h. |
Constructor & Destructor Documentation
|
Construct a main window.
KMainWindow *kmw = new KMainWindow (...); Definition at line 166 of file kmainwindow.cpp. |
|
Overloaded constructor which allows passing some KMainWindow::CreationFlags.
Definition at line 172 of file kmainwindow.cpp. |
|
Destructor. Will also destroy the toolbars, and menubar if needed. Definition at line 314 of file kmainwindow.cpp. References memberList. |
Member Function Documentation
|
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 );
Definition at line 324 of file kmainwindow.cpp. References KXMLGUIClient::instance(), KHelpMenu::menu(), and showAboutApplication(). |
|
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() );
Definition at line 341 of file kmainwindow.cpp. References KHelpMenu::menu(), and showAboutApplication(). |
|
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 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 } 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 (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. 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 (kapp->isRestored()) 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.
Definition at line 352 of file kmainwindow.cpp. References KConfigBase::readNumEntry(), and KConfigBase::setGroup(). Referenced by restore(). |
|
Returns the className() of the This is only useful if your application uses different kinds of toplevel windows. Definition at line 364 of file kmainwindow.cpp. References KConfigBase::hasKey(), KConfigBase::readEntry(), and KConfigBase::setGroup(). |
|
Reimplementation of QMainWindow::show().
Definition at line 381 of file kmainwindow.cpp. Referenced by restore(). |
|
Reimplementation of QMainWindow::hide().
Definition at line 391 of file kmainwindow.cpp. |
|
Restore the session specified by
Returns Definition at line 411 of file kmainwindow.cpp. References canBeRestored(), and show(). |
|
Create a GUI given a local XML file.
If 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.
Definition at line 477 of file kmainwindow.cpp. References KXMLGUIClient::actionCollection(), KXMLGUIFactory::addClient(), KXMLGUIClient::conserveMemory(), KXMLGUIClient::domDocument(), KXMLGUIClient::instance(), locate(), KXMLGUIFactory::removeClient(), KXMLGUIFactory::resetContainer(), KXMLGUIClient::setXMLFile(), and toolBarIterator(). Referenced by saveNewToolbarConfig(), and setupGUI(). |
|
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 557 of file kmainwindow.cpp. |
|
Return
Definition at line 562 of file kmainwindow.cpp. |
|
Returns true, if there is a menubar
Definition at line 1041 of file kmainwindow.cpp. |
|
Returns a pointer to the menu bar. If there is no menu bar yet one will be created. Definition at line 1046 of file kmainwindow.cpp. |
|
Returns a pointer to the status bar. If there is no status bar yet one will be created. Definition at line 1058 of file kmainwindow.cpp. Referenced by KXMLGUIBuilder::createContainer(), and createStandardStatusBarAction(). |
|
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.
Definition at line 1116 of file kmainwindow.cpp. Referenced by KToggleToolBarAction::plug(), and sizeForCentralWidgetSize(). |
|
Definition at line 1131 of file kmainwindow.cpp. Referenced by applyMainWindowSettings(), createGUI(), and saveMainWindowSettings(). |
|
Definition at line 1146 of file kmainwindow.cpp. |
|
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.
To make sure that KMainWindow propertly obtains the default size of the window you should do the following:
Definition at line 994 of file kmainwindow.cpp. References applyMainWindowSettings(), and setSettingsDirty(). Referenced by setupGUI(). |
|
Disable the auto-save-settings feature. You don't normally need to call this, ever. Definition at line 1007 of file kmainwindow.cpp. |
|
Definition at line 1014 of file kmainwindow.cpp. |
|
Definition at line 1019 of file kmainwindow.cpp. |
|
Read settings for statusbar, menubar and toolbar from their respective groups in the config file and apply them.
Definition at line 821 of file kmainwindow.cpp. References KToolBar::applySettings(), finalizeGUI(), kdDebug(), KConfigBase::readEntry(), restoreWindowSize(), KConfigBase::setGroup(), and toolBarIterator(). Referenced by saveNewToolbarConfig(), and setAutoSaveSettings(). |
|
Save settings for statusbar, menubar and toolbar to their respective groups in the config file
Definition at line 703 of file kmainwindow.cpp. References KConfigBase::group(), KConfigBase::hasDefault(), kdDebug(), KConfigBase::revertToDefault(), KToolBar::saveSettings(), saveWindowSize(), KConfigBase::setGroup(), toolBarIterator(), and KConfigBase::writeEntry(). Referenced by configureToolbars(), and saveAutoSaveSettings(). |
|
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 ) . You enable/disable it anytime if you pass false to the conserveMemory argument of createGUI.
Definition at line 756 of file kmainwindow.cpp. References KXMLGUIFactory::addClient(), KXMLGUIClient::factory(), and KXMLGUIFactory::removeClient(). Referenced by setupGUI(). |
|
Definition at line 778 of file kmainwindow.cpp. |
|
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.
Definition at line 783 of file kmainwindow.cpp. References KXMLGUIClient::actionCollection(), setSettingsDirty(), KStdAction::showStatusbar(), and statusBar(). Referenced by setupGUI(). |
|
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().
Definition at line 445 of file kmainwindow.cpp. References KXMLGUIClient::actionCollection(), configureToolbars(), KStdAction::configureToolbars(), createGUI(), createStandardStatusBarAction(), KStdAction::keyBindings(), setAutoSaveSettings(), and setStandardToolBarMenuEnabled(). |
|
Returns a pointer to the mainwindows action responsible for the toolbars menu
Definition at line 262 of file kmainwindow.cpp. |
|
Reimplemented from KXMLGUIBuilder. Definition at line 1197 of file kmainwindow.cpp. Referenced by applyMainWindowSettings(). |
|
Definition at line 957 of file kmainwindow.cpp. |
|
Definition at line 1158 of file kmainwindow.cpp. References KToolBar::barPos, KToolBar::sizeHint(), and toolBar(). |
|
Show a standard configure toolbar dialog. This slot can be connected dirrectly to the action to configure shortcuts. This is very simple to do that by adding a single line KStdAction::configureToolbars( guiFactory(), SLOT( configureToolbars() ), actionCollection() );
Definition at line 431 of file kmainwindow.cpp. References KXMLGUIClient::actionCollection(), saveMainWindowSettings(), saveNewToolbarConfig(), and KXMLGUIClient::xmlFile(). Referenced by setupGUI(). |
|
Makes a KDE compliant caption.
Definition at line 567 of file kmainwindow.cpp. References setPlainCaption(). |
|
Makes a KDE compliant caption.
Definition at line 572 of file kmainwindow.cpp. References setPlainCaption(). |
|
Make a plain caption without any modifications.
Definition at line 577 of file kmainwindow.cpp. References NETWinInfo::setName(). Referenced by setCaption(). |
|
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") ); Definition at line 587 of file kmainwindow.cpp. References KHelpMenu::appHelpActivated(). |
|
Apply a state change. Enable and disable actions as defined in the XML rc file
Definition at line 597 of file kmainwindow.cpp. References KXMLGUIClient::stateChanged(). |
|
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.
Definition at line 605 of file kmainwindow.cpp. References KXMLGUIClient::stateChanged(). |
|
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 967 of file kmainwindow.cpp. References saveAutoSaveSettings(). Referenced by createStandardStatusBarAction(), and setAutoSaveSettings(). |
|
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 621 of file kmainwindow.cpp. References memberList, queryClose(), queryExit(), and saveAutoSaveSettings(). |
|
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 KApplication::shutDown().
Default implementation returns
Definition at line 651 of file kmainwindow.cpp. Referenced by closeEvent(). |
|
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 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.
Reimplemented in UIServer. Definition at line 656 of file kmainwindow.cpp. Referenced by closeEvent(). |
|
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 Note: No user interaction is allowed in this function! Definition at line 846 of file kmainwindow.h. |
|
Read your instance-specific properties.
Definition at line 851 of file kmainwindow.h. |
|
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 661 of file kmainwindow.cpp. |
|
The counterpart of saveGlobalProperties(). Read the application-specific properties in again. Definition at line 665 of file kmainwindow.cpp. |
|
For inherited classes.
Definition at line 984 of file kmainwindow.cpp. |
|
For inherited classes.
Definition at line 989 of file kmainwindow.cpp. |
|
For inherited classes Note that the group must be set before calling.
Definition at line 888 of file kmainwindow.cpp. References KConfigBase::hasDefault(), KConfigBase::revertToDefault(), KWin::WindowInfo::state(), KWin::windowInfo(), and KConfigBase::writeEntry(). Referenced by saveMainWindowSettings(). |
|
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 918 of file kmainwindow.cpp. References parseGeometry(), KConfigBase::readNumEntry(), KWin::setState(), and KConfigBase::writeEntry(). Referenced by applyMainWindowSettings(). |
|
parse the geometry from the geometry command line argument
Definition at line 277 of file kmainwindow.cpp. Referenced by restoreWindowSize(). |
|
Rebuilds the GUI after KEditToolbar changed the toolbar layout.
Definition at line 439 of file kmainwindow.cpp. References applyMainWindowSettings(), createGUI(), and KXMLGUIClient::xmlFile(). Referenced by configureToolbars(). |
|
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 675 of file kmainwindow.cpp. Referenced by customHelpMenu(), and helpMenu(). |
|
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.
void MyMainWindow::closeEvent( QCloseEvent *e ) { // Save settings if auto-save is enabled, and settings have changed if ( settingsDirty() && autoSaveSettings() ) saveAutoSaveSettings(); .. } Definition at line 1024 of file kmainwindow.cpp. References KGlobal::config(), saveMainWindowSettings(), and KConfigBase::sync(). Referenced by closeEvent(), and setSettingsDirty(). |
Member Data Documentation
|
List of members of KMainWindow class.
Definition at line 78 of file kmainwindow.cpp. Referenced by closeEvent(), and ~KMainWindow(). |
The documentation for this class was generated from the following files: