<?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>KApplication</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.9 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>KApplication Class Reference</h1> <code>from PyKDE4.kdeui import *</code> <p> Inherits: QApplication → QCoreApplication → QObject<br /> Subclasses: <a href="../kdeui/KUniqueApplication.html">KUniqueApplication</a><br /> <h2>Detailed Description</h2> <p>Controls and provides information to all KDE applications. </p> <p> Only one object of this class can be instantiated in a single app. This instance is always accessible via the 'KApplication.kApplication()' global variable. </p> <p> This class provides the following services to all KDE applications. </p> <p> <li> It controls the event queue (see QApplication ). </li> <li> It provides the application with KDE resources such as </li> accelerators, common menu entries, a KConfig object. session management events, help invocation etc. <li> Installs an empty signal handler for the SIGPIPE signal. </li> If you want to catch this signal yourself, you have set a new signal handler after KApplication's constructor has run. <li> It can start new services </li> </p> <p> Controls and provides information to all KDE applications. <dl class="author" compact><dt><b>Author:</b></dt><dd> Matthias Kalle Dalheimer <kalle@kde.org> </dd></dl> </p> <table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Attributes</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#varloadedByKdeinit">loadedByKdeinit</a></td></tr><tr><td colspan="2"><br><h2>Signals</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#saveYourself">saveYourself</a> ()</td></tr> <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="#KApplication">__init__</a> (self, bool GUIenabled=1)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KApplication">__init__</a> (self, Display display, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qt.html">Qt::HANDLE</a> visual=0, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qt.html">Qt::HANDLE</a> colormap=0)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KApplication">__init__</a> (self, Display display, SIP_PYLIST list, QByteArray rAppName, bool GUIenabled=1)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KApplication">__init__</a> (self, bool GUIenabled, <a href="../kdecore/KComponentData.html">KComponentData</a> cData)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KApplication">__init__</a> (self, Display display, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qt.html">Qt::HANDLE</a> visual, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qt.html">Qt::HANDLE</a> colormap, <a href="../kdecore/KComponentData.html">KComponentData</a> cData)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KApplication">__init__</a> (self, <a href="../kdeui/KApplication.html">KApplication</a> a0)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KApplication">__init__</a> (self, bool a0, bool a1)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#clearStartupId">clearStartupId</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#commitData">commitData</a> (self, QSessionManager sm)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#disableSessionManagement">disableSessionManagement</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#enableSessionManagement">enableSessionManagement</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#installX11EventFilter">installX11EventFilter</a> (self, QWidget filter)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#notify">notify</a> (self, QObject receiver, QEvent event)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#quit">quit</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#removeX11EventFilter">removeX11EventFilter</a> (self, QWidget filter)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#reparseConfiguration">reparseConfiguration</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#saveState">saveState</a> (self, QSessionManager sm)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KConfig.html">KConfig</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#sessionConfig">sessionConfig</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#sessionSaving">sessionSaving</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setStartupId">setStartupId</a> (self, QByteArray startup_id)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setSynchronizeClipboard">setSynchronizeClipboard</a> (self, bool synchronize)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setTopWidget">setTopWidget</a> (self, QWidget topWidget)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QByteArray </td><td class="memItemRight" valign="bottom"><a class="el" href="#startupId">startupId</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#updateRemoteUserTimestamp">updateRemoteUserTimestamp</a> (self, QString service, int time=0)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#updateUserTimestamp">updateUserTimestamp</a> (self, int time=0)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="#userTimestamp">userTimestamp</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#xioErrhandler">xioErrhandler</a> (self, Display a0)</td></tr> <tr><td colspan="2"><br><h2>Static Methods</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QString, bool bRecover </td><td class="memItemRight" valign="bottom"><a class="el" href="#checkRecoverFile">checkRecoverFile</a> (QString pFilename)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdeui/KApplication.html">KApplication</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#kApplication">kApplication</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#tempSaveName">tempSaveName</a> (QString pFilename)</td></tr> </table> <hr><h2>Signal Documentation</h2><a class="anchor" name="saveYourself"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> saveYourself</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname">)</td> <td width="100%"> </td> </tr> </table> </div> <div class="memdoc"><p>Session management asks you to save the state of your application. </p> <p> This signal is provided for compatibility only. For new applications, simply use KMainWindow. By reimplementing KMainWindow.queryClose(), KMainWindow.saveProperties() and KMainWindow.readProperties() you can simply handle session management for applications with multiple toplevel windows. </p> <p> For purposes without KMainWindow, create an instance of KSessionManager and reimplement the functions KSessionManager.commitData() and/or KSessionManager.saveState() </p> <p> If you still want to use this signal, here is what you should do: </p> <p> Connect to this signal in order to save your data. Do NOT manipulate the UI in that slot, it is blocked by the session manager. </p> <p> Use the sessionConfig() KConfig object to store all your instance specific data. </p> <p> Do not do any closing at this point! The user may still select Cancel wanting to continue working with your application. Cleanups could be done after aboutToQuit(). </p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("saveYourself()"), target_slot)</code></dd></dl></div></div><hr><h2>Method Documentation</h2><a class="anchor" name="KApplication"></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">bool </td> <td class="paramname"><em>GUIenabled=1</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>This constructor is the one you should use. It takes aboutData and command line arguments from KCmdLineArgs. </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>GUIenabled</em> </td><td> Set to false to disable all GUI stuff. Note that for a non-GUI daemon, you might want to use QCoreApplication and a KComponentData instance instead. You'll save an unnecessary dependency to kdeui. The main difference is that you will have to do a number of things yourself: <ul> <li>Register to DBus, if necessary.</li> <li>Call KGlobal.locale(), if using multiple threads.</li> </ul> </td></tr> </table></dl> <p> </p></div></div><a class="anchor" name="KApplication"></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">Display </td> <td class="paramname"><em>display</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::HANDLE</a> </td> <td class="paramname"><em>visual=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::HANDLE</a> </td> <td class="paramname"><em>colormap=0</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Constructor. Parses command-line arguments. Use this constructor when you you need to use a non-default visual or colormap. </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>display</em> </td><td> Will be passed to Qt as the X display. The display must be valid and already opened. </td></tr> <tr><td></td><td valign="top"><em>visual</em> </td><td> A pointer to the X11 visual that should be used by the application. Note that only TrueColor visuals are supported on depths greater than 8 bpp. If this parameter is NULL, the default visual will be used instead. </td></tr> <tr><td></td><td valign="top"><em>colormap</em> </td><td> The colormap that should be used by the application. If this parameter is 0, the default colormap will be used instead. </td></tr> </table></dl> <p> </p></div></div><a class="anchor" name="KApplication"></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">Display </td> <td class="paramname"><em>display</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">SIP_PYLIST </td> <td class="paramname"><em>list</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">QByteArray </td> <td class="paramname"><em>rAppName</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"><em>GUIenabled=1</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="KApplication"></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">bool </td> <td class="paramname"><em>GUIenabled</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../kdecore/KComponentData.html">KComponentData</a> </td> <td class="paramname"><em>cData</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> Used by KUniqueApplication </dd></dl> </p></div></div><a class="anchor" name="KApplication"></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">Display </td> <td class="paramname"><em>display</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::HANDLE</a> </td> <td class="paramname"><em>visual</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::HANDLE</a> </td> <td class="paramname"><em>colormap</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../kdecore/KComponentData.html">KComponentData</a> </td> <td class="paramname"><em>cData</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> Used by KUniqueApplication </dd></dl> </p></div></div><a class="anchor" name="KApplication"></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="../kdeui/KApplication.html">KApplication</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"></div></div><a class="anchor" name="KApplication"></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">bool </td> <td class="paramname"><em>a0</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">bool </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="clearStartupId"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> clearStartupId</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 only by KStartupId. </dd></dl> </p></div></div><a class="anchor" name="commitData"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> commitData</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">QSessionManager </td> <td class="paramname"><em>sm</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Reimplemented for internal purposes, mainly the highlevel handling of session management with KSessionManager. <dl class="internal" compact><dt><b>Internal:</b></dt><dd> </dd></dl> </p></div></div><a class="anchor" name="disableSessionManagement"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> disableSessionManagement</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>Disables session management for this application. </p> <p> Useful in case your application is started by the initial "startkde" script. </p></div></div><a class="anchor" name="enableSessionManagement"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> enableSessionManagement</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>Enables session management for this application, formerly disabled by calling disableSessionManagement(). You usually shouldn't call this function, as session management is enabled by default. </p></div></div><a class="anchor" name="installX11EventFilter"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> installX11EventFilter</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">QWidget </td> <td class="paramname"><em>filter</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Installs widget filter as global X11 event filter. </p> <p> The widget filter receives XEvents in its standard QWidget.x11Event() function. </p> <p> Warning: Only do this when absolutely necessary. An installed X11 filter can slow things down. </p></div></div><a class="anchor" name="notify"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">bool notify</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">QObject </td> <td class="paramname"><em>receiver</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">QEvent </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><dl class="internal" compact><dt><b>Internal:</b></dt><dd> </dd></dl> </p></div></div><a class="anchor" name="quit"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> quit</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname"><em>self</em> )</td> <td width="100%"> </td> </tr> </table> </div> <div class="memdoc"></div></div><a class="anchor" name="removeX11EventFilter"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> removeX11EventFilter</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">QWidget </td> <td class="paramname"><em>filter</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Removes global X11 event filter previously installed by installX11EventFilter(). </p></div></div><a class="anchor" name="reparseConfiguration"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> reparseConfiguration</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname"><em>self</em> )</td> <td width="100%"> </td> </tr> </table> </div> <div class="memdoc"></div></div><a class="anchor" name="saveState"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> saveState</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">QSessionManager </td> <td class="paramname"><em>sm</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Reimplemented for internal purposes, mainly the highlevel handling of session management with KSessionManager. <dl class="internal" compact><dt><b>Internal:</b></dt><dd> </dd></dl> </p></div></div><a class="anchor" name="sessionConfig"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../kdecore/KConfig.html">KConfig</a> sessionConfig</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 application session config object. </p> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> A pointer to the application's instance specific KConfig object. </dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> KConfig </dd></dl> </p></div></div><a class="anchor" name="sessionSaving"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">bool sessionSaving</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 the application is currently saving its session data (most probably before KDE logout). This is intended for use mainly in KMainWindow.queryClose() and KMainWindow.queryExit(). </p> <p> <dl class="see" compact><dt><b>See also:</b></dt><dd> KMainWindow.queryClose </dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> KMainWindow.queryExit </dd></dl> </p></div></div><a class="anchor" name="setStartupId"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> setStartupId</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">QByteArray </td> <td class="paramname"><em>startup_id</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> Sets a new value for the application startup notification window property for newly created toplevel windows. </dd></dl> </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>startup_id</em> </td><td> the startup notification identifier </td></tr> </table></dl> <p> <dl class="see" compact><dt><b>See also:</b></dt><dd> KStartupInfo.setNewStartupId </dd></dl> </p></div></div><a class="anchor" name="setSynchronizeClipboard"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> setSynchronizeClipboard</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>synchronize</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Sets how the primary and clipboard selections are synchronized in an X11 environment </p></div></div><a class="anchor" name="setTopWidget"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> setTopWidget</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">QWidget </td> <td class="paramname"><em>topWidget</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Sets the top widget of the application. This means basically applying the right window caption. An application may have several top widgets. You don't need to call this function manually when using KMainWindow. </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>topWidget</em> </td><td> A top widget of the application. </td></tr> </table></dl> <p> <dl class="see" compact><dt><b>See also:</b></dt><dd> icon(), caption() </dd></dl> </p></div></div><a class="anchor" name="startupId"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QByteArray startupId</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 app startup notification identifier for this running application. <dl class="return" compact><dt><b>Returns:</b></dt><dd> the startup notification identifier </dd></dl> </p></div></div><a class="anchor" name="updateRemoteUserTimestamp"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> updateRemoteUserTimestamp</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">QString </td> <td class="paramname"><em>service</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>time=0</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Updates the last user action timestamp in the application registered to DBUS with id service to the given time, or to this application's user time, if 0 is given. Use before causing user interaction in the remote application, e.g. invoking a dialog in the application using a DCOP call. Consult focus stealing prevention section in kdebase/kwin/README. </p></div></div><a class="anchor" name="updateUserTimestamp"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> updateUserTimestamp</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>time=0</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Updates the last user action timestamp to the given time, or to the current time, if 0 is given. Do not use unless you're really sure what you're doing. Consult focus stealing prevention section in kdebase/kwin/README. </p></div></div><a class="anchor" name="userTimestamp"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">long userTimestamp</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 last user action timestamp or 0 if no user activity has taken place yet. <dl class="see" compact><dt><b>See also:</b></dt><dd> updateuserTimestamp </dd></dl> </p></div></div><a class="anchor" name="xioErrhandler"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">int xioErrhandler</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">Display </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><dl class="internal" compact><dt><b>Internal:</b></dt><dd> </dd></dl> </p></div></div><hr><h2>Static Method Documentation</h2><a class="anchor" name="checkRecoverFile"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QString, bool bRecover checkRecoverFile</td> <td>(</td> <td class="paramtype">QString </td> <td class="paramname"><em>pFilename</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Check whether an auto-save file exists for the document you want to open. </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>pFilename</em> </td><td> The full path to the document you want to open. <tr><td></td><td valign="top"><em>bRecover</em> </td><td> This gets set to true if there was a recover file. </td></tr> </table></dl> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> The full path of the file to open. </dd></dl> </p></div></div><a class="anchor" name="kApplication"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../kdeui/KApplication.html">KApplication</a> kApplication</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname">)</td> <td width="100%"> </td> </tr> </table> </div> <div class="memdoc"><p>Returns the current application object. </p> <p> This is similar to the global QApplication pointer qApp. It allows access to the single global KApplication object, since more than one cannot be created in the same application. It saves you the trouble of having to pass the pointer explicitly to every function that may require it. <dl class="return" compact><dt><b>Returns:</b></dt><dd> the current application object </dd></dl> </p></div></div><a class="anchor" name="tempSaveName"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QString tempSaveName</td> <td>(</td> <td class="paramtype">QString </td> <td class="paramname"><em>pFilename</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Get a file name in order to make a temporary copy of your document. </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>pFilename</em> </td><td> The full path to the current file of your document. </td></tr> </table></dl> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> A new filename for auto-saving. </dd></dl> <dl class="deprecated" compact><dt><b>Deprecated:</b></dt><dd> use KTemporaryFile, KSaveFile or KAutoSaveFile instead </dd></dl> </p></div></div><hr><h2>Attribute Documentation</h2><a class="anchor" name="varloadedByKdeinit"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr><td class="memname">bool loadedByKdeinit</td> </tr> </table> </div> <div class="memdoc"></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="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>