Sophie

Sophie

distrib > Mandriva > current > i586 > media > main-updates > by-pkgid > b77dda48f87d4eda8cc559e40c49a652 > files > 575

python-kde4-doc-4.4.5-0.2mdv2010.2.i586.rpm

<?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>KXmlGuiWindow</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">&nbsp;</div>

<h1>KXmlGuiWindow Class Reference</h1>
<code>from PyKDE4.kdeui import *</code>
<p>
Inherits: <a href="../kdeui/KMainWindow.html">KMainWindow</a> &#x2192; <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qmainwindow.html">QMainWindow</a> &#x2192; <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qwidget.html">QWidget</a> &#x2192; <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qobject.html">QObject</a>,<a href="../kdeui/KXMLGUIBuilder.html">KXMLGUIBuilder</a>,<a href="../kdeui/KXMLGUIClient.html">KXMLGUIClient</a><br />


<h2>Detailed Description</h2>

<p>KDE top level main window with predefined action layout
</p>
<p>
Instead of creating a KMainWindow manually and assigning menus, menu entries,
toolbar buttons and actions to it by hand, this class can be used to load an
rc file to manage the main window's actions.
</p>
<p>
See http://techbase.kde.org/Development/Tutorials/Using_KActions#XMLGUI
for essential information on the XML file format and usage of this class.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> KMainWindow
</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 Sven Radej (radej@kde.org) </dd></dl>
</p>
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#StandardWindowOption">StandardWindowOption</a>&nbsp;</td><td class="memItemRight" valign="bottom">{&nbsp;ToolBar, Keys, StatusBar, Save, Create, Default&nbsp;}</td></tr>
<tr><td colspan="2"><br><h2>Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#KXmlGuiWindow">__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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#applyMainWindowSettings">applyMainWindowSettings</a> (self, <a href="../kdecore/KConfigGroup.html">KConfigGroup</a> config, bool force=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#configureToolbars">configureToolbars</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#createGUI">createGUI</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> xmlfile=QString())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#createStandardStatusBarAction">createStandardStatusBarAction</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#finalizeGUI">finalizeGUI</a> (self, <a href="../kdeui/KXMLGUIClient.html">KXMLGUIClient</a> client)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#finalizeGUI">finalizeGUI</a> (self, bool force)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdeui/KXMLGUIFactory.html">KXMLGUIFactory</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#guiFactory">guiFactory</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#isHelpMenuEnabled">isHelpMenuEnabled</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#isStandardToolBarMenuEnabled">isStandardToolBarMenuEnabled</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#saveNewToolbarConfig">saveNewToolbarConfig</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#setHelpMenuEnabled">setHelpMenuEnabled</a> (self, bool showHelpMenu=1)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#setStandardToolBarMenuEnabled">setStandardToolBarMenuEnabled</a> (self, bool enable)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#setupGUI">setupGUI</a> (self, <a href="../kdeui/KXmlGuiWindow.StandardWindowOptions.html">KXmlGuiWindow.StandardWindowOptions</a> options=KXmlGuiWindow.Default, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> xmlfile=QString())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#setupGUI">setupGUI</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qsize.html">QSize</a> defaultSize, <a href="../kdeui/KXmlGuiWindow.StandardWindowOptions.html">KXmlGuiWindow.StandardWindowOptions</a> options=KXmlGuiWindow.Default, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> xmlfile=QString())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#setupToolbarMenuActions">setupToolbarMenuActions</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#slotStateChanged">slotStateChanged</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> newstate)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#slotStateChanged">slotStateChanged</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> newstate, bool reverse)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qaction.html">QAction</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#toolBarMenuAction">toolBarMenuAction</a> (self)</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="KXmlGuiWindow"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype">&nbsp;<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>&nbsp;</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>&nbsp;</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>&nbsp;</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>&nbsp;</td><td> Specify the widget flags. The default is
Qt.Window and Qt.WA_DeleteOnClose. Qt.Window indicates that a
main window is a toplevel window, regardless of whether it has a
parent or not. Qt.WA_DeleteOnClose indicates that a main window is
automatically destroyed when its window is closed. Pass 0 if
you do not want this behavior.
</td></tr>
</table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> http://doc.trolltech.com/qt.html#WindowType-enum
</dd></dl> </p>
<p>
KMainWindows must be created on the heap with 'new', like:
<pre class="fragment">
 KMainWindow *kmw = new KMainWindow(...);
 kmw-&gt;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="applyMainWindowSettings"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> applyMainWindowSettings</td>
<td>(</td>
<td class="paramtype">&nbsp;<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>&nbsp;</td>
<td class="paramname"><em>config</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"><em>force=0</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="configureToolbars"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> configureToolbars</td>
<td>(</td>
<td class="paramtype">&nbsp;</td>
<td class="paramname"><em>self</em>&nbsp;)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Show a standard configure toolbar dialog.
</p>
<p>
This slot can be connected directly to the action to configure toolbar.
This is very simple to do that by adding a single line
<pre class="fragment">
 KStandardAction.configureToolbars( this, SLOT( configureToolbars() ),
                                actionCollection() );
</pre>
</p></div></div><a class="anchor" name="createGUI"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> createGUI</td>
<td>(</td>
<td class="paramtype">&nbsp;<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>&nbsp;</td>
<td class="paramname"><em>xmlfile=QString()</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Create a GUI given a local XML file.
</p>
<p>
If <b>xmlfile</b> is NULL,
then it will try to construct a local XML filename like
appnameui.rc where 'appname' is your app's name. If that file
does not exist, then the XML UI code will only use the global
(standard) XML file for the layout purposes.
</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>xmlfile</em>&nbsp;</td><td> The local xmlfile (relative or absolute)
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="createStandardStatusBarAction"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> createStandardStatusBarAction</td>
<td>(</td>
<td class="paramtype">&nbsp;</td>
<td class="paramname"><em>self</em>&nbsp;)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Sets whether KMainWindow should provide a menu that allows showing/hiding
of the statusbar ( using KToggleStatusBarAction ).
</p>
<p>
The menu / menu item is implemented using xmlgui. It will be inserted
in your menu structure in the 'Settings' menu.
</p>
<p>
Note that you should enable this feature before calling createGUI()
( or similar ).
</p>
<p>
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.
</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">&nbsp;<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>&nbsp;</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="finalizeGUI"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> finalizeGUI</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdeui/KXMLGUIClient.html">KXMLGUIClient</a>&nbsp;</td>
<td class="paramname"><em>client</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p><dl class="internal" compact><dt><b>Internal:</b></dt><dd>
</dd></dl>
</p></div></div><a class="anchor" name="finalizeGUI"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> finalizeGUI</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"><em>force</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p><dl class="internal" compact><dt><b>Internal:</b></dt><dd>
</dd></dl>
</p></div></div><a class="anchor" name="guiFactory"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdeui/KXMLGUIFactory.html">KXMLGUIFactory</a> guiFactory</td>
<td>(</td>
<td class="paramtype">&nbsp;</td>
<td class="paramname"><em>self</em>&nbsp;)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="isHelpMenuEnabled"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool isHelpMenuEnabled</td>
<td>(</td>
<td class="paramtype">&nbsp;</td>
<td class="paramname"><em>self</em>&nbsp;)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Return <b>true</b> when the help menu is enabled
</p></div></div><a class="anchor" name="isStandardToolBarMenuEnabled"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool isStandardToolBarMenuEnabled</td>
<td>(</td>
<td class="paramtype">&nbsp;</td>
<td class="paramname"><em>self</em>&nbsp;)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="saveNewToolbarConfig"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> saveNewToolbarConfig</td>
<td>(</td>
<td class="paramtype">&nbsp;</td>
<td class="paramname"><em>self</em>&nbsp;)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Rebuilds the GUI after KEditToolbar changed the toolbar layout.
<dl class="see" compact><dt><b>See also:</b></dt><dd> configureToolbars()
</dd></dl>
</p></div></div><a class="anchor" name="setHelpMenuEnabled"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setHelpMenuEnabled</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"><em>showHelpMenu=1</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Enables the build of a standard help menu when calling createGUI().
</p>
<p>
The default behavior is to build one, you must call this function
to disable it
</p></div></div><a class="anchor" name="setStandardToolBarMenuEnabled"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setStandardToolBarMenuEnabled</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"><em>enable</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>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 &lt;toolbar name here&gt;' menu item
is shown.
</p>
<p>
The menu / menu item is implemented using xmlgui. It will be inserted in your
menu structure in the 'Settings' menu.
</p>
<p>
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
&amp;lt;Merge name="StandardToolBarMenuHandler" /&amp;gt;
line to the settings menu section of your resource file ( usually appname.rc ).
</p>
<p>
Note that you should enable this feature before calling createGUI() ( or similar ) .
</p></div></div><a class="anchor" name="setupGUI"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setupGUI</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdeui/KXmlGuiWindow.StandardWindowOptions.html">KXmlGuiWindow.StandardWindowOptions</a>&nbsp;</td>
<td class="paramname"><em>options=KXmlGuiWindow.Default</em>, </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>&nbsp;</td>
<td class="paramname"><em>xmlfile=QString()</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>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.
</p>
<p>
<b>defaultSize</b> The default size of the window
</p>
<p>
Typically this function replaces createGUI().
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> StandardWindowOptions
</dd></dl> <dl class="note" compact><dt><b>Note:</b></dt><dd> Since this method will restore the state of the application (toolbar, dockwindows
positions...), you need to have added all your actions to your toolbars etc before
calling to this method. (This note is only applicable if you are using the Default or
Save flag).
</dd></dl> <dl class="warning" compact><dt><b>Warning:</b></dt><dd> If you are calling createGUI yourself, remember to remove the Create flag from
the <b>options</b> parameter. Also, call setupGUI always after you call createGUI.
</dd></dl>
</p></div></div><a class="anchor" name="setupGUI"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setupGUI</td>
<td>(</td>
<td class="paramtype">&nbsp;<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/qsize.html">QSize</a>&nbsp;</td>
<td class="paramname"><em>defaultSize</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdeui/KXmlGuiWindow.StandardWindowOptions.html">KXmlGuiWindow.StandardWindowOptions</a>&nbsp;</td>
<td class="paramname"><em>options=KXmlGuiWindow.Default</em>, </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>&nbsp;</td>
<td class="paramname"><em>xmlfile=QString()</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>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.
</p>
<p>
<b>defaultSize</b> The default size of the window
</p>
<p>
Typically this function replaces createGUI().
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> StandardWindowOptions
</dd></dl> <dl class="note" compact><dt><b>Note:</b></dt><dd> Since this method will restore the state of the application (toolbar, dockwindows
positions...), you need to have added all your actions to your toolbars etc before
calling to this method. (This note is only applicable if you are using the Default or
Save flag).
</dd></dl> <dl class="warning" compact><dt><b>Warning:</b></dt><dd> If you are calling createGUI yourself, remember to remove the Create flag from
the <b>options</b> parameter. Also, call setupGUI always after you call createGUI.
</dd></dl>
</p></div></div><a class="anchor" name="setupToolbarMenuActions"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setupToolbarMenuActions</td>
<td>(</td>
<td class="paramtype">&nbsp;</td>
<td class="paramname"><em>self</em>&nbsp;)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p><dl class="internal" compact><dt><b>Internal:</b></dt><dd> for KToolBar
</dd></dl>
</p></div></div><a class="anchor" name="slotStateChanged"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> slotStateChanged</td>
<td>(</td>
<td class="paramtype">&nbsp;<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>&nbsp;</td>
<td class="paramname"><em>newstate</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Apply a state change
</p>
<p>
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.
</p></div></div><a class="anchor" name="slotStateChanged"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> slotStateChanged</td>
<td>(</td>
<td class="paramtype">&nbsp;<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>&nbsp;</td>
<td class="paramname"><em>newstate</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"><em>reverse</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Apply a state change
</p>
<p>
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.
</p></div></div><a class="anchor" name="toolBarMenuAction"></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/qaction.html">QAction</a> toolBarMenuAction</td>
<td>(</td>
<td class="paramtype">&nbsp;</td>
<td class="paramname"><em>self</em>&nbsp;)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns a pointer to the mainwindows action responsible for the toolbars menu
</p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="StandardWindowOption"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">StandardWindowOption</td>
</tr>
</table>
</div>
<div class="memdoc"><p><dl class="see" compact><dt><b>See also:</b></dt><dd> setupGUI()
</dd></dl>
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>ToolBar</em>&nbsp;=&nbsp;1</td><td><tr><td valign="top"><em>Keys</em>&nbsp;=&nbsp;2</td><td><tr><td valign="top"><em>StatusBar</em>&nbsp;=&nbsp;4</td><td><tr><td valign="top"><em>Save</em>&nbsp;=&nbsp;8</td><td><tr><td valign="top"><em>Create</em>&nbsp;=&nbsp;16</td><td><tr><td valign="top"><em>Default</em>&nbsp;=&nbsp;ToolBar|Keys|StatusBar|Save|Create</td><td></table>
</dl>
</div></div><p>
</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="&#109;&#97;&#105;&#108;&#116;&#111;&#58;simon&#64;simonzone&#46;com">Simon Edwards</a>.<br />
        KDE<sup>&#174;</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>&#174;</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>