mirror of
https://bitbucket.org/smil3y/kde-playground.git
synced 2025-02-24 19:02:51 +00:00
674 lines
24 KiB
HTML
674 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>Plasma.RunnerContext</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>RunnerContext Class Reference</h1>
|
|
<code>from PyKDE4.plasma import *</code>
|
|
<p>
|
|
Inherits: QObject<br />
|
|
|
|
Namespace: <a href="../plasma/Plasma.html">Plasma</a><br />
|
|
<h2>Detailed Description</h2>
|
|
|
|
<p>RunnerContext plasma/runnercontext.h <Plasma/RunnerContext>
|
|
</p>
|
|
<p>
|
|
The RunnerContext class provides information related to a search,
|
|
including the search term, metadata on the search term and collected
|
|
matches.
|
|
</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="#Type">Type</a> </td><td class="memItemRight" valign="bottom">{ None, UnknownType, Directory, File, NetworkLocation, Executable, ShellCommand, Help, FileSystem }</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="#matchesChanged">matchesChanged</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="#RunnerContext">__init__</a> (self, QObject parent=0)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#RunnerContext">__init__</a> (self, <a href="../plasma/Plasma.RunnerContext.html">Plasma.RunnerContext</a> other, QObject parent=0)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#addMatch">addMatch</a> (self, QString term, <a href="../plasma/Plasma.QueryMatch.html">Plasma.QueryMatch</a> match)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#addMatches">addMatches</a> (self, QString term, [<a href="../plasma/Plasma.QueryMatch.html">Plasma.QueryMatch</a>] matches)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isValid">isValid</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../plasma/Plasma.QueryMatch.html">Plasma.QueryMatch</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#match">match</a> (self, QString id)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">[<a href="../plasma/Plasma.QueryMatch.html">Plasma.QueryMatch</a>] </td><td class="memItemRight" valign="bottom"><a class="el" href="#matches">matches</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#mimeType">mimeType</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#query">query</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#removeMatch">removeMatch</a> (self, QString matchId)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#removeMatches">removeMatches</a> (self, QStringList matchIdList)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#reset">reset</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#restore">restore</a> (self, <a href="../kdecore/KConfigGroup.html">KConfigGroup</a> config)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#run">run</a> (self, <a href="../plasma/Plasma.QueryMatch.html">Plasma.QueryMatch</a> match)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#save">save</a> (self, <a href="../kdecore/KConfigGroup.html">KConfigGroup</a> config)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setQuery">setQuery</a> (self, QString term)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setSingleRunnerQueryMode">setSingleRunnerQueryMode</a> (self, bool enabled)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#singleRunnerQueryMode">singleRunnerQueryMode</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../plasma/Plasma.RunnerContext.html#Type">Plasma.RunnerContext.Type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#type">type</a> (self)</td></tr>
|
|
</table>
|
|
<hr><h2>Signal Documentation</h2><a class="anchor" name="matchesChanged"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> matchesChanged</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("matchesChanged()"), target_slot)</code></dd></dl></div></div><hr><h2>Method Documentation</h2><a class="anchor" name="RunnerContext"></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">QObject </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"></div></div><a class="anchor" name="RunnerContext"></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="../plasma/Plasma.RunnerContext.html">Plasma.RunnerContext</a> </td>
|
|
<td class="paramname"><em>other</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QObject </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>Copy constructor
|
|
</p></div></div><a class="anchor" name="addMatch"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">bool addMatch</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>term</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a href="../plasma/Plasma.QueryMatch.html">Plasma.QueryMatch</a> </td>
|
|
<td class="paramname"><em>match</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Appends a match to the existing list of matches.
|
|
</p>
|
|
<p>
|
|
If you are going to be adding multiple matches, use addMatches instead.
|
|
</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>term</em> </td><td> the search term that this match was generated for.
|
|
|
|
<tr><td></td><td valign="top"><em>match</em> </td><td> the match to add
|
|
</td></tr>
|
|
</table></dl>
|
|
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true if the match was added, false otherwise.
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="addMatches"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">bool addMatches</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>term</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">[<a href="../plasma/Plasma.QueryMatch.html">Plasma.QueryMatch</a>] </td>
|
|
<td class="paramname"><em>matches</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Appends lists of matches to the list of matches.
|
|
</p>
|
|
<p>
|
|
This method is thread safe and causes the matchesChanged() signal to be emitted.
|
|
</p>
|
|
<p>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd> true if matches were added, false if matches were e.g. outdated
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="isValid"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">bool isValid</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="return" compact><dt><b>Returns:</b></dt><dd> true if this context is no longer valid and therefore
|
|
matching using it should abort. Most useful as an optimization technique
|
|
inside of AbstractRunner subclasses in the match method, e.g.:
|
|
</dd></dl> </p>
|
|
<p>
|
|
while (.. a possibly large iteration) {
|
|
if (!context.isValid()) {
|
|
return;
|
|
}
|
|
</p>
|
|
<p>
|
|
... some processing ...
|
|
}
|
|
</p>
|
|
<p>
|
|
While not required to be used within runners, it provies a nice way
|
|
to avoid unnecessary processing in runners that may run for an extended
|
|
period (as measured in 10s of ms) and therefore improve the user experience.
|
|
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.2.3
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="match"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"><a href="../plasma/Plasma.QueryMatch.html">Plasma.QueryMatch</a> match</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>id</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Retrieves a match by id.
|
|
</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> </td><td> the id of the match to return
|
|
</td></tr> </table></dl>
|
|
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> the match associated with this id, or an invalid QueryMatch object
|
|
if the id does not eixst
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="matches"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">[<a href="../plasma/Plasma.QueryMatch.html">Plasma.QueryMatch</a>] matches</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>Retrieves all available matches for the current search term.
|
|
</p>
|
|
<p>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd> a list of matches
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="mimeType"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">QString mimeType</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>The mimetype that the search term refers to, if discoverable.
|
|
</p>
|
|
<p>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd> QString() if the mimetype can not be determined, otherwise
|
|
the mimetype of the object being referred to by the search
|
|
string.
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="query"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">QString query</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="return" compact><dt><b>Returns:</b></dt><dd> the current search query term.
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="removeMatch"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">bool removeMatch</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>matchId</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Removes a match from the existing list of matches.
|
|
</p>
|
|
<p>
|
|
If you are going to be removing multiple matches, use removeMatches instead.
|
|
</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>matchId</em> </td><td> the id of match to remove
|
|
</td></tr>
|
|
</table></dl>
|
|
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true if the match was removed, false otherwise.
|
|
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.4
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="removeMatches"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">bool removeMatches</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">QStringList </td>
|
|
<td class="paramname"><em>matchIdList</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Removes lists of matches from the existing list of matches.
|
|
</p>
|
|
<p>
|
|
This method is thread safe and causes the matchesChanged() signal to be emitted.
|
|
</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>matchIdList</em> </td><td> the list of matches id to remove
|
|
</td></tr>
|
|
</table></dl>
|
|
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true if at least one match was removed, false otherwise.
|
|
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.4
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="reset"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> reset</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>Resets the search term for this object.
|
|
This removes all current matches in the process and
|
|
turns off single runner query mode.
|
|
</p></div></div><a class="anchor" name="restore"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> restore</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="../kdecore/KConfigGroup.html">KConfigGroup</a> </td>
|
|
<td class="paramname"><em>config</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 launch counts for the associated match ids
|
|
</p>
|
|
<p>
|
|
If a runner adds a match to this context, the context will check if the
|
|
match id has been launched before and increase the matches relevance
|
|
correspondingly. In this manner, any front end can implement adaptive search
|
|
by sorting items according to relevance.
|
|
</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>config</em> </td><td> the config group where launch data was stored
|
|
</td></tr>
|
|
</table></dl>
|
|
<p>
|
|
</p></div></div><a class="anchor" name="run"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> run</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="../plasma/Plasma.QueryMatch.html">Plasma.QueryMatch</a> </td>
|
|
<td class="paramname"><em>match</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Run a match using the information from this context
|
|
</p>
|
|
<p>
|
|
The context will also keep track of the number of times the match was
|
|
launched to sort future matches according to user habits
|
|
</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>match</em> </td><td> the match to run
|
|
</td></tr>
|
|
</table></dl>
|
|
<p>
|
|
</p></div></div><a class="anchor" name="save"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> save</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="../kdecore/KConfigGroup.html">KConfigGroup</a> </td>
|
|
<td class="paramname"><em>config</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p></p><dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td></td><td valign="top"><em>config</em> </td><td> the config group where launch data should be stored
|
|
</td></tr>
|
|
</table></dl>
|
|
<p>
|
|
</p></div></div><a class="anchor" name="setQuery"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> setQuery</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>term</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 query term for this object and attempts to determine
|
|
the type of the search.
|
|
</p></div></div><a class="anchor" name="setSingleRunnerQueryMode"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> setSingleRunnerQueryMode</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>enabled</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Sets single runner query mode. Note that a call to reset() will
|
|
turn off single runner query mode.
|
|
</p>
|
|
<p>
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd> reset()
|
|
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.4
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="singleRunnerQueryMode"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">bool singleRunnerQueryMode</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="return" compact><dt><b>Returns:</b></dt><dd> true if the current query is a single runner query
|
|
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.4
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="type"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"><a href="../plasma/Plasma.RunnerContext.html#Type">Plasma.RunnerContext.Type</a> type</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>The type of item the search term might refer to.
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd> Type
|
|
</dd></dl>
|
|
</p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="Type"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr><td class="memname">Type</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>None</em> = 0</td><td><tr><td valign="top"><em>UnknownType</em> = 1</td><td><tr><td valign="top"><em>Directory</em> = 2</td><td><tr><td valign="top"><em>File</em> = 4</td><td><tr><td valign="top"><em>NetworkLocation</em> = 8</td><td><tr><td valign="top"><em>Executable</em> = 16</td><td><tr><td valign="top"><em>ShellCommand</em> = 32</td><td><tr><td valign="top"><em>Help</em> = 64</td><td><tr><td valign="top"><em>FileSystem</em> = Directory|File|Executable|ShellCommand</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>
|