Sophie

Sophie

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

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>KHelpMenu</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>KHelpMenu Class Reference</h1>
<code>from PyKDE4.kdeui import *</code>
<p>
Inherits: <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qobject.html">QObject</a><br />


<h2>Detailed Description</h2>

<p>Standard KDE help menu with dialog boxes.
</p>
<p>
This class provides the standard KDE help menu with the default "about"
dialog boxes and help entry.
</p>
<p>
This class is used in KMainWindow so
normally you don't need to use this class yourself. However, if you
need the help menu or any of its dialog boxes in your code that is
not subclassed from KMainWindow you should use this class.
</p>
<p>
The usage is simple:
</p>
<p>
<pre class="fragment">
 mHelpMenu = new KHelpMenu( this, &lt;someText&gt; );
 kmenubar-&gt;addMenu(mHelpMenu-&gt;menu() );
</pre>
</p>
<p>
or if you just want to open a dialog box:
</p>
<p>
<pre class="fragment">
 mHelpMenu = new KHelpMenu( this, &lt;someText&gt; );
 connect( this, SIGNAL(someSignal()), mHelpMenu,SLOT(aboutKDE()));
</pre>
</p>
<p>
IMPORTANT:
The first time you use KHelpMenu.menu(), a KMenu object is
allocated. Only one object is created by the class so if you call
KHelpMenu.menu() twice or more, the same pointer is returned. The class
will destroy the popupmenu in the destructor so do not delete this
pointer yourself.
</p>
<p>
The KHelpMenu object will be deleted when its parent is destroyed but you
can delete it yourself if you want. The code below will always work.
</p>
<p>
<pre class="fragment">
 MyClass.~MyClass()
 {
   delete mHelpMenu;
 }
</pre>
</p>
<p>
Using your own "about application" dialog box:
</p>
<p>
The standard "about application" dialog box is quite simple. If you
need a dialog box with more functionality you must design that one
yourself. When you want to display the dialog, you simply need to
connect the help menu signal showAboutApplication() to your slot.
</p>
<p>
<pre class="fragment">
 void MyClass.myFunc()
 {
   ..
   KHelpMenu *helpMenu = new KHelpMenu( this );
   connect( helpMenu, SIGNAL(showAboutApplication()),
          this, SLOT(myDialogSlot()));
   ..
 }

 void MyClass.myDialogSlot()
 {
   &lt;activate your custom dialog&gt;
 }
</pre>
</p>
<p>
<div align="center"><img src="../images/khelpmenu.png" /><p><strong> "KDE Help Menu" </strong></p></div>
</p>
<p>

<dl class="author" compact><dt><b>Author:</b></dt><dd> Espen Sand (espen@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="#MenuId">MenuId</a>&nbsp;</td><td class="memItemRight" valign="bottom">{&nbsp;menuHelpContents, menuWhatsThis, menuAboutApp, menuAboutKDE, menuReportBug, menuSwitchLanguage&nbsp;}</td></tr>
<tr><td colspan="2"><br><h2>Signals</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#showAboutApplication">showAboutApplication</a> ()</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="#KHelpMenu">__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/qstring.html">QString</a> aboutAppText=QString(), bool showWhatsThis=1)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#KHelpMenu">__init__</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qwidget.html">QWidget</a> parent, <a href="../kdecore/KAboutData.html">KAboutData</a> aboutData, bool showWhatsThis=1, <a href="../kdeui/KActionCollection.html">KActionCollection</a> actions=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aboutApplication">aboutApplication</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aboutKDE">aboutKDE</a> (self)</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="#action">action</a> (self, <a href="../kdeui/KHelpMenu.html#MenuId">KHelpMenu.MenuId</a> id)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#contextHelpActivated">contextHelpActivated</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdeui/KMenu.html">KMenu</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#menu">menu</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#reportBug">reportBug</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#switchApplicationLanguage">switchApplicationLanguage</a> (self)</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="KHelpMenu"></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/qstring.html">QString</a>&nbsp;</td>
<td class="paramname"><em>aboutAppText=QString()</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool&nbsp;</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>Constructor.
</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 parent of the dialog boxes. The boxes are modeless
and will be centered with respect to the parent.

<tr><td></td><td valign="top"><em>aboutAppText</em>&nbsp;</td><td> User definable string that is used in the
default application dialog box.

<tr><td></td><td valign="top"><em>showWhatsThis</em>&nbsp;</td><td> Decides whether a "Whats this" entry will be
added to the dialog.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="KHelpMenu"></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</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KAboutData.html">KAboutData</a>&nbsp;</td>
<td class="paramname"><em>aboutData</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"><em>showWhatsThis=1</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdeui/KActionCollection.html">KActionCollection</a>&nbsp;</td>
<td class="paramname"><em>actions=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.
</p>
<p>
This alternative constructor is mainly useful if you want to
overide the standard actions (aboutApplication(), aboutKDE(),
helpContents(), reportBug, and optionally whatsThis).
</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 parent of the dialog boxes. The boxes are modeless
and will be centered with respect to the parent.

<tr><td></td><td valign="top"><em>aboutData</em>&nbsp;</td><td> User and app data used in the About app dialog

<tr><td></td><td valign="top"><em>showWhatsThis</em>&nbsp;</td><td> Decides whether a "Whats this" entry will be
added to the dialog.

<tr><td></td><td valign="top"><em>actions</em>&nbsp;</td><td> KActionCollection that is used instead of the
standard actions.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="aboutApplication"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> aboutApplication</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>Opens an application specific dialog box.
</p>
<p>
The method will try to open the about box using the following steps:
- If the showAboutApplication() signal is connected, then it will be called.
This means there is an application defined aboutBox.
- If the aboutData was set in the constructor a KAboutApplicationDialog will be created.
- Else a default about box using the aboutAppText from the constructor will be created.
</p></div></div><a class="anchor" name="aboutKDE"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> aboutKDE</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>Opens the standard "About KDE" dialog box.
</p></div></div><a class="anchor" name="action"></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> action</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/KHelpMenu.html#MenuId">KHelpMenu.MenuId</a>&nbsp;</td>
<td class="paramname"><em>id</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 QAction * associated with the given parameter
Will return NULL pointers if menu() has not been called
</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>id</em>&nbsp;</td><td> The id of the action of which you want to get QAction *
</td></tr>
</table></dl>
<p>
</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">&nbsp;</td>
<td class="paramname"><em>self</em>&nbsp;)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Opens the help page for the application. The application name is
used as a key to determine what to display and the system will attempt
to open &lt;appName&gt;/index.html.
</p></div></div><a class="anchor" name="contextHelpActivated"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> contextHelpActivated</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>Activates What's This help for the application.
</p></div></div><a class="anchor" name="menu"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdeui/KMenu.html">KMenu</a> menu</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 popup menu you can use in the menu bar or where you
need it.
</p>
<p>
The returned menu is configured with an icon, a title and
menu entries. Therefore adding the returned pointer to your menu
is enougth to have access to the help menu.
</p>
<p>
Note: This method will only create one instance of the menu. If
you call this method twice or more the same pointer is returned.
</p></div></div><a class="anchor" name="reportBug"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> reportBug</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>Opens the standard "Report Bugs" dialog box.
</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">&nbsp;</td>
<td class="paramname"><em>self</em>&nbsp;)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>This signal is emitted from aboutApplication() if no
"about application" string has been defined. The standard
application specific dialog box that is normally activated in
aboutApplication() will not be displayed when this signal
is emitted.
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("showAboutApplication()"), target_slot)</code></dd></dl></div></div><a class="anchor" name="switchApplicationLanguage"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> switchApplicationLanguage</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>Opens the changing default application language dialog box.
</p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="MenuId"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">MenuId</td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>menuHelpContents</em>&nbsp;=&nbsp;0</td><td><tr><td valign="top"><em>menuWhatsThis</em>&nbsp;=&nbsp;1</td><td><tr><td valign="top"><em>menuAboutApp</em>&nbsp;=&nbsp;2</td><td><tr><td valign="top"><em>menuAboutKDE</em>&nbsp;=&nbsp;3</td><td><tr><td valign="top"><em>menuReportBug</em>&nbsp;=&nbsp;4</td><td><tr><td valign="top"><em>menuSwitchLanguage</em>&nbsp;=&nbsp;5</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>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional