<?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>KUriFilterData</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>KUriFilterData Class Reference</h1>
<code>from PyKDE4.kio import *</code>
<p>
<h2>Detailed Description</h2>
<p>This class is a basic messaging class used to exchange filtering information
between the filter plugins and the application requesting the filtering
service.
</p>
<p>
Use this object if you require a more detailed information about the URI you
want to filter. Any application can create an instance of this class and send
it to KUriFilter to have the plugins fill out all possible information about
the URI.
</p>
<p>
On successful filtering you can use uriType() to determine what type
of resource the request was filtered into. See KUriFilter.UriTypes for
details. If an error is encountered, then KUriFilter.Error is returned.
You can use errorMsg to obtain the error information.
</p>
<p>
The functions in this class are not reentrant.
</p>
<p>
<b>Example</b>
</p>
<p>
Here is a basic example of how this class is used with KUriFilter:
<pre class="fragment">
KUriFilterData filterData (QLatin1String("kde.org"));
bool filtered = KUriFilter.self()->filterUri(filterData);
</pre>
</p>
<p>
If you are only interested in getting the list of preferred search providers,
then you can do the following (requires KDE >= 4.5):
</p>
<p>
<pre class="fragment">
KDE 4.5:
KUriFilterData data;
data.setData("<text-to-search-for>");
data.setAlternateDefaultSearchProvider("google");
bool filtered = KUriFilter.self()->filterUri(data, "kuriikwsfilter");
KDE >= 4.6:
KUriFilterData data;
data.setData("<text-to-search-for>");
data.setSearchFilteringOption(KUriFilterData.RetrievePreferredSearchProvidersOnly);
bool filtered = KUriFilter.self()->filterSearchUri(data, KUriFilter.NormalTextFilter);
</pre>
</p>
<p>
A class for exchanging filtering information.
<dl class="author" compact><dt><b>Author:</b></dt><dd> Dawit Alemayehu <adawit at 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="#SearchFilterOption">SearchFilterOption</a> </td><td class="memItemRight" valign="bottom">{ SearchFilterOptionNone, RetrieveSearchProvidersOnly, RetrievePreferredSearchProvidersOnly, RetrieveAvailableSearchProvidersOnly }</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#UriTypes">UriTypes</a> </td><td class="memItemRight" valign="bottom">{ NetProtocol, LocalFile, LocalDir, Executable, Help, Shell, Blocked, Error, Unknown }</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="#KUriFilterData">__init__</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KUriFilterData">__init__</a> (self, <a href="../kdecore/KUrl.html">KUrl</a> url)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KUriFilterData">__init__</a> (self, QString url)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KUriFilterData">__init__</a> (self, <a href="../kio/KUriFilterData.html">KUriFilterData</a> other)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#absolutePath">absolutePath</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QStringList </td><td class="memItemRight" valign="bottom"><a class="el" href="#allQueriesForSearchProvider">allQueriesForSearchProvider</a> (self, QString provider)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#alternateDefaultSearchProvider">alternateDefaultSearchProvider</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QStringList </td><td class="memItemRight" valign="bottom"><a class="el" href="#alternateSearchProviders">alternateSearchProviders</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#argsAndOptions">argsAndOptions</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#checkForExecutables">checkForExecutables</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#defaultUrlScheme">defaultUrlScheme</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#errorMsg">errorMsg</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#hasAbsolutePath">hasAbsolutePath</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#hasArgsAndOptions">hasArgsAndOptions</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#iconName">iconName</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#iconNameForPreferredSearchProvider">iconNameForPreferredSearchProvider</a> (self, QString provider)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QStringList </td><td class="memItemRight" valign="bottom"><a class="el" href="#preferredSearchProviders">preferredSearchProviders</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#queryForPreferredSearchProvider">queryForPreferredSearchProvider</a> (self, QString provider)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kio/KUriFilterSearchProvider.html">KUriFilterSearchProvider</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#queryForSearchProvider">queryForSearchProvider</a> (self, QString provider)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kio/KUriFilterData.html">KUriFilterData.SearchFilterOptions</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#searchFilteringOptions">searchFilteringOptions</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#searchProvider">searchProvider</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#searchTerm">searchTerm</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QChar </td><td class="memItemRight" valign="bottom"><a class="el" href="#searchTermSeparator">searchTermSeparator</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#setAbsolutePath">setAbsolutePath</a> (self, QString abs_path)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setAlternateDefaultSearchProvider">setAlternateDefaultSearchProvider</a> (self, QString provider)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setAlternateSearchProviders">setAlternateSearchProviders</a> (self, QStringList providers)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setCheckForExecutables">setCheckForExecutables</a> (self, bool check)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setData">setData</a> (self, <a href="../kdecore/KUrl.html">KUrl</a> url)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setData">setData</a> (self, QString url)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setDefaultUrlScheme">setDefaultUrlScheme</a> (self, QString a0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setSearchFilteringOptions">setSearchFilteringOptions</a> (self, <a href="../kio/KUriFilterData.html">KUriFilterData.SearchFilterOptions</a> options)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#typedString">typedString</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KUrl.html">KUrl</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#uri">uri</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kio/KUriFilterData.html#UriTypes">KUriFilterData.UriTypes</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#uriType">uriType</a> (self)</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="KUriFilterData"></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>Default constructor.
</p>
<p>
Creates a UriFilterData object.
</p></div></div><a class="anchor" name="KUriFilterData"></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="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>url</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 KUriFilterData object from the given string.
</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>url</em> </td><td> is the string to be filtered.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="KUriFilterData"></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>url</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 KUriFilterData object from the given string.
</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>url</em> </td><td> is the string to be filtered.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="KUriFilterData"></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="../kio/KUriFilterData.html">KUriFilterData</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>
<p>
Creates a KUriFilterData object from another KURIFilterData object.
</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>other</em> </td><td> the uri filter data to be copied.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="absolutePath"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString absolutePath</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 absolute path if one has already been set.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the absolute path, or QString()
</dd></dl> </p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> hasAbsolutePath()
</dd></dl>
</p></div></div><a class="anchor" name="allQueriesForSearchProvider"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QStringList allQueriesForSearchProvider</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>provider</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Returns all the query urls for the given search provider.
</p>
<p>
Use this function to obtain all the different queries that can be used
for the given provider. For example, if a search engine provider named
"foobar" has web shortcuts named "foobar", "foo" and "bar", then this
function, unlike queryForPreferredSearchProvider, will return a
a query for each and every web shortcut.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> queryForPreferredSearchProvider
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.6
</dd></dl>
</p></div></div><a class="anchor" name="alternateDefaultSearchProvider"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString alternateDefaultSearchProvider</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 search provider to use when a default provider is not available.
</p>
<p>
This function returns an empty string if setAlternateDefaultSearchProvider
was not called to set the default search provider to be used when none has been
chosen by the user through the search configuration module.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> setAlternateDefaultSearchProvider
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.5
</dd></dl>
</p></div></div><a class="anchor" name="alternateSearchProviders"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QStringList alternateSearchProviders</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 list of alternate search providers.
</p>
<p>
This function returns an empty list if setAlternateSearchProviders
was not called to set the alternate search providers to be when no
preferred providers have been chosen by the user through the search
configuration module.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> setAlternatteSearchProviders
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> preferredSearchProviders
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.5
</dd></dl>
</p></div></div><a class="anchor" name="argsAndOptions"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString argsAndOptions</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 command line options and arguments for a local resource
when present.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> options and arguments when present, otherwise QString()
</dd></dl>
</p></div></div><a class="anchor" name="checkForExecutables"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool checkForExecutables</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 filters should attempt to check whether the
supplied uri is an executable. False otherwise.
</dd></dl>
</p></div></div><a class="anchor" name="defaultUrlScheme"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString defaultUrlScheme</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 default protocol to use when filtering potentially valid url inputs.
</p>
<p>
By default this function will return an empty string.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> setDefaultUrlScheme
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.6
</dd></dl>
</p></div></div><a class="anchor" name="errorMsg"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString errorMsg</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 an error message.
</p>
<p>
This functions returns the error message set by the plugin whenever the
uri type is set to KUriFilterData.ERROR. Otherwise, it returns a NULL
string.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the error message or a NULL when there is none.
</dd></dl>
</p></div></div><a class="anchor" name="hasAbsolutePath"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool hasAbsolutePath</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>Checks whether the supplied data had an absolute path.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> true if the supplied data has an absolute path
</dd></dl> </p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> absolutePath()
</dd></dl>
</p></div></div><a class="anchor" name="hasArgsAndOptions"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool hasArgsAndOptions</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>Checks whether the current data is a local resource with command line
options and arguments.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> true if the current data has command line options and arguments
</dd></dl>
</p></div></div><a class="anchor" name="iconName"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString iconName</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 name of the icon that matches the current filtered URL.
</p>
<p>
This function returns a null string by default and when no icon is found
for the filtered URL.
</p></div></div><a class="anchor" name="iconNameForPreferredSearchProvider"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString iconNameForPreferredSearchProvider</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>provider</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 icon associated with the given preferred search provider.
</p>
<p>
You can use this function to obtain the icon names associated with the
preferred search providers returned by preferredSearchProviders.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> preferredSearchProviders
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.5
</dd></dl>
</p></div></div><a class="anchor" name="preferredSearchProviders"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QStringList preferredSearchProviders</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 list of the names of preferred or available search providers.
</p>
<p>
This function returns the list of providers marked as preferred whenever
the input data, i.e. typedString, is successfully filtered.
</p>
<p>
If no default search provider has been selected prior to a filter request,
this function will return an empty list. To avoid this problem you must
either set an alternate default search provider using setAlternateDefaultSearchProvider
or set one of the SearchFilterOption flags if you are only interested
in getting the list of providers and not filtering the input.
</p>
<p>
Additionally, you can also provide alternate search providers in case
there are no preferred ones already selected.
</p>
<p>
You can use queryForPreferredServiceProvider to obtain the query
associated with the list of search providers returned by this function.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> setAlternateSearchProviders
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> setAlternateDefaultSearchProvider
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> setSearchFilteringOption
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> queryForPreferredServiceProvider
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.5
</dd></dl>
</p></div></div><a class="anchor" name="queryForPreferredSearchProvider"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString queryForPreferredSearchProvider</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>provider</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 web shortcut url for the given preferred search provider.
</p>
<p>
You can use this function to obtain the query for the preferred search
providers returned by preferredSearchProviders.
</p>
<p>
The query returned by this function is in web shortcut format, i.e.
"gg:foo bar", and must be re-filtered through KUriFilter to obtain a
valid url.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> preferredSearchProviders
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.5
</dd></dl>
</p></div></div><a class="anchor" name="queryForSearchProvider"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kio/KUriFilterSearchProvider.html">KUriFilterSearchProvider</a> queryForSearchProvider</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>provider</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Returns information about <b>provider.</b>
</p>
<p>
You can use this function to obtain the more information about the search
providers returned by preferredSearchProviders.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> preferredSearchProviders
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> KUriFilterSearchProvider
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.6
</dd></dl>
</p></div></div><a class="anchor" name="searchFilteringOptions"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kio/KUriFilterData.html">KUriFilterData.SearchFilterOptions</a> searchFilteringOptions</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 specified search filter options.
</p>
<p>
By default this function returns SearchFilterOptionNone.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> setSearchFilteringOptions
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.6
</dd></dl>
</p></div></div><a class="anchor" name="searchProvider"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString searchProvider</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 name of the search service provider, e.g. Google.
</p>
<p>
If typedString was not filtered by a search filter plugin, this
function returns an empty string.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> typedString
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.5
</dd></dl>
</p></div></div><a class="anchor" name="searchTerm"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString searchTerm</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 search term portion of the typed string.
</p>
<p>
If the typedString was not filtered by a search filter plugin, this
function returns an empty string.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> typedString
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.5
</dd></dl>
</p></div></div><a class="anchor" name="searchTermSeparator"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QChar searchTermSeparator</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 character that is used to separate the search term from the
keyword.
</p>
<p>
If typedString was not filtered by a search filter plugin, this
function returns a null charater.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> typedString
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.5
</dd></dl>
</p></div></div><a class="anchor" name="setAbsolutePath"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool setAbsolutePath</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>abs_path</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 absolute path to be used whenever the supplied data is a
relative local URL.
</p>
<p>
NOTE: This function should only be used for local resources, i.e. the
"file:/" protocol. It is useful for specifying the absolute path in
cases where the actual URL might be relative. If deriving the path from
a KUrl, make sure you set the argument for this function to the result
of calling path () instead of url ().
</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>abs_path</em> </td><td> the abolute path to the local resource.
</td></tr>
</table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true if absolute path is successfully set. Otherwise, false.
</dd></dl>
</p></div></div><a class="anchor" name="setAlternateDefaultSearchProvider"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setAlternateDefaultSearchProvider</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>provider</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 search provider to use in case no default provider is available.
</p>
<p>
The default search provider set using this function will only be used if
the default and favorite search providers have not yet been selected by
the user. Otherwise, the default provider specified by through function
will be ignored.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> alternateDefaultSearchProvider
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> preferredSearchProviders
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.5
</dd></dl>
</p></div></div><a class="anchor" name="setAlternateSearchProviders"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setAlternateSearchProviders</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>providers</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Sets a list of search providers to use in case no preferred search
providers are available.
</p>
<p>
The list of preferred search providers set using this function will only
be used if the default and favorite search providers have not yet been
selected by the user. Otherwise, the providers specified through this
function will be ignored.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> alternateSearchProviders
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> preferredSearchProviders
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.5
</dd></dl>
</p></div></div><a class="anchor" name="setCheckForExecutables"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setCheckForExecutables</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>check</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Check whether the provided uri is executable or not.
</p>
<p>
Setting this to false ensures that typing the name of an executable does
not start that application. This is useful in the location bar of a
browser. The default value is true.
</p></div></div><a class="anchor" name="setData"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setData</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/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>url</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 URL to be filtered.
</p>
<p>
Use this function to set the string to be
filtered when you construct an empty filter
object.
</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>url</em> </td><td> the string to be filtered.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setData"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setData</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>url</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 URL to be filtered.
</p>
<p>
Use this function to set the string to be
filtered when you construct an empty filter
object.
</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>url</em> </td><td> the string to be filtered.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setDefaultUrlScheme"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setDefaultUrlScheme</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>a0</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 scheme used when filtering potentially valid url inputs.
</p>
<p>
Use this function to change the default protocol used when filtering
potentially valid url inputs. The default protocol is http.
</p>
<p>
If the scheme is specified without a separator, then "://" will be used
as the separator by default. For example, if the default url scheme was
simply set to "ftp", then a potentially valid url input such as "kde.org"
will be filtered to "ftp://kde.org".
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> defaultUrlScheme
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.6
</dd></dl>
</p></div></div><a class="anchor" name="setSearchFilteringOptions"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setSearchFilteringOptions</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="../kio/KUriFilterData.html">KUriFilterData.SearchFilterOptions</a> </td>
<td class="paramname"><em>options</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 options used by search filter plugins to filter requests.
</p>
<p>
The default search filter option is SearchFilterOptionNone. See
SearchFilterOption for the description of the other flags.
</p>
<p>
It is important to note that the options set through this function can
prevent any filtering from being performed by search filter plugins.
As such, uriTypes can return KUriFilterData.Unknown and uri
can return an invalid url eventhough the filtering request returned
a successful response.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> searchFilteringOptions
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.6
</dd></dl>
</p></div></div><a class="anchor" name="typedString"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString typedString</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 string as typed by the user, before any URL processing is done.
</p></div></div><a class="anchor" name="uri"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdecore/KUrl.html">KUrl</a> uri</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 filtered or the original URL.
</p>
<p>
If one of the plugins successfully filtered the original input, this
function returns it. Otherwise, it will return the input itself.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the filtered or original url.
</dd></dl>
</p></div></div><a class="anchor" name="uriType"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kio/KUriFilterData.html#UriTypes">KUriFilterData.UriTypes</a> uriType</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 URI type.
</p>
<p>
This method always returns KUriFilterData.UNKNOWN if the given URL was
not filtered.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the type of the URI
</dd></dl>
</p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="SearchFilterOption"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">SearchFilterOption</td>
</tr>
</table>
</div>
<div class="memdoc"><p>This enum describes the search filtering options to be used.
</p>
<p>
<li> SearchFilterOptionNone </li>
No search filter options are set and normal filtering is performed
on the input data.
<li> RetrieveSearchProvidersOnly </li>
If set, the list of all available search providers are returned without
any input filtering. This flag only applies when used in conjunction
with the KUriFilter.NormalTextFilter flag.
<li> RetrievePreferredSearchProvidersOnly </li>
If set, the list of preferred search providers are returned without
any input filtering. This flag only applies when used in conjunction
with the KUriFilter.NormalTextFilter flag.
<li> RetrieveAvailableSearchProvidersOnly </li>
Same as doing RetrievePreferredSearchProvidersOnly | RetrieveSearchProvidersOnly,
where all available search providers are returned if no preferred ones
ones are available. No input filtering will be performed.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> setSearchFilteringOptions
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> KUriFilter.filterSearchUri
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.6
</dd></dl>
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>SearchFilterOptionNone</em> = 0x0</td><td><tr><td valign="top"><em>RetrieveSearchProvidersOnly</em> = 0x01</td><td><tr><td valign="top"><em>RetrievePreferredSearchProvidersOnly</em> = 0x02</td><td><tr><td valign="top"><em>RetrieveAvailableSearchProvidersOnly</em> = (RetrievePreferredSearchProvidersOnly|RetrieveSearchProvidersOnly)</td><td></table>
</dl>
</div></div><p><a class="anchor" name="UriTypes"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">UriTypes</td>
</tr>
</table>
</div>
<div class="memdoc"><p>Describes the type of the URI that was filtered.
Here is a brief description of the types:
</p>
<p>
<li> NetProtocol - Any network protocol: http, ftp, nttp, pop3, etc... </li>
<li> LocalFile - A local file whose executable flag is not set </li>
<li> LocalDir - A local directory </li>
<li> Executable - A local file whose executable flag is set </li>
<li> Help - A man or info page </li>
<li> Shell - A shell executable (ex: echo "Test..." >> ~/testfile) </li>
<li> Blocked - A URI that should be blocked/filtered (ex: ad filtering) </li>
<li> Error - An incorrect URI (ex: "~johndoe" when user johndoe </li>
does not exist in that system )
<li> Unknown - A URI that is not identified. Default value when </li>
a KUriFilterData is first created.
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>NetProtocol</em> = 0</td><td><tr><td valign="top"><em>LocalFile</em> </td><td><tr><td valign="top"><em>LocalDir</em> </td><td><tr><td valign="top"><em>Executable</em> </td><td><tr><td valign="top"><em>Help</em> </td><td><tr><td valign="top"><em>Shell</em> </td><td><tr><td valign="top"><em>Blocked</em> </td><td><tr><td valign="top"><em>Error</em> </td><td><tr><td valign="top"><em>Unknown</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>
