mirror of
https://bitbucket.org/smil3y/kde-playground.git
synced 2025-02-24 10:52:52 +00:00
465 lines
16 KiB
HTML
465 lines
16 KiB
HTML
<?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>KEditToolBar</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>KEditToolBar Class Reference</h1>
|
|
<code>from PyKDE4.kdeui import *</code>
|
|
<p>
|
|
Inherits: <a href="../kdeui/KDialog.html">KDialog</a> → QDialog → QWidget → QObject<br />
|
|
|
|
|
|
<h2>Detailed Description</h2>
|
|
|
|
<p>A dialog used to customize or configure toolbars.
|
|
</p>
|
|
<p>
|
|
This dialog only works if your application uses the XML UI
|
|
framework for creating menus and toolbars. It depends on the XML
|
|
files to describe the toolbar layouts and it requires the actions
|
|
to determine which buttons are active.
|
|
</p>
|
|
<p>
|
|
Typically you do not need to use it directly as KXmlGuiWindow.setupGUI
|
|
takes care of it.
|
|
</p>
|
|
<p>
|
|
If you use plugListAction you need to overload saveNewToolbarConfig()
|
|
to plug actions again:
|
|
</p>
|
|
<p>
|
|
<pre class="fragment">
|
|
void MyClass.saveNewToolbarConfig()
|
|
{
|
|
KXmlGuiWindow.saveNewToolbarConfig();
|
|
plugActionList( "list1", list1Actions );
|
|
plugActionList( "list2", list2Actions );
|
|
}
|
|
</pre>
|
|
</p>
|
|
<p>
|
|
When created, KEditToolBar takes a KXMLGUIFactory object, and uses it to
|
|
find all of the action collections and XML files (there is one of each for the
|
|
mainwindow, but there could be more, when adding other XMLGUI clients like
|
|
KParts or plugins). The editor aims to be semi-intelligent about where it
|
|
assigns any modifications. In other words, it will not write out part specific
|
|
changes to your application's main XML file.
|
|
</p>
|
|
<p>
|
|
KXmlGuiWindow and KParts.MainWindow take care of creating KEditToolBar correctly
|
|
and connecting to its newToolBarConfig slot, but if you really really want to do it
|
|
yourself, see the KXmlGuiWindow.configureToolbars() and KXmlGuiWindow.saveNewToolbarConfig() code.
|
|
</p>
|
|
<p>
|
|
<div align="center"><img src="../images/kedittoolbar.png" /><p><strong> "KDE Toolbar Editor (KWrite)" </strong></p></div>
|
|
</p>
|
|
<p>
|
|
|
|
<dl class="author" compact><dt><b>Author:</b></dt><dd> Kurt Granroth <granroth@kde.org> </dd></dl>
|
|
@maintainer David Faure <faure@kde.org>
|
|
</p>
|
|
<table border="0" cellpadding="0" cellspacing="0"><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="#newToolBarConfig">newToolBarConfig</a> ()</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#newToolbarConfig">newToolbarConfig</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="#KEditToolBar">__init__</a> (self, <a href="../kdeui/KActionCollection.html">KActionCollection</a> collection, QWidget parent=0)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KEditToolBar">__init__</a> (self, <a href="../kdeui/KXMLGUIFactory.html">KXMLGUIFactory</a> factory, QWidget parent=0)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KEditToolBar">__init__</a> (self, <a href="../kdeui/KEditToolBar.html">KEditToolBar</a> a0)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#hideEvent">hideEvent</a> (self, QHideEvent event)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setDefaultToolBar">setDefaultToolBar</a> (self, QString toolBarName)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setResourceFile">setResourceFile</a> (self, QString file, bool global=1)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#showEvent">showEvent</a> (self, QShowEvent event)</td></tr>
|
|
<tr><td colspan="2"><br><h2>Static Methods</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setGlobalDefaultToolBar">setGlobalDefaultToolBar</a> (QString toolBarName)</td></tr>
|
|
</table>
|
|
<hr><h2>Signal Documentation</h2><a class="anchor" name="newToolBarConfig"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> newToolBarConfig</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">)</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p>Signal emitted when 'apply' or 'ok' is clicked or toolbars were reset.
|
|
Connect to it, to plug action lists and to call applyMainWindowSettings
|
|
(see sample code in this class's documentation)
|
|
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("newToolBarConfig()"), target_slot)</code></dd></dl></div></div><a class="anchor" name="newToolbarConfig"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> newToolbarConfig</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">)</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("newToolbarConfig()"), target_slot)</code></dd></dl></div></div><hr><h2>Method Documentation</h2><a class="anchor" name="KEditToolBar"></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/KActionCollection.html">KActionCollection</a> </td>
|
|
<td class="paramname"><em>collection</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QWidget </td>
|
|
<td class="paramname"><em>parent=0</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Old constructor for apps that do not use components.
|
|
This constructor is somewhat deprecated, since it doesn't work
|
|
with any KXMLGuiClient being added to the mainwindow.
|
|
You really want to use the other constructor.
|
|
</p>
|
|
<p>
|
|
You <b>must</b> pass along your collection of actions (some of which appear in your toolbars).
|
|
</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>collection</em> </td><td> The collection of actions to work on.
|
|
|
|
<tr><td></td><td valign="top"><em>parent</em> </td><td> The parent of the dialog.
|
|
</td></tr>
|
|
</table></dl>
|
|
<p>
|
|
</p></div></div><a class="anchor" name="KEditToolBar"></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/KXMLGUIFactory.html">KXMLGUIFactory</a> </td>
|
|
<td class="paramname"><em>factory</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QWidget </td>
|
|
<td class="paramname"><em>parent=0</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Main constructor.
|
|
</p>
|
|
<p>
|
|
The main parameter, <b>factory,</b> is a pointer to the
|
|
XML GUI factory object for your application. It contains a list
|
|
of all of the GUI clients (along with the action collections and
|
|
xml files) and the toolbar editor uses that.
|
|
</p>
|
|
<p>
|
|
Use this like so:
|
|
<pre class="fragment">
|
|
KEditToolBar edit(factory());
|
|
if (edit.exec())
|
|
...
|
|
</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>factory</em> </td><td> Your application's factory object
|
|
|
|
<tr><td></td><td valign="top"><em>parent</em> </td><td> The usual parent for the dialog.
|
|
</td></tr>
|
|
</table></dl>
|
|
<p>
|
|
</p></div></div><a class="anchor" name="KEditToolBar"></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/KEditToolBar.html">KEditToolBar</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="hideEvent"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> hideEvent</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">QHideEvent </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"></div></div><a class="anchor" name="setDefaultToolBar"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> setDefaultToolBar</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>toolBarName</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 default toolbar that will be selected when the dialog is shown.
|
|
If not set, or QString() is passed in, the global default tool bar name
|
|
will be used.
|
|
</p><dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td></td><td valign="top"><em>toolBarName</em> </td><td> the name of the tool bar
|
|
</td></tr> </table></dl>
|
|
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> setGlobalDefaultToolBar
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="setResourceFile"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> setResourceFile</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>file</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>global=1</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>The name (absolute or relative) of your application's UI resource file
|
|
is assumed to be share/apps/appname/appnameui.rc though this can be
|
|
overridden by calling this method.
|
|
</p>
|
|
<p>
|
|
The global parameter controls whether or not the
|
|
global resource file is used. If this is <b>true,</b> then you may
|
|
edit all of the actions in your toolbars -- global ones and
|
|
local one. If it is <b>false,</b> then you may edit only your
|
|
application's entries. The only time you should set this to
|
|
false is if your application does not use the global resource
|
|
file at all (very rare).
|
|
</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> </td><td> The application's local resource file.
|
|
|
|
<tr><td></td><td valign="top"><em>global</em> </td><td> If <b>true,</b> then the global resource file will also
|
|
be parsed.
|
|
</td></tr>
|
|
</table></dl>
|
|
<p>
|
|
</p></div></div><a class="anchor" name="showEvent"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> showEvent</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">QShowEvent </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"></div></div><hr><h2>Static Method Documentation</h2><a class="anchor" name="setGlobalDefaultToolBar"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> setGlobalDefaultToolBar</td>
|
|
<td>(</td>
|
|
<td class="paramtype">QString </td>
|
|
<td class="paramname"><em>toolBarName</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 default toolbar which will be auto-selected for all
|
|
KEditToolBar instances. Can be overridden on a per-dialog basis
|
|
by calling setDefaultToolBar( const QString& ) on the dialog.
|
|
</p><dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td></td><td valign="top"><em></em> </td><td> toolbarName the name of the tool bar
|
|
</td></tr>
|
|
</table></dl>
|
|
<p>
|
|
</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>
|