Sophie

Sophie

distrib > Fedora > 13 > x86_64 > media > updates > by-pkgid > fc669c0115c2f74e1d26807f2cb98f7a > files > 54

soprano-apidocs-2.5.2-1.fc13.noarch.rpm

<!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::Client::DBusClient 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&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;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&nbsp;List</span></a></li>
      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;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="namespaceSoprano_1_1Client.html">Client</a>      </li>
      <li><a class="el" href="classSoprano_1_1Client_1_1DBusClient.html">Soprano::Client::DBusClient</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<h1>Soprano::Client::DBusClient Class Reference</h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="Soprano::Client::DBusClient" --><!-- doxytag: inherits="QObject,Soprano::Error::ErrorCache" -->
<p>Core class to handle a connection to a <a class="el" href="namespaceSoprano.html">Soprano</a> server through the DBus interface.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="dbusclient_8h_source.html">Soprano/Client/DBusClient</a>&gt;</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::Client::DBusClient:</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_1Client_1_1DBusClient__inherit__graph.png" border="0" usemap="#Soprano_1_1Client_1_1DBusClient_inherit__map" alt="Inheritance graph"/></div>
<map name="Soprano_1_1Client_1_1DBusClient_inherit__map" id="Soprano_1_1Client_1_1DBusClient_inherit__map">
<area shape="rect" id="node2" href="qobject.html" title="QObject" alt="" coords="5,5,75,35"/><area shape="rect" id="node4" href="classSoprano_1_1Error_1_1ErrorCache.html" title="Core class of Soprano&#39;s exception system." alt="" coords="99,5,277,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classSoprano_1_1Client_1_1DBusClient-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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Client_1_1DBusClient.html#a589722a9bc1dbbda4ac49a0f67ef2cd3">DBusClient</a> (const <a class="elRef" href="qstring.html">QString</a> &amp;service=<a class="elRef" href="qstring.html">QString</a>(), <a class="elRef" href="qobject.html">QObject</a> *<a class="elRef" href="qobject.html#parent">parent</a>=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Client_1_1DBusClient.html#aaeba82a4ad15af42bf7eb5430adc917c">~DBusClient</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Client_1_1DBusClient.html#a0cffac33d0ef1d1a7156e8fe8bece0d9">isValid</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="qstringlist.html">QStringList</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Client_1_1DBusClient.html#ac0a2a2c7a6f03ebe02901d417b2e74f1">allModels</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classSoprano_1_1Client_1_1DBusModel.html">DBusModel</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Client_1_1DBusClient.html#a6dcdb072fecdbe458bcbdbcfdf31f6c3">createModel</a> (const <a class="elRef" href="qstring.html">QString</a> &amp;<a class="elRef" href="qobject.html#name">name</a>, const <a class="elRef" href="qlist.html">BackendSettings</a> &amp;settings=<a class="elRef" href="qlist.html">BackendSettings</a>())</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Client_1_1DBusClient.html#a7705349dbb52610f786ee8c16ff4de53">removeModel</a> (const <a class="elRef" href="qstring.html">QString</a> &amp;<a class="elRef" href="qobject.html#name">name</a>)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Core class to handle a connection to a <a class="el" href="namespaceSoprano.html">Soprano</a> server through the DBus interface. </p>
<p><a class="el" href="classSoprano_1_1Client_1_1DBusClient.html" title="Core class to handle a connection to a Soprano server through the DBus interface.">DBusClient</a> creates a connection to a running <a class="el" href="namespaceSoprano.html">Soprano</a> <a class="el" href="namespaceSoprano_1_1Server.html">Server</a> via its DBus interface. All DBus communication is handled internally.</p>
<p>See <a class="el" href="classSoprano_1_1Client_1_1DBusModel.html" title="Interface to a DBus server model.">DBusModel</a> for details about thread-safety.</p>
<dl class="author"><dt><b>Author:</b></dt><dd>Sebastian Trueg &lt;<a href="mailto:trueg@kde.org">trueg@kde.org</a>&gt;</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="soprano_server_dbus.html">Soprano D-Bus Interface</a> </dd></dl>

<p>Definition at line <a class="el" href="dbusclient_8h_source.html#l00054">54</a> of file <a class="el" href="dbusclient_8h_source.html">dbusclient.h</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a589722a9bc1dbbda4ac49a0f67ef2cd3"></a><!-- doxytag: member="Soprano::Client::DBusClient::DBusClient" ref="a589722a9bc1dbbda4ac49a0f67ef2cd3" args="(const QString &amp;service=QString(), QObject *parent=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Soprano::Client::DBusClient::DBusClient </td>
          <td>(</td>
          <td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>service</em> = <code><a class="elRef" href="qstring.html">QString</a>()</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="elRef" href="qobject.html">QObject</a> *&nbsp;</td>
          <td class="paramname"> <em>parent</em> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Create a new DBus client.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>service</em>&nbsp;</td><td>The DBus service name. If empty the client will use the default <a class="el" href="namespaceSoprano.html">Soprano</a> service name. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>parent</em>&nbsp;</td><td>The parent object. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="aaeba82a4ad15af42bf7eb5430adc917c"></a><!-- doxytag: member="Soprano::Client::DBusClient::~DBusClient" ref="aaeba82a4ad15af42bf7eb5430adc917c" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Soprano::Client::DBusClient::~DBusClient </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Destructor </p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a0cffac33d0ef1d1a7156e8fe8bece0d9"></a><!-- doxytag: member="Soprano::Client::DBusClient::isValid" ref="a0cffac33d0ef1d1a7156e8fe8bece0d9" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Soprano::Client::DBusClient::isValid </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Check if the service is valid and available.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if the <a class="el" href="namespaceSoprano.html">Soprano</a> server service could be found and used. Otherwise returns <code>false</code>. </dd></dl>

</div>
</div>
<a class="anchor" id="ac0a2a2c7a6f03ebe02901d417b2e74f1"></a><!-- doxytag: member="Soprano::Client::DBusClient::allModels" ref="ac0a2a2c7a6f03ebe02901d417b2e74f1" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="elRef" href="qstringlist.html">QStringList</a> Soprano::Client::DBusClient::allModels </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Retrive a list of all models that are available.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A list of model names to be used with <a class="el" href="classSoprano_1_1Client_1_1DBusClient.html#a6dcdb072fecdbe458bcbdbcfdf31f6c3">createModel()</a> </dd></dl>

</div>
</div>
<a class="anchor" id="a6dcdb072fecdbe458bcbdbcfdf31f6c3"></a><!-- doxytag: member="Soprano::Client::DBusClient::createModel" ref="a6dcdb072fecdbe458bcbdbcfdf31f6c3" args="(const QString &amp;name, const BackendSettings &amp;settings=BackendSettings())" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classSoprano_1_1Client_1_1DBusModel.html">DBusModel</a>* Soprano::Client::DBusClient::createModel </td>
          <td>(</td>
          <td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="elRef" href="qlist.html">BackendSettings</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>settings</em> = <code><a class="elRef" href="qlist.html">BackendSettings</a>()</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Creates a new <a class="el" href="classSoprano_1_1Model.html" title="A Model is the central class in Soprano. It is a queryable collection of RDF quadruples, i.e statements.">Model</a> instance that wraps a dbus server model.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>name</em>&nbsp;</td><td>The name of the model to access. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>settings</em>&nbsp;</td><td>Settings for future extension. Not used yet.</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A new <a class="el" href="classSoprano_1_1Model.html" title="A Model is the central class in Soprano. It is a queryable collection of RDF quadruples, i.e statements.">Model</a> instance wrapping the requested server model or 0 on error (check <a class="el" href="classSoprano_1_1Error_1_1ErrorCache.html#a3251b8052cdf932d59a523ca215d21c9">lastError()</a> for details.) </dd></dl>

</div>
</div>
<a class="anchor" id="a7705349dbb52610f786ee8c16ff4de53"></a><!-- doxytag: member="Soprano::Client::DBusClient::removeModel" ref="a7705349dbb52610f786ee8c16ff4de53" args="(const QString &amp;name)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Soprano::Client::DBusClient::removeModel </td>
          <td>(</td>
          <td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>name</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Deletes a model including all its data.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>name</em>&nbsp;</td><td>The name of the model to remove.</td></tr>
  </table>
  </dd>
</dl>
<dl class="warning"><dt><b>Warning:</b></dt><dd>Calling this method will remove all data physically. It can not be reverted. Use with care. </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/client/dbus/<a class="el" href="dbusclient_8h_source.html">dbusclient.h</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Thu Oct 21 2010 for Soprano by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional