<!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"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>Soprano: Soprano::Plugin Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.7.1 --> <script type="text/javascript"> function hasClass(ele,cls) { return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)')); } function addClass(ele,cls) { if (!this.hasClass(ele,cls)) ele.className += " "+cls; } function removeClass(ele,cls) { if (hasClass(ele,cls)) { var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)'); ele.className=ele.className.replace(reg,' '); } } function toggleVisibility(linkObj) { var base = linkObj.getAttribute('id'); var summary = document.getElementById(base + '-summary'); var content = document.getElementById(base + '-content'); var trigger = document.getElementById(base + '-trigger'); if ( hasClass(linkObj,'closed') ) { summary.style.display = 'none'; content.style.display = 'block'; trigger.src = 'open.png'; removeClass(linkObj,'closed'); addClass(linkObj,'opened'); } else if ( hasClass(linkObj,'opened') ) { summary.style.display = 'block'; content.style.display = 'none'; trigger.src = 'closed.png'; removeClass(linkObj,'opened'); addClass(linkObj,'closed'); } return false; } </script> <div class="navigation" id="top"> <div class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div class="navpath"> <ul> <li><a class="el" href="namespaceSoprano.html">Soprano</a> </li> <li><a class="el" href="classSoprano_1_1Plugin.html">Soprano::Plugin</a> </li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pro-methods">Protected Member Functions</a> </div> <div class="headertitle"> <h1>Soprano::Plugin Class Reference</h1> </div> </div> <div class="contents"> <!-- doxytag: class="Soprano::Plugin" --> <p>Base class for all plugins in Soprano. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="plugin_8h_source.html">Soprano/Plugin</a>></code></p> <div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"> <img id="dynsection-0-trigger" src="closed.png"/> Inheritance diagram for Soprano::Plugin:</div> <div id="dynsection-0-summary" class="dynsummary" style="display:block;"> </div> <div id="dynsection-0-content" class="dyncontent" style="display:none;"> <div class="center"><img src="classSoprano_1_1Plugin__inherit__graph.png" border="0" usemap="#Soprano_1_1Plugin_inherit__map" alt="Inheritance graph"/></div> <map name="Soprano_1_1Plugin_inherit__map" id="Soprano_1_1Plugin_inherit__map"> <area shape="rect" id="node3" href="classSoprano_1_1Backend.html" title="Soprano::Backend defines the interface for a Soprano backend plugin." alt="" coords="5,83,133,112"/><area shape="rect" id="node5" href="classSoprano_1_1Parser.html" title="Soprano::Parser defines the interface for a Soprano RDF parser plugin." alt="" coords="157,83,272,112"/><area shape="rect" id="node7" href="classSoprano_1_1Serializer.html" title="Soprano::Serializer defines the interface for a Soprano RDF serializer plugin." alt="" coords="296,83,427,112"/></map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <p><a href="classSoprano_1_1Plugin-members.html">List of all members.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Plugin.html#aad89b8ea49ab54480aeb9e3d2da65899">~Plugin</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="qstring.html">QString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Plugin.html#af4b122812c4f0cbbb386673db5425532">pluginName</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Plugin.html#a8079e2eadef0f3d6f51648e2411c3c18">isAvailable</a> () const </td></tr> <tr><td colspan="2"><h2><a name="pro-methods"></a> Protected Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Plugin.html#a98c9ab9f4a762252a3fc821567a05041">Plugin</a> (const <a class="elRef" href="qstring.html">QString</a> &name)</td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>Base class for all plugins in Soprano. </p> <p>Each Soprano Plugin has a name which can be read via <a class="el" href="classSoprano_1_1Plugin.html#af4b122812c4f0cbbb386673db5425532">pluginName()</a>.</p> <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classSoprano_1_1PluginManager.html" title="The PluginManager loads and maintains all Soprano plugins.">Soprano::PluginManager</a></dd></dl> <dl class="author"><dt><b>Author:</b></dt><dd>Sebastian Trueg <<a href="mailto:trueg@kde.org">trueg@kde.org</a>> </dd></dl> <p>Definition at line <a class="el" href="plugin_8h_source.html#l00044">44</a> of file <a class="el" href="plugin_8h_source.html">plugin.h</a>.</p> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="aad89b8ea49ab54480aeb9e3d2da65899"></a><!-- doxytag: member="Soprano::Plugin::~Plugin" ref="aad89b8ea49ab54480aeb9e3d2da65899" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual Soprano::Plugin::~Plugin </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a98c9ab9f4a762252a3fc821567a05041"></a><!-- doxytag: member="Soprano::Plugin::Plugin" ref="a98c9ab9f4a762252a3fc821567a05041" args="(const QString &name)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Soprano::Plugin::Plugin </td> <td>(</td> <td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td> <td class="paramname"> <em>name</em></td> <td> ) </td> <td><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="af4b122812c4f0cbbb386673db5425532"></a><!-- doxytag: member="Soprano::Plugin::pluginName" ref="af4b122812c4f0cbbb386673db5425532" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" href="qstring.html">QString</a> Soprano::Plugin::pluginName </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a8079e2eadef0f3d6f51648e2411c3c18"></a><!-- doxytag: member="Soprano::Plugin::isAvailable" ref="a8079e2eadef0f3d6f51648e2411c3c18" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual bool Soprano::Plugin::isAvailable </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>This method can be reimplemented by plugins that need to do additional run-time checks before they can be used.</p> <p>The default implementation returns <code>true</code>.</p> <dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if the plugin can be used. </dd></dl> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li>/builddir/build/BUILD/soprano-2.5.2/soprano/<a class="el" href="plugin_8h_source.html">plugin.h</a></li> </ul> </div> <hr class="footer"/><address class="footer"><small>Generated on Thu Oct 21 2010 for Soprano by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address> </body> </html>