<?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>KAccelGen</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<link rel="stylesheet" type="text/css" href="../common/doxygen.css" />
<link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../common/kde.css" />
</head>
<body>
<div id="container">
<div id="header">
<div id="header_top">
<div>
<div>
<img alt ="" src="../common/top-kde.jpg"/>
KDE 4.4 PyKDE API Reference
</div>
</div>
</div>
<div id="header_bottom">
<div id="location">
<ul>
<li>KDE's Python API</li>
</ul>
</div>
<div id="menu">
<ul>
<li><a href="../modules.html">Overview</a></li>
<li><a href="http://techbase.kde.org/Development/Languages/Python">PyKDE Home</a></li>
<li><a href="http://kde.org/family/">Sitemap</a></li>
<li><a href="http://kde.org/contact/">Contact Us</a></li>
</ul>
</div>
</div>
</div>
<div id="body_wrapper">
<div id="body">
<div id="right">
<div class="content">
<div id="main">
<div class="clearer"> </div>
<h1>KAccelGen Namespace Reference</h1>
<code>from PyKDE4.kdeui.KAccelGen import *</code>
<p>
<h2>Detailed Description</h2>
<p>Provides functions that, given a collection of QStrings, will
automatically and intelligently assign menu accelerators to the
QStrings in the collection.
</p>
<p>
NOTE: When this file speaks of "accelerators", we really mean
accelerators as defined by the KDE User Interface Guidelines. We
do NOT mean "shortcuts", which are what's handled by most other KDE
libraries with "accel" in the name.
</p>
<p>
In the Qt library, the mechanism for adding a keyboard accelerator
to a menu item is to insert an '&' before the letter. Since we
usually don't want to disturb the original collection, the idiom in
these functions is to populate a "target" QStringList parameter
with the input collectin's QStrings, plus possibly some added '&'
characters.
</p>
<p>
That is the mechanism. Here is the policy, in order of decreasing
importance (it may seem like these are implementation details, but
IMHO the policy is an important part of the interface):
</p>
<p>
1. If the string already contains an '&' character, skip this
string, because we consider such strings to be "user-specified"
accelerators.
</p>
<p>
2. No accelerator may clash with a previously defined accelerator,
including any legal (alphanumeric) user-specified accelerator
anywhere in the collection
</p>
<p>
3. Prefer alphanumerics at the start of the string.
</p>
<p>
4. Otherwise, prefer alphanumerics at the start of a word.
</p>
<p>
5. Otherwise, choose any alphanumeric character not already
taken. If no such character is available, give up & skip this
string.
</p>
<p>
A typical use of these functions would be to automatically assign
accelerators to a dynamically populated popup menu. For example,
the core code was written to automatically set accelerators for the
"Load View Profile" popup menu for Konqueror. We quickly realized
that it would be useful to make this facility more generally
available, so I abstracted it out into a set of templates.
</p>
<p>
TODO:
</p>
<p>
+ Add sugar functions for more collections.
</p>
<p>
+ Add more Deref classes so that we can access a wider variety of
collections.
</p>
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#generate">generate</a> (, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstringlist.html">QStringList</a> source, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstringlist.html">QStringList</a> target)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isLegalAccelerator">isLegalAccelerator</a> (, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> str, int index)</td></tr>
</table>
<hr><h2>Function Documentation</h2><a class="anchor" name="generate"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> generate</td>
<td>(</td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstringlist.html">QStringList</a> </td>
<td class="paramname"><em>source</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstringlist.html">QStringList</a> </td>
<td class="paramname"><em>target</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Convenience function; generates accelerators for all the items in
a QStringList.
</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>source</em> </td><td> Strings for which to generate accelerators
<tr><td></td><td valign="top"><em>target</em> </td><td> Output for accelerator-added strings
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="isLegalAccelerator"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool isLegalAccelerator</td>
<td>(</td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td>
<td class="paramname"><em>str</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>index</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Helper to determine if the given offset in the string could be a
legal alphanumeric accelerator.
</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>str</em> </td><td> base string
<tr><td></td><td valign="top"><em>index</em> </td><td> offset to check
</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>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
b77dda48f87d4eda8cc559e40c49a652
>
files
>
361
