mirror of
https://bitbucket.org/smil3y/kde-playground.git
synced 2025-02-24 10:52:52 +00:00
682 lines
24 KiB
HTML
682 lines
24 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>KShortcut</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>KShortcut Class Reference</h1>
|
|
<code>from PyKDE4.kdeui import *</code>
|
|
<p>
|
|
|
|
|
|
|
|
<h2>Detailed Description</h2>
|
|
|
|
<p>Represents a keyboard shortcut
|
|
</p>
|
|
<p>
|
|
The KShortcut class is used to represent a keyboard shortcut to an action.
|
|
A shortcut is normally a single key with modifiers, such as Ctrl+V.
|
|
A KShortcut object may also contain an alternate key sequence which will also
|
|
activate the action it's associated with, as long as no other actions have
|
|
defined that key as their primary key. Ex: Ctrl+V;Shift+Insert.
|
|
</p>
|
|
<p>
|
|
This can be used to add additional accelerators to a KAction. For example,
|
|
the below code binds the escape key to the close action.
|
|
</p>
|
|
<p>
|
|
<pre class="fragment">
|
|
KAction *closeAction = KStandardAction.close(this, SLOT( close() ), actionCollection());
|
|
KShortcut closeShortcut = closeAction->shortcut();
|
|
closeShortcut.setAlternate(Qt.Key_Escape);
|
|
closeAction->setShortcut(closeShortcut);
|
|
</pre>
|
|
</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="#EmptyHandling">EmptyHandling</a> </td><td class="memItemRight" valign="bottom">{ KeepEmpty, RemoveEmpty }</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="#KShortcut">__init__</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KShortcut">__init__</a> (self, QKeySequence primary)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KShortcut">__init__</a> (self, QKeySequence primary, QKeySequence alternate)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KShortcut">__init__</a> (self, int keyQtPri, int keyQtAlt=0)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KShortcut">__init__</a> (self, <a href="../kdeui/KShortcut.html">KShortcut</a> other)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KShortcut">__init__</a> (self, QString description)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KShortcut">__init__</a> (self, [QKeySequence] seqs)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">QKeySequence </td><td class="memItemRight" valign="bottom"><a class="el" href="#alternate">alternate</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#conflictsWith">conflictsWith</a> (self, QKeySequence needle)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#contains">contains</a> (self, QKeySequence needle)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isEmpty">isEmpty</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#operator !=">operator !=</a> (self, <a href="../kdeui/KShortcut.html">KShortcut</a> other)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#operator ==">operator ==</a> (self, <a href="../kdeui/KShortcut.html">KShortcut</a> other)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">QKeySequence </td><td class="memItemRight" valign="bottom"><a class="el" href="#primary">primary</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#remove">remove</a> (self, QKeySequence keySeq, <a href="../kdeui/KShortcut.html#EmptyHandling">KShortcut.EmptyHandling</a> handleEmpty=KShortcut.RemoveEmpty)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setAlternate">setAlternate</a> (self, QKeySequence keySeq)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setPrimary">setPrimary</a> (self, QKeySequence keySeq)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">[QKeySequence] </td><td class="memItemRight" valign="bottom"><a class="el" href="#toList">toList</a> (self, <a href="../kdeui/KShortcut.html#EmptyHandling">KShortcut.EmptyHandling</a> handleEmpty=KShortcut.RemoveEmpty)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#toString">toString</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#toString">toString</a> (self, QKeySequence::SequenceFormat format)</td></tr>
|
|
</table>
|
|
<hr><h2>Method Documentation</h2><a class="anchor" name="KShortcut"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">__init__</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>Creates a new empty shortcut.
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd> isEmpty()
|
|
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> clear()
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="KShortcut"></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">QKeySequence </td>
|
|
<td class="paramname"><em>primary</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Creates a new shortcut that contains the given Qt key
|
|
sequence as primary shortcut.
|
|
</p><dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td></td><td valign="top"><em>primary</em> </td><td> Qt key sequence to add
|
|
</td></tr>
|
|
</table></dl>
|
|
<p>
|
|
</p></div></div><a class="anchor" name="KShortcut"></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">QKeySequence </td>
|
|
<td class="paramname"><em>primary</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QKeySequence </td>
|
|
<td class="paramname"><em>alternate</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Creates a new shortcut with the given Qt key sequences
|
|
as primary and secondary shortcuts.
|
|
</p><dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td></td><td valign="top"><em>primary</em> </td><td> Qt keycode of primary shortcut
|
|
|
|
<tr><td></td><td valign="top"><em>alternate</em> </td><td> Qt keycode of alternate shortcut
|
|
</td></tr> </table></dl>
|
|
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> Qt.Key
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="KShortcut"></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">int </td>
|
|
<td class="paramname"><em>keyQtPri</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>keyQtAlt=0</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Creates a new shortcut with the given Qt key codes
|
|
as primary and secondary shortcuts.
|
|
You can only assign single-key shortcuts this way.
|
|
</p><dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td></td><td valign="top"><em>keyQtPri</em> </td><td> Qt keycode of primary shortcut
|
|
|
|
<tr><td></td><td valign="top"><em>keyQtAlt</em> </td><td> Qt keycode of alternate shortcut
|
|
</td></tr> </table></dl>
|
|
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> Qt.Key
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="KShortcut"></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/KShortcut.html">KShortcut</a> </td>
|
|
<td class="paramname"><em>other</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Copy constructor.
|
|
</p></div></div><a class="anchor" name="KShortcut"></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">QString </td>
|
|
<td class="paramname"><em>description</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Creates a new shortcut that contains the key sequences described
|
|
in <b>description.</b> The format of description is the same as
|
|
used in QKeySequence.fromString(const QString&).
|
|
Up to two key sequences separated by a semicolon followed by a
|
|
space "; " may be given.
|
|
</p><dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td></td><td valign="top"><em>description</em> </td><td> the description of key sequence(s)
|
|
</td></tr> </table></dl>
|
|
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> QKeySequence.fromString(const QString&, SequenceFormat)
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="KShortcut"></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">[QKeySequence] </td>
|
|
<td class="paramname"><em>seqs</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Creates a new shortcut with the given Qt key sequences.
|
|
The first sequence in the list is considered to be the primary
|
|
sequence, the second one the alternate.
|
|
</p><dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td></td><td valign="top"><em>seqs</em> </td><td> List of key sequeces.
|
|
</td></tr>
|
|
</table></dl>
|
|
<p>
|
|
</p></div></div><a class="anchor" name="alternate"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">QKeySequence alternate</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 alternate key sequence of this shortcut.
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd> alternate key sequence
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="conflictsWith"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">bool conflictsWith</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">QKeySequence </td>
|
|
<td class="paramname"><em>needle</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Returns whether at least one of the key sequences conflicts witho <b>needle.</b>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd> whether this shortcut conflicts with <b>needle</b>
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="contains"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">bool contains</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">QKeySequence </td>
|
|
<td class="paramname"><em>needle</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Returns whether at least one of the key sequences is equal to <b>needle.</b>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd> whether this shortcut contains <b>needle</b>
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="isEmpty"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">bool isEmpty</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 whether this shortcut contains any nonempty key sequences.
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd> whether this shortcut is empty
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="operator !="></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">bool operator !=</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/KShortcut.html">KShortcut</a> </td>
|
|
<td class="paramname"><em>other</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="operator =="></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">bool operator ==</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/KShortcut.html">KShortcut</a> </td>
|
|
<td class="paramname"><em>other</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="primary"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">QKeySequence primary</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 primary key sequence of this shortcut.
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd> primary key sequence
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="remove"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> remove</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">QKeySequence </td>
|
|
<td class="paramname"><em>keySeq</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a href="../kdeui/KShortcut.html#EmptyHandling">KShortcut.EmptyHandling</a> </td>
|
|
<td class="paramname"><em>handleEmpty=KShortcut.RemoveEmpty</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Remove <b>keySeq</b> from this shortcut.
|
|
If <b>handleEmpty</b> equals RemoveEmpty, following key sequences will move up to take the place of
|
|
<b>keySeq.</b> Otherwise, key sequences equal to <b>keySeq</b> will be set to empty.
|
|
</p><dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td></td><td valign="top"><em>keySeq</em> </td><td> remove this key sequence from the shortcut
|
|
</td></tr>
|
|
</table></dl>
|
|
<p>
|
|
</p></div></div><a class="anchor" name="setAlternate"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> setAlternate</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">QKeySequence </td>
|
|
<td class="paramname"><em>keySeq</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Set the alternate key sequence of this shortcut to the given key sequence.
|
|
</p><dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td></td><td valign="top"><em>keySeq</em> </td><td> set alternate key sequence to this
|
|
</td></tr>
|
|
</table></dl>
|
|
<p>
|
|
</p></div></div><a class="anchor" name="setPrimary"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> setPrimary</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">QKeySequence </td>
|
|
<td class="paramname"><em>keySeq</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Set the primary key sequence of this shortcut to the given key sequence.
|
|
</p><dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td></td><td valign="top"><em>keySeq</em> </td><td> set primary key sequence to this
|
|
</td></tr>
|
|
</table></dl>
|
|
<p>
|
|
</p></div></div><a class="anchor" name="toList"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">[QKeySequence] toList</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/KShortcut.html#EmptyHandling">KShortcut.EmptyHandling</a> </td>
|
|
<td class="paramname"><em>handleEmpty=KShortcut.RemoveEmpty</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>The same as operator QList<QKeySequence>()
|
|
If <b>handleEmpty</b> equals RemoveEmpty, empty key sequences will be left out of the result.
|
|
Otherwise, empy key sequences will be included; you can be sure that
|
|
shortcut.alternate() == shortcut.toList(KeepEmpty).at(1).
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the shortcut converted to a QList<QKeySequence>
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="toString"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">QString toString</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 a description of the shortcut as a semicolon-separated
|
|
list of key sequences, as returned by QKeySequence.toString().
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the string represenation of this shortcut
|
|
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> QKeySequence.toString()
|
|
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> KShortcut(const QString &description)
|
|
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> KDE 4.2
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="toString"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">QString toString</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">QKeySequence::SequenceFormat </td>
|
|
<td class="paramname"><em>format</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Returns a description of the shortcut as a semicolon-separated
|
|
list of key sequences, as returned by QKeySequence.toString().
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the string represenation of this shortcut
|
|
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> QKeySequence.toString()
|
|
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> KShortcut(const QString &description)
|
|
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> KDE 4.2
|
|
</dd></dl>
|
|
</p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="EmptyHandling"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr><td class="memname">EmptyHandling</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p>An enum about the behavior of operations that treat a KShortcut like a list of QKeySequences.
|
|
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>KeepEmpty</em> = 0</td><td><tr><td valign="top"><em>RemoveEmpty</em> </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="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>
|