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 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. | |
Public Methods | |
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 . | |
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
| |
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 | 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 |
| |
KAction * | toolBarMenuAction () |
Returns a pointer to the mainwindows action responsible for the toolbars menu
| |
virtual void | finalizeGUI (KXMLGUIClient *client) |
| |
bool | initialGeometrySet () const |
QSize | sizeForCentralWidgetSize (QSize size) |
Static Public Methods | |
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 Methods | |
void | childEvent (QChildEvent *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(). | |
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) |
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
|
Construct a main window.
KMainWindow *kmw = new KMainWindow (... Definition at line 158 of file kmainwindow.cpp. |
|
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
|
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 298 of file kmainwindow.cpp. References KXMLGUIClient::instance(), QString::isEmpty(), 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 315 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 }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.
Definition at line 326 of file kmainwindow.cpp. References QString::fromLatin1(), and KIO::number(). Referenced by restore(). |
|
Returns the className() of the This is only useful if your application uses different kinds of toplevel windows. Definition at line 338 of file kmainwindow.cpp. References QString::fromLatin1(), KIO::number(), QString::prepend(), and QString::setNum(). |
|
Restore the session specified by
Returns Definition at line 355 of file kmainwindow.cpp. References canBeRestored(), and KIO::number(). |
|
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 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(), KXMLGUIFactory::removeClient(), KXMLGUIFactory::resetContainer(), QPtrList< KToolBar >::setAutoDelete(), KXMLGUIClient::setXMLFile(), QDomElement::tagName(), and toolBarIterator(). |
|
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. |
|
Return
Definition at line 457 of file kmainwindow.cpp. |
|
Returns true, if there is a menubar
Definition at line 885 of file kmainwindow.cpp. |
|
Returns a pointer to the menu bar. If there is no menu bar yet one will be created. Reimplemented from QMainWindow. Definition at line 890 of file kmainwindow.cpp. References QMainWindow::menuBar(). Referenced by sizeForCentralWidgetSize(). |
|
Returns a pointer to the status bar. If there is no status bar yet one will be created. Reimplemented from QMainWindow. Definition at line 902 of file kmainwindow.cpp. References QMainWindow::statusBar(). Referenced by KXMLGUIBuilder::createContainer(). |
|
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 960 of file kmainwindow.cpp. Referenced by KToggleToolBarAction::plug(), and sizeForCentralWidgetSize(). |
|
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(). |
|
Definition at line 990 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.
Definition at line 839 of file kmainwindow.cpp. References applyMainWindowSettings(), KGlobal::config(), QMainWindow::dockWindowPositionChanged(), and saveWindowSize(). |
|
Disable the auto-save-settings feature. You don't normally need to call this, ever. Definition at line 851 of file kmainwindow.cpp. |
|
Definition at line 858 of file kmainwindow.cpp. |
|
Definition at line 863 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 700 of file kmainwindow.cpp. References KToolBar::applySettings(), QPtrListIterator::current(), finalizeGUI(), QString::fromLatin1(), QMenuBar::hide(), QString::isEmpty(), QString::number(), QString::prepend(), restoreWindowSize(), QMenuBar::show(), and toolBarIterator(). Referenced by setAutoSaveSettings(). |
|
Save settings for statusbar, menubar and toolbar to their respective groups in the config file
Definition at line 596 of file kmainwindow.cpp. References QPtrListIterator::current(), QString::fromLatin1(), QString::isEmpty(), QString::number(), QString::prepend(), KToolBar::saveSettings(), saveWindowSize(), and toolBarIterator(). |
|
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 649 of file kmainwindow.cpp. References KXMLGUIFactory::addClient(), KXMLGUIClient::factory(), and KXMLGUIFactory::removeClient(). |
|
Definition at line 671 of file kmainwindow.cpp. |
|
Returns a pointer to the mainwindows action responsible for the toolbars menu
Definition at line 244 of file kmainwindow.cpp. |
|
Reimplemented from KXMLGUIBuilder. Definition at line 1040 of file kmainwindow.cpp. Referenced by applyMainWindowSettings(). |
|
Definition at line 807 of file kmainwindow.cpp. |
|
Definition at line 1002 of file kmainwindow.cpp. References KToolBar::barPos(), QMainWindow::dockWindowsMovable(), QSize::height(), QMenuBar::heightForWidth(), menuBar(), KToolBar::sizeHint(), toolBar(), and QSize::width(). |
|
Makes a KDE compliant caption.
Definition at line 462 of file kmainwindow.cpp. References setPlainCaption(). |
|
Makes a KDE compliant caption.
Definition at line 467 of file kmainwindow.cpp. References setPlainCaption(). |
|
Make a plain caption without any modifications.
Definition at line 472 of file kmainwindow.cpp. References QString::utf8(). 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 481 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 491 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 499 of file kmainwindow.cpp. References KXMLGUIClient::stateChanged(). |
|
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(). |
|
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
Definition at line 544 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;
Definition at line 549 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 631 of file kmainwindow.h. |
|
Read your instance-specific properties.
Definition at line 636 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 554 of file kmainwindow.cpp. |
|
The counterpart of saveGlobalProperties(). Read the application-specific properties in again. Definition at line 558 of file kmainwindow.cpp. |
|
For inherited classes.
Definition at line 829 of file kmainwindow.cpp. |
|
For inherited classes.
Definition at line 834 of file kmainwindow.cpp. |
|
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(), and QRect::width(). Referenced by saveMainWindowSettings(), and setAutoSaveSettings(). |
|
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(), and QRect::width(). Referenced by applyMainWindowSettings(). |
|
parse the geometry from the geometry command line argument
Definition at line 252 of file kmainwindow.cpp. References QApplication::desktop(), QSize::height(), and QSize::width(). Referenced by restoreWindowSize(). |
|
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 568 of file kmainwindow.cpp. Referenced by customHelpMenu(), and helpMenu(). |
Member Data Documentation
|
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: