#include <kmainwindow.h>
Inheritance diagram for KMainWindow:
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) |
| virtual void | slotStateChanged (const QString &newstate) |
| void | slotStateChanged (const QString &newstate, KXMLGUIClient::ReverseStateChange) |
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) |
| 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 | 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=QString::null) |
| void | saveMainWindowSettings (KConfig *config, const QString &groupName=QString::null) |
| void | setStandardToolBarMenuEnabled (bool enable) |
| bool | isStandardToolBarMenuEnabled () const |
| |
| KAction * | toolBarMenuAction () |
| virtual void | finalizeGUI (KXMLGUIClient *client) |
| |
| bool | initialGeometrySet () const |
| QSize | sizeForCentralWidgetSize (QSize size) |
Static Public Methods | |
| bool | canBeRestored (int number) |
| const QString | classNameOfToplevel (int number) |
Static Public Attributes | |
| QPtrList< KMainWindow > * | memberList |
Protected Slots | |
| virtual void | showAboutApplication () |
Protected Methods | |
| 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) |
| bool | settingsDirty () const |
| QString | settingsGroup () const |
| void | saveWindowSize (KConfig *config) const |
| void | restoreWindowSize (KConfig *config) |
| void | parseGeometry (bool parsewidth) |
| parse the geometry from the geometry command line argument | |
| virtual void | virtual_hook (int id, void *data) |
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.
Definition at line 97 of file kmainwindow.h.
|
||||||||||||||||
|
Construct a main window.
KMainWindow *kmw = new KMainWindow (... |
|
|
Destructor. Will also destroy the toolbars, and menubar if needed. |
|
|
|
|
|
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") ); |
|
||||||||||||
|
Read settings for statusbar, menubar and toolbar from their respective groups in the config file and apply them.
|
|
|
|
|
|
|
|
|
@sect 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.
|
|
|
Returns the className() of the This is only useful if your application uses different kinds of toplevel windows. |
|
|
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. |
|
||||||||||||
|
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.
|
|
|
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() );
|
|
|
Returns true, if there is a menubar
|
|
||||||||||||
|
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 );
|
|
|
|
|
|
Return |
|
|
Returns a pointer to the menu bar. If there is no menu bar yet one will be created. |
|
|
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;
|
|
|
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
|
|
|
The counterpart of saveGlobalProperties(). Read the application-specific properties in again. |
|
|
Read your instance-specific properties. Definition at line 640 of file kmainwindow.h. |
|
|
Disable the auto-save-settings feature. You don't normally need to call this, ever. |
|
||||||||||||
|
Restore the session specified by
Returns |
|
|
For inherited classes Note that the group must be set before calling, and that a -geometry on the command line has priority. |
|
|
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. |
|
||||||||||||
|
Save settings for statusbar, menubar and toolbar to their respective groups in the config file
|
|
|
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 635 of file kmainwindow.h. |
|
|
For inherited classes Note that the group must be set before calling |
|
||||||||||||
|
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.
|
|
||||||||||||
|
Makes a KDE compliant caption.
|
|
|
Makes a KDE compliant caption.
|
|
|
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 |
|
|
Make a plain caption without any modifications.
|
|
|
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.
|
|
|
For inherited classes |
|
|
For inherited classes |
|
|
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>
}
|
|
|
|
|
||||||||||||
|
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.
|
|
|
Apply a state change Enable and disable actions as defined in the XML rc file
|
|
|
Returns a pointer to the status bar. If there is no status bar yet one will be created. |
|
|
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.
|
|
|
|
|
|
Returns a pointer to the mainwindows action responsible for the toolbars menu
|
|
|
List of members of KMainWindow class. Definition at line 323 of file kmainwindow.h. |
1.2.18