<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>KMainWindow</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<link rel="stylesheet" type="text/css" href="../common/doxygen.css" />
<link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../common/kde.css" />
</head>
<body>
<div id="container">
<div id="header">
<div id="header_top">
<div>
<div>
<img alt ="" src="../common/top-kde.jpg"/>
KDE 4.4 PyKDE API Reference
</div>
</div>
</div>
<div id="header_bottom">
<div id="location">
<ul>
<li>KDE's Python API</li>
</ul>
</div>
<div id="menu">
<ul>
<li><a href="../modules.html">Overview</a></li>
<li><a href="http://techbase.kde.org/Development/Languages/Python">PyKDE Home</a></li>
<li><a href="http://kde.org/family/">Sitemap</a></li>
<li><a href="http://kde.org/contact/">Contact Us</a></li>
</ul>
</div>
</div>
</div>
<div id="body_wrapper">
<div id="body">
<div id="right">
<div class="content">
<div id="main">
<div class="clearer"> </div>
<h1>KMainWindow Class Reference</h1>
<code>from PyKDE4.kdeui import *</code>
<p>
Inherits: <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qmainwindow.html">QMainWindow</a> → <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qwidget.html">QWidget</a> → <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qobject.html">QObject</a><br />
Subclasses: <a href="../kdeui/KXmlGuiWindow.html">KXmlGuiWindow</a><br />
<h2>Detailed Description</h2>
<p>KDE top level main window
</p>
<p>
Top level widget that provides toolbars, a status line and a frame.
</p>
<p>
It should be used as a top level (parent-less) widget.
It manages the geometry for all its children, including your
main widget.
</p>
<p>
Normally, you will inherit from KMainWindow,
then construct (or use some existing) widget as
your main view. You can set only one main view.
</p>
<p>
You can add as many toolbars as you like. There can be only one menubar
and only one statusbar.
</p>
<p>
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.
</p>
<p>
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.
</p>
<p>
Fixed aspect ratios (heightForWidth()) and fixed width widgets are
not supported.
</p>
<p>
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().
</p>
<p>
You have to implement session restoring also in your main() function.
There are also kRestoreMainWindows convenience functions which
can do this for you and restore all your windows on next login.
</p>
<p>
Note that KMainWindow uses KGlobal.ref() and KGlobal.deref() so that closing
the last mainwindow will quit the application unless there is still something
that holds a ref in KGlobal - like a KIO job, or a systray icon.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> KApplication
</dd></dl>
<dl class="author" compact><dt><b>Author:</b></dt><dd> 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 David Faure (faure@kde.org) </dd></dl>
</p>
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KMainWindow">__init__</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qwidget.html">QWidget</a> parent=0, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qt.html">Qt::WindowFlags</a> f=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#appHelpActivated">appHelpActivated</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#applyMainWindowSettings">applyMainWindowSettings</a> (self, <a href="../kdecore/KConfigGroup.html">KConfigGroup</a> config, bool forceGlobal=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KConfigGroup.html">KConfigGroup</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#autoSaveConfigGroup">autoSaveConfigGroup</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#autoSaveGroup">autoSaveGroup</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#autoSaveSettings">autoSaveSettings</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#canBeRestored">canBeRestored</a> (self, int number)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#classNameOfToplevel">classNameOfToplevel</a> (self, int number)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#closeEvent">closeEvent</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qcloseevent.html">QCloseEvent</a> a0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdeui/KMenu.html">KMenu</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#customHelpMenu">customHelpMenu</a> (self, bool showWhatsThis=1)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#dbusName">dbusName</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#event">event</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qevent.html">QEvent</a> event)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#hasMenuBar">hasMenuBar</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdeui/KMenu.html">KMenu</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#helpMenu">helpMenu</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> aboutAppText=QString(), bool showWhatsThis=1)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ignoreInitialGeometry">ignoreInitialGeometry</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#initialGeometrySet">initialGeometrySet</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">[<a href="../kdeui/KMainWindow.html">KMainWindow</a>] </td><td class="memItemRight" valign="bottom"><a class="el" href="#memberList">memberList</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdeui/KMenuBar.html">KMenuBar</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#menuBar">menuBar</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#parseGeometry">parseGeometry</a> (self, bool parsewidth)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#queryClose">queryClose</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#queryExit">queryExit</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#readGlobalProperties">readGlobalProperties</a> (self, <a href="../kdecore/KConfig.html">KConfig</a> sessionConfig)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#readProperties">readProperties</a> (self, <a href="../kdecore/KConfigGroup.html">KConfigGroup</a> a0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#readPropertiesInternal">readPropertiesInternal</a> (self, <a href="../kdecore/KConfig.html">KConfig</a> a0, int a1)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#resetAutoSaveSettings">resetAutoSaveSettings</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#restore">restore</a> (self, int number, bool show=1)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#restoreWindowSize">restoreWindowSize</a> (self, <a href="../kdecore/KConfigGroup.html">KConfigGroup</a> config)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#saveAutoSaveSettings">saveAutoSaveSettings</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#saveGlobalProperties">saveGlobalProperties</a> (self, <a href="../kdecore/KConfig.html">KConfig</a> sessionConfig)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#saveMainWindowSettings">saveMainWindowSettings</a> (self, <a href="../kdecore/KConfigGroup.html">KConfigGroup</a> config)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#saveProperties">saveProperties</a> (self, <a href="../kdecore/KConfigGroup.html">KConfigGroup</a> a0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#savePropertiesInternal">savePropertiesInternal</a> (self, <a href="../kdecore/KConfig.html">KConfig</a> a0, int a1)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#saveWindowSize">saveWindowSize</a> (self, <a href="../kdecore/KConfigGroup.html">KConfigGroup</a> config)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setAutoSaveSettings">setAutoSaveSettings</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> groupName=QLatin1String("MainWindow"), bool saveWindowSize=1)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setAutoSaveSettings">setAutoSaveSettings</a> (self, <a href="../kdecore/KConfigGroup.html">KConfigGroup</a> group, bool saveWindowSize=1)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setCaption">setCaption</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> caption)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setCaption">setCaption</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> caption, bool modified)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setPlainCaption">setPlainCaption</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> caption)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setSettingsDirty">setSettingsDirty</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#settingsDirty">settingsDirty</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#showAboutApplication">showAboutApplication</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdeui/KStatusBar.html">KStatusBar</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#statusBar">statusBar</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdeui/KToolBar.html">KToolBar</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#toolBar">toolBar</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> name=QString())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">[<a href="../kdeui/KToolBar.html">KToolBar</a>] </td><td class="memItemRight" valign="bottom"><a class="el" href="#toolBars">toolBars</a> (self)</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="KMainWindow"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qwidget.html">QWidget</a> </td>
<td class="paramname"><em>parent=0</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qt.html">Qt::WindowFlags</a> </td>
<td class="paramname"><em>f=0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Construct a main window.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>parent</em> </td><td> 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.
</td></tr>
<tr><td></td><td valign="top"><em>f</em> </td><td> Specify the window flags. The default is none.
</td></tr>
</table></dl>
<p> Note that a KMainWindow per-default is created with the
WA_DeleteOnClose attribute, i.e. it is automatically destroyed when the
window is closed. If you do not want this behavior, call
setAttribute(Qt.WA_DeleteOnClose, false);
</p>
<p>
KMainWindows must be created on the heap with 'new', like:
<pre class="fragment">
KMainWindow *kmw = new KMainWindow(...);
kmw->setObjectName(...);
</pre>
</p>
<p>
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#".
</p></div></div><a class="anchor" name="appHelpActivated"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> appHelpActivated</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Open the help page for the application.
</p>
<p>
The application name is
used as a key to determine what to display and the system will attempt
to open <appName>/index.html.
</p>
<p>
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.
</p>
<p>
Example (adding a help button to the first toolbar):
</p>
<p>
<pre class="fragment">
toolBar(0)->addAction(KIcon("help-contents"), i18n("Help"),
this, SLOT(appHelpActivated()));
</pre>
</p></div></div><a class="anchor" name="applyMainWindowSettings"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> applyMainWindowSettings</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KConfigGroup.html">KConfigGroup</a> </td>
<td class="paramname"><em>config</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>forceGlobal=0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Read settings for statusbar, menubar and toolbar from their respective
groups in the config file and apply them.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>config</em> </td><td> Config group to read the settings from.
<tr><td></td><td valign="top"><em>forceGlobal</em> </td><td> see the same argument in KToolBar.applySettings
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="autoSaveConfigGroup"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdecore/KConfigGroup.html">KConfigGroup</a> autoSaveConfigGroup</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> the group used for setting-autosaving.
Only meaningful if setAutoSaveSettings() was called.
This can be useful for forcing an apply, e.g. after using KEditToolbar.
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.1
</dd></dl>
</p></div></div><a class="anchor" name="autoSaveGroup"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> autoSaveGroup</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> the group used for setting-autosaving.
Only meaningful if setAutoSaveSettings(QString) was called.
This can be useful for forcing a save or an apply, e.g. before and after
using KEditToolbar.
</dd></dl> </p>
<p>
NOTE: you should rather use saveAutoSaveSettings() for saving or autoSaveConfigGroup() for loading.
This method doesn't make sense if setAutoSaveSettings(KConfigGroup) was called.
</p></div></div><a class="anchor" name="autoSaveSettings"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool autoSaveSettings</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> the current autosave setting, i.e. true if setAutoSaveSettings() was called,
false by default or if resetAutoSaveSettings() was called.
</dd></dl>
</p></div></div><a class="anchor" name="canBeRestored"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool canBeRestored</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>number</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>If the session did contain so high a number, <b>true</b> is returned,
else <b>false.</b>
<dl class="see" compact><dt><b>See also:</b></dt><dd> restore()
</dd></dl>
</p></div></div><a class="anchor" name="classNameOfToplevel"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> classNameOfToplevel</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>number</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Returns the className() of the <b>number</b> of the toplevel window which
should be restored.
</p>
<p>
This is only useful if your application uses
different kinds of toplevel windows.
</p></div></div><a class="anchor" name="closeEvent"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> closeEvent</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qcloseevent.html">QCloseEvent</a> </td>
<td class="paramname"><em>a0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Reimplemented to call the queryClose() and queryExit() handlers.
</p>
<p>
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.
</p></div></div><a class="anchor" name="customHelpMenu"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdeui/KMenu.html">KMenu</a> customHelpMenu</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>showWhatsThis=1</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Returns the help menu. Creates a standard help menu if none exists yet.
</p>
<p>
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.
</p>
<p>
Example (adding a help menu to your application):
<pre class="fragment">
menuBar()->addMenu( customHelpMenu() );
</pre>
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>showWhatsThis</em> </td><td> Set this to <b>false</b> if you do not want to include
the "What's This" menu entry.
</td></tr>
</table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> A standard help menu.
</dd></dl>
</p></div></div><a class="anchor" name="dbusName"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> dbusName</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns the path under which this window's D-Bus object is exported.
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.0.1
</dd></dl>
</p></div></div><a class="anchor" name="event"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool event</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qevent.html">QEvent</a> </td>
<td class="paramname"><em>event</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>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.
</p></div></div><a class="anchor" name="hasMenuBar"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool hasMenuBar</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns true, if there is a menubar
</p></div></div><a class="anchor" name="helpMenu"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdeui/KMenu.html">KMenu</a> helpMenu</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td>
<td class="paramname"><em>aboutAppText=QString()</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>showWhatsThis=1</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Retrieve the standard help menu.
</p>
<p>
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.
</p>
<p>
Example (adding a standard help menu to your application):
<pre class="fragment">
KMenu *help = helpMenu( <myTextString> );
menuBar()->addMenu( help );
</pre>
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>aboutAppText</em> </td><td> 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.
</td></tr>
<tr><td></td><td valign="top"><em>showWhatsThis</em> </td><td> Set this to false if you do not want to include
the "What's This" menu entry.
</td></tr>
</table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> A standard help menu.
</dd></dl>
</p></div></div><a class="anchor" name="ignoreInitialGeometry"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> ignoreInitialGeometry</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p><dl class="internal" compact><dt><b>Internal:</b></dt><dd>
Used from Konqueror when reusing the main window.
</dd></dl>
</p></div></div><a class="anchor" name="initialGeometrySet"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool initialGeometrySet</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> 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)
</dd></dl>
</p></div></div><a class="anchor" name="memberList"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">[<a href="../kdeui/KMainWindow.html">KMainWindow</a>] memberList</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>List of members of KMainWindow class.
</p></div></div><a class="anchor" name="menuBar"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdeui/KMenuBar.html">KMenuBar</a> menuBar</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns a pointer to the menu bar.
</p>
<p>
If there is no menu bar yet one will be created.
</p></div></div><a class="anchor" name="parseGeometry"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> parseGeometry</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>parsewidth</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="queryClose"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool queryClose</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Called before the window is closed, either by the user or indirectly by
the session manager.
</p>
<p>
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.
</p>
<p>
Default implementation returns true. Returning <b>false</b> will cancel
the closing, and, if KApplication.sessionSaving() is true, it will also
cancel KDE logout.
</p>
<p>
Reimplement this function to prevent the user from losing data.
Example:
<pre class="fragment">
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;
</pre>
</p>
<p>
Note that you should probably <b>not</b> 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.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> queryExit()
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> KApplication.sessionSaving()
</dd></dl>
</p></div></div><a class="anchor" name="queryExit"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool queryExit</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Called before the very last window is closed, either by the
user or indirectly by the session manager.
</p>
<p>
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).
</p>
<p>
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).
</p>
<p>
If you need to do serious things on exit (like shutting a
dial-up connection down), connect to the signal
QCoreApplication.aboutToQuit().
</p>
<p>
Default implementation returns <b>true.</b> Returning <b>false</b> will
cancel the exiting. In the latter case, the last window will
remain visible. If KApplication.sessionSaving() is true, refusing
the exit will also cancel KDE logout.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> queryClose()
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> KApplication.sessionSaving()
</dd></dl>
</p></div></div><a class="anchor" name="readGlobalProperties"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> readGlobalProperties</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KConfig.html">KConfig</a> </td>
<td class="paramname"><em>sessionConfig</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>The counterpart of saveGlobalProperties().
</p>
<p>
Read the application-specific properties in again.
</p></div></div><a class="anchor" name="readProperties"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> readProperties</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KConfigGroup.html">KConfigGroup</a> </td>
<td class="paramname"><em>a0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Read your instance-specific properties.
</p>
<p>
Is called indirectly by restore().
</p></div></div><a class="anchor" name="readPropertiesInternal"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool readPropertiesInternal</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KConfig.html">KConfig</a> </td>
<td class="paramname"><em>a0</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>a1</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="resetAutoSaveSettings"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> resetAutoSaveSettings</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Disable the auto-save-settings feature.
You don't normally need to call this, ever.
</p></div></div><a class="anchor" name="restore"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool restore</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>number</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>show=1</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Try to restore the toplevel widget as defined by <b>number</b> (1..X).
</p>
<p>
You should call canBeRestored() first.
</p>
<p>
If the session did not contain so high a number, the configuration
is not changed and <b>false</b> returned.
</p>
<p>
That means clients could simply do the following:
<pre class="fragment">
if (qApp->isSessionRestored()){
int n = 1;
while (KMainWindow.canBeRestored(n)){
(new childMW)->restore(n);
n++;
}
} else {
// create default application as usual
}
</pre>
Note that if <b>show</b> is true (default), QWidget.show() is called
implicitly in restore.
</p>
<p>
With this you can easily restore all toplevel windows of your
application.
</p>
<p>
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.
</p>
<p>
<i>Note that you don't need to deal with this function. Use the
kRestoreMainWindows() convenience template function instead!</i>
<dl class="see" compact><dt><b>See also:</b></dt><dd> kRestoreMainWindows()
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> #RESTORE
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> readProperties()
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> canBeRestored()
</dd></dl>
</p></div></div><a class="anchor" name="restoreWindowSize"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> restoreWindowSize</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KConfigGroup.html">KConfigGroup</a> </td>
<td class="paramname"><em>config</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>For inherited classes
Note that a -geometry on the command line has priority.
</p></div></div><a class="anchor" name="saveAutoSaveSettings"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> saveAutoSaveSettings</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>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.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> setAutoSaveSettings
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> setSettingsDirty
</dd></dl> </p>
<p>
Example:
<pre class="fragment">
void MyMainWindow.closeEvent( QCloseEvent *e )
{
// Save settings if auto-save is enabled, and settings have changed
if ( settingsDirty() && autoSaveSettings() )
saveAutoSaveSettings();
..
}
</pre>
</p></div></div><a class="anchor" name="saveGlobalProperties"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> saveGlobalProperties</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KConfig.html">KConfig</a> </td>
<td class="paramname"><em>sessionConfig</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Save your application-wide properties. The function is
invoked when the session manager requests your application
to save its state.
</p>
<p>
This function is similar to saveProperties() but is only called for
the very first main window, regardless how many main window are open.
</p>
<p>
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.
</p>
<p>
Default implementation does nothing.
</p></div></div><a class="anchor" name="saveMainWindowSettings"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> saveMainWindowSettings</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KConfigGroup.html">KConfigGroup</a> </td>
<td class="paramname"><em>config</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Save settings for statusbar, menubar and toolbar to their respective
groups in the config group <b>config.</b>
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>config</em> </td><td> Config group to save the settings to.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="saveProperties"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> saveProperties</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KConfigGroup.html">KConfigGroup</a> </td>
<td class="paramname"><em>a0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Save your instance-specific properties. The function is
invoked when the session manager requests your application
to save its state.
</p>
<p>
Please reimplement these function in childclasses.
</p>
<p>
Note: No user interaction is allowed
in this function!
</p></div></div><a class="anchor" name="savePropertiesInternal"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> savePropertiesInternal</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KConfig.html">KConfig</a> </td>
<td class="paramname"><em>a0</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>a1</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="saveWindowSize"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> saveWindowSize</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KConfigGroup.html">KConfigGroup</a> </td>
<td class="paramname"><em>config</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>For inherited classes
</p></div></div><a class="anchor" name="setAutoSaveSettings"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setAutoSaveSettings</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td>
<td class="paramname"><em>groupName=QLatin1String("MainWindow")</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>saveWindowSize=1</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Overload that lets you specify a KConfigGroup.
This allows the settings to be saved into another file than KGlobal.config().
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.1
</dd></dl>
</p></div></div><a class="anchor" name="setAutoSaveSettings"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setAutoSaveSettings</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KConfigGroup.html">KConfigGroup</a> </td>
<td class="paramname"><em>group</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>saveWindowSize=1</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Overload that lets you specify a KConfigGroup.
This allows the settings to be saved into another file than KGlobal.config().
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.1
</dd></dl>
</p></div></div><a class="anchor" name="setCaption"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setCaption</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td>
<td class="paramname"><em>caption</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Makes a KDE compliant caption.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>caption</em> </td><td> Your caption. <b>Do</b> <b>not</b> include the application name
in this string. It will be added automatically according to the KDE
standard.
<tr><td></td><td valign="top"><em>modified</em> </td><td> Specify whether the document is modified. This displays
an additional sign in the title bar, usually "**".
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setCaption"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setCaption</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td>
<td class="paramname"><em>caption</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>modified</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Makes a KDE compliant caption.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>caption</em> </td><td> Your caption. <b>Do</b> <b>not</b> include the application name
in this string. It will be added automatically according to the KDE
standard.
<tr><td></td><td valign="top"><em>modified</em> </td><td> Specify whether the document is modified. This displays
an additional sign in the title bar, usually "**".
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setPlainCaption"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setPlainCaption</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td>
<td class="paramname"><em>caption</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Make a plain caption without any modifications.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>caption</em> </td><td> Your caption. This is the string that will be
displayed in the window title.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setSettingsDirty"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setSettingsDirty</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>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.
</p></div></div><a class="anchor" name="settingsDirty"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool settingsDirty</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>For inherited classes
</p></div></div><a class="anchor" name="showAboutApplication"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> showAboutApplication</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>This slot does nothing.
</p>
<p>
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.
</p>
<p>
Example:
<pre class="fragment">
void MyMainLevel.setupInterface()
{
..
menuBar()->addMenu( customHelpMenu() );
..
}
void MyMainLevel.showAboutApplication()
{
<activate your custom dialog>
}
</pre>
</p></div></div><a class="anchor" name="statusBar"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdeui/KStatusBar.html">KStatusBar</a> statusBar</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns a pointer to the status bar.
</p>
<p>
If there is no status bar yet, one will be created.
</p>
<p>
Note that tooltips for kactions in actionCollection() are not
automatically connected to this statusBar.
See the KActionCollection documentation for more details.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> KActionCollection
</dd></dl>
</p></div></div><a class="anchor" name="toolBar"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdeui/KToolBar.html">KToolBar</a> toolBar</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td>
<td class="paramname"><em>name=QString()</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>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.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>name</em> </td><td> The internal name of the toolbar. If no name is
specified "mainToolBar" is assumed.
</td></tr>
</table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> A pointer to the toolbar
</dd></dl>
</p></div></div><a class="anchor" name="toolBars"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">[<a href="../kdeui/KToolBar.html">KToolBar</a>] toolBars</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> A list of all toolbars for this window
</dd></dl>
</p></div></div>
</div>
</div>
</div>
<div id="left">
<div class="menu_box">
<div class="nav_list">
<ul>
<li><a href="../allclasses.html">Full Index</a></li>
</ul>
</div>
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">Modules</h2>
</div></div>
<div class="nav_list">
<ul><li><a href="../akonadi/index.html">akonadi</a></li>
<li><a href="../dnssd/index.html">dnssd</a></li>
<li><a href="../kdecore/index.html">kdecore</a></li>
<li><a href="../kdeui/index.html">kdeui</a></li>
<li><a href="../khtml/index.html">khtml</a></li>
<li><a href="../kio/index.html">kio</a></li>
<li><a href="../knewstuff/index.html">knewstuff</a></li>
<li><a href="../kparts/index.html">kparts</a></li>
<li><a href="../kutils/index.html">kutils</a></li>
<li><a href="../nepomuk/index.html">nepomuk</a></li>
<li><a href="../phonon/index.html">phonon</a></li>
<li><a href="../plasma/index.html">plasma</a></li>
<li><a href="../polkitqt/index.html">polkitqt</a></li>
<li><a href="../solid/index.html">solid</a></li>
<li><a href="../soprano/index.html">soprano</a></li>
</ul></div></div>
</div>
</div>
<div class="clearer"/>
</div>
<div id="end_body"></div>
</div>
<div id="footer"><div id="footer_text">
This documentation is maintained by <a href="mailto:simon@simonzone.com">Simon Edwards</a>.<br />
KDE<sup>®</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>®</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div></div>
</body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
b77dda48f87d4eda8cc559e40c49a652
>
files
>
455
