<?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>KMimeTypeTrader</title> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta http-equiv="Content-Style-Type" content="text/css" /> <link rel="stylesheet" type="text/css" href="../common/doxygen.css" /> <link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../common/kde.css" /> </head> <body> <div id="container"> <div id="header"> <div id="header_top"> <div> <div> <img alt ="" src="../common/top-kde.jpg"/> KDE 4.4 PyKDE API Reference </div> </div> </div> <div id="header_bottom"> <div id="location"> <ul> <li>KDE's Python API</li> </ul> </div> <div id="menu"> <ul> <li><a href="../modules.html">Overview</a></li> <li><a href="http://techbase.kde.org/Development/Languages/Python">PyKDE Home</a></li> <li><a href="http://kde.org/family/">Sitemap</a></li> <li><a href="http://kde.org/contact/">Contact Us</a></li> </ul> </div> </div> </div> <div id="body_wrapper"> <div id="body"> <div id="right"> <div class="content"> <div id="main"> <div class="clearer"> </div> <h1>KMimeTypeTrader Class Reference</h1> <code>from PyKDE4.kdecore import *</code> <p> <h2>Detailed Description</h2> <p>KDE's trader for services associated to a given mimetype. </p> <p> Example: say that you want to the list of all KParts components that can handle HTML. Our code would look like: <pre class="fragment"> KService.List lst = KMimeTypeTrader.self()->query("text/html", "KParts/ReadOnlyPart"); </pre> </p> <p> If you want to get the preferred KParts component for text/html you could use preferredService("text/html", "KParts/ReadOnlyPart"), although if this is about loading that component you would use createPartInstanceFromQuery directly. </p> <p> <dl class="see" compact><dt><b>See also:</b></dt><dd> KServiceTypeTrader, KService </dd></dl> </p> <table border="0" cellpadding="0" cellspacing="0"><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="#KMimeTypeTrader">__init__</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KMimeTypeTrader">__init__</a> (self, <a href="../kdecore/KMimeTypeTrader.html">KMimeTypeTrader</a> other)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KService.Ptr.html">KService.Ptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#preferredService">preferredService</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> mimeType, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> genericServiceType=QString.fromLatin1("Application"))</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KService.List.html">KService.List</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#query">query</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> mimeType, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> genericServiceType=QString.fromLatin1("Application"), <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> constraint=QString())</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KMimeTypeTrader.html">KMimeTypeTrader</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#self">self</a> (self)</td></tr> </table> <hr><h2>Method Documentation</h2><a class="anchor" name="KMimeTypeTrader"></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><dl class="internal" compact><dt><b>Internal:</b></dt><dd> </dd></dl> </p></div></div><a class="anchor" name="KMimeTypeTrader"></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/KMimeTypeTrader.html">KMimeTypeTrader</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="preferredService"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../kdecore/KService.Ptr.html">KService.Ptr</a> preferredService</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="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td> <td class="paramname"><em>mimeType</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td> <td class="paramname"><em>genericServiceType=QString.fromLatin1("Application")</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 preferred service for <b>mimeType</b> and <b>genericServiceType</b> </p> <p> This is almost like offers().first(), except that it also checks if the service is allowed as a preferred service (see KService.allowAsDefault). </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>mimeType</em> </td><td> the mime type (see offers()) <tr><td></td><td valign="top"><em>genericServiceType</em> </td><td> the service type (see offers()) </td></tr> </table></dl> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> the preferred service, or 0 if no service is available </dd></dl> </p></div></div><a class="anchor" name="query"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../kdecore/KService.List.html">KService.List</a> query</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="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td> <td class="paramname"><em>mimeType</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td> <td class="paramname"><em>genericServiceType=QString.fromLatin1("Application")</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td> <td class="paramname"><em>constraint=QString()</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>This method returns a list of services which are associated with a given mimetype. </p> <p> Example usage: To get list of applications that can handle a given mimetype, set <b>genericServiceType</b> to "Application" (which is the default). To get list of embeddable components that can handle a given mimetype, set <b>genericServiceType</b> to "KParts/ReadOnlyPart". </p> <p> The constraint parameter is used to limit the possible choices returned based on the constraints you give it. </p> <p> The <b>constraint</b> language is rather full. The most common keywords are AND, OR, NOT, IN, and EXIST, all used in an almost spoken-word form. An example is: <pre class="fragment"> (Type == 'Service') and (('Browser/View' in ServiceTypes) and (exist Library)) </pre> </p> <p> The keys used in the query (Type, ServiceTypes, Library) are all fields found in the .desktop files. </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>mimeType</em> </td><td> A mime type like 'text/plain' or 'text/html'. <tr><td></td><td valign="top"><em>genericServiceType</em> </td><td> a basic service type, like 'KParts/ReadOnlyPart' or 'Application' <tr><td></td><td valign="top"><em>constraint</em> </td><td> A constraint to limit the choices returned, QString() to get all services that can handle the given <b>mimetype</b> </td></tr> </table></dl> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> A list of services that satisfy the query, sorted by preference (preferred service first) </dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> http://techbase.kde.org/Development/Tutorials/Services/Traders#The_KTrader_Query_Language </dd></dl> </p></div></div><a class="anchor" name="self"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../kdecore/KMimeTypeTrader.html">KMimeTypeTrader</a> self</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>This is a static pointer to the KMimeTypeTrader singleton. </p> <p> You will need to use this to access the KMimeTypeTrader functionality since the constructors are protected. </p> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> Static KMimeTypeTrader instance </dd></dl> </p></div></div> </div> </div> </div> <div id="left"> <div class="menu_box"> <div class="nav_list"> <ul> <li><a href="../allclasses.html">Full Index</a></li> </ul> </div> <a name="cp-menu" /><div class="menutitle"><div> <h2 id="cp-menu-project">Modules</h2> </div></div> <div class="nav_list"> <ul><li><a href="../akonadi/index.html">akonadi</a></li> <li><a href="../dnssd/index.html">dnssd</a></li> <li><a href="../kdecore/index.html">kdecore</a></li> <li><a href="../kdeui/index.html">kdeui</a></li> <li><a href="../khtml/index.html">khtml</a></li> <li><a href="../kio/index.html">kio</a></li> <li><a href="../knewstuff/index.html">knewstuff</a></li> <li><a href="../kparts/index.html">kparts</a></li> <li><a href="../kutils/index.html">kutils</a></li> <li><a href="../nepomuk/index.html">nepomuk</a></li> <li><a href="../phonon/index.html">phonon</a></li> <li><a href="../plasma/index.html">plasma</a></li> <li><a href="../polkitqt/index.html">polkitqt</a></li> <li><a href="../solid/index.html">solid</a></li> <li><a href="../soprano/index.html">soprano</a></li> </ul></div></div> </div> </div> <div class="clearer"/> </div> <div id="end_body"></div> </div> <div id="footer"><div id="footer_text"> This documentation is maintained by <a href="mailto:simon@simonzone.com">Simon Edwards</a>.<br /> KDE<sup>®</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>®</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> | <a href="http://www.kde.org/contact/impressum.php">Legal</a> </div></div> </body> </html>