<!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::BackendSetting 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_1BackendSetting.html">Soprano::BackendSetting</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#related">Related Functions</a> </div>
<div class="headertitle">
<h1>Soprano::BackendSetting Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Soprano::BackendSetting" -->
<p>Wraps one setting for <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> creation.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="backend_8h_source.html">Soprano/BackendSetting</a>></code></p>
<p><a href="classSoprano_1_1BackendSetting-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1BackendSetting.html#a2bb731896ac1ca00b919373b79687786">BackendSetting</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1BackendSetting.html#a15e3834fbb17e678a877cc7757f05677">BackendSetting</a> (<a class="el" href="namespaceSoprano.html#ae82decb95b689a7c1252e735981b7fb2">BackendOption</a> option)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1BackendSetting.html#a358acf0051c32e07f0fc39790dd1044b">BackendSetting</a> (<a class="el" href="namespaceSoprano.html#ae82decb95b689a7c1252e735981b7fb2">BackendOption</a> s, const <a class="elRef" href="qvariant.html">QVariant</a> &value_)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1BackendSetting.html#aabb00e62ae7579246f49b38978110055">BackendSetting</a> (const <a class="elRef" href="qstring.html">QString</a> &userOption, const <a class="elRef" href="qvariant.html">QVariant</a> &value_)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1BackendSetting.html#aaf23eb9616beaec997b63f4af0d8b251">BackendSetting</a> (const <a class="el" href="classSoprano_1_1BackendSetting.html">BackendSetting</a> &other)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1BackendSetting.html#a0e9bcc96d8addc8024e93a0588f73533">~BackendSetting</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classSoprano_1_1BackendSetting.html">BackendSetting</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1BackendSetting.html#ac6ba39878e84cb90784033133680e767">operator=</a> (const <a class="el" href="classSoprano_1_1BackendSetting.html">BackendSetting</a> &other)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceSoprano.html#ae82decb95b689a7c1252e735981b7fb2">BackendOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1BackendSetting.html#a9c5e45ef33872f6299059789ba339592">option</a> () const </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_1BackendSetting.html#aacbc7b4b566792b5fd21a0e7d727e779">userOptionName</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="qvariant.html">QVariant</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1BackendSetting.html#a3d1f29bd8be088007a66361a2a30d15a">value</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1BackendSetting.html#aa41f4a5a715115b16f6909d9a01e16eb">setValue</a> (const <a class="elRef" href="qvariant.html">QVariant</a> &value)</td></tr>
<tr><td colspan="2"><h2><a name="related"></a>
Related Functions</h2></td></tr>
<tr><td colspan="2"><p>(Note that these are not member functions.) </p>
<br/><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SOPRANO_EXPORT bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1BackendSetting.html#ac74f8e6a28e49ff4a62851684365971a">isOptionInSettings</a> (const <a class="elRef" href="qlist.html">BackendSettings</a> &settings, <a class="el" href="namespaceSoprano.html#ae82decb95b689a7c1252e735981b7fb2">BackendOption</a> option, const <a class="elRef" href="qstring.html">QString</a> &userOptionName=<a class="elRef" href="qstring.html">QString</a>())</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SOPRANO_EXPORT <a class="el" href="classSoprano_1_1BackendSetting.html">BackendSetting</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1BackendSetting.html#abcca1aed3b8d676eae19fb6aef5f52c9">settingInSettings</a> (<a class="elRef" href="qlist.html">BackendSettings</a> &settings, <a class="el" href="namespaceSoprano.html#ae82decb95b689a7c1252e735981b7fb2">BackendOption</a> option, const <a class="elRef" href="qstring.html">QString</a> &userOptionName=<a class="elRef" href="qstring.html">QString</a>())</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SOPRANO_EXPORT <a class="el" href="classSoprano_1_1BackendSetting.html">BackendSetting</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1BackendSetting.html#adf806f8fa2240527d38e34b024e9b21a">settingInSettings</a> (<a class="elRef" href="qlist.html">BackendSettings</a> &settings, const <a class="elRef" href="qstring.html">QString</a> &userOptionName)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SOPRANO_EXPORT <a class="el" href="classSoprano_1_1BackendSetting.html">BackendSetting</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1BackendSetting.html#ac56d78161cdddfa96cc12b53f55ba4c0">settingInSettings</a> (const <a class="elRef" href="qlist.html">BackendSettings</a> &settings, <a class="el" href="namespaceSoprano.html#ae82decb95b689a7c1252e735981b7fb2">BackendOption</a> option, const <a class="elRef" href="qstring.html">QString</a> &userOptionName=<a class="elRef" href="qstring.html">QString</a>())</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SOPRANO_EXPORT <a class="el" href="classSoprano_1_1BackendSetting.html">BackendSetting</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1BackendSetting.html#acecf21db899dfc4f6f7d5163fe520ce9">settingInSettings</a> (const <a class="elRef" href="qlist.html">BackendSettings</a> &settings, const <a class="elRef" href="qstring.html">QString</a> &userOptionName=<a class="elRef" href="qstring.html">QString</a>())</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SOPRANO_EXPORT <a class="elRef" href="qvariant.html">QVariant</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1BackendSetting.html#a3b1367523802a20e3a911a6e59440b3d">valueInSettings</a> (const <a class="elRef" href="qlist.html">BackendSettings</a> &settings, <a class="el" href="namespaceSoprano.html#ae82decb95b689a7c1252e735981b7fb2">BackendOption</a> option, const <a class="elRef" href="qstring.html">QString</a> &userOptionName=<a class="elRef" href="qstring.html">QString</a>())</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SOPRANO_EXPORT <a class="elRef" href="qvariant.html">QVariant</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1BackendSetting.html#a030afb9e36eb3729031682232a0ba76f">valueInSettings</a> (const <a class="elRef" href="qlist.html">BackendSettings</a> &settings, const <a class="elRef" href="qstring.html">QString</a> &userOptionName, const <a class="elRef" href="qvariant.html">QVariant</a> &defaultValue=<a class="elRef" href="qvariant.html">QVariant</a>())</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SOPRANO_EXPORT <a class="elRef" href="qvariant.html">QVariant</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1BackendSetting.html#adf562d80f3bd67d584417f6e5c51f51e">valueInSettingsWithDefault</a> (const <a class="elRef" href="qlist.html">BackendSettings</a> &settings, <a class="el" href="namespaceSoprano.html#ae82decb95b689a7c1252e735981b7fb2">BackendOption</a> option, const <a class="elRef" href="qvariant.html">QVariant</a> &defaultValue)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Wraps one setting for <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> creation. </p>
<p>A <a class="el" href="classSoprano_1_1BackendSetting.html" title="Wraps one setting for Model creation.">BackendSetting</a> consists of an option type and an option value. The option type can either be a predefined value from <a class="el" href="namespaceSoprano.html#ae82decb95b689a7c1252e735981b7fb2">Soprano::BackendOption</a> or a user defined string value that depends on the <a class="el" href="classSoprano_1_1Backend.html" title="Soprano::Backend defines the interface for a Soprano backend plugin.">Backend</a> implementation. In the latter case option has to be set to <a class="el" href="namespaceSoprano.html#ae82decb95b689a7c1252e735981b7fb2a4ed220736d4c1563ae0186b79ca1e68d">Soprano::BackendOptionUser</a>.</p>
<dl class="author"><dt><b>Author:</b></dt><dd>Sebastian Trueg <<a href="mailto:trueg@kde.org">trueg@kde.org</a>></dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classSoprano_1_1Backend.html#abe4347c68662b53fc2f709b4536febb2">Backend::createModel()</a><br/>
<a class="el" href="namespaceSoprano.html#a47246ff42973d5f78cb21ed7b1e07033">BackendSettings</a> </dd></dl>
<p>Definition at line <a class="el" href="backend_8h_source.html#l00045">45</a> of file <a class="el" href="backend_8h_source.html">backend.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a2bb731896ac1ca00b919373b79687786"></a><!-- doxytag: member="Soprano::BackendSetting::BackendSetting" ref="a2bb731896ac1ca00b919373b79687786" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Soprano::BackendSetting::BackendSetting </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create an empty setting. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="namespaceSoprano.html#ae82decb95b689a7c1252e735981b7fb2a3688df48eb0ec7061717da04ce8e4255">Soprano::BackendOptionNone</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a15e3834fbb17e678a877cc7757f05677"></a><!-- doxytag: member="Soprano::BackendSetting::BackendSetting" ref="a15e3834fbb17e678a877cc7757f05677" args="(BackendOption option)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Soprano::BackendSetting::BackendSetting </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceSoprano.html#ae82decb95b689a7c1252e735981b7fb2">BackendOption</a> </td>
<td class="paramname"> <em>option</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a boolean setting with a default true value. </p>
</div>
</div>
<a class="anchor" id="a358acf0051c32e07f0fc39790dd1044b"></a><!-- doxytag: member="Soprano::BackendSetting::BackendSetting" ref="a358acf0051c32e07f0fc39790dd1044b" args="(BackendOption s, const QVariant &value_)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Soprano::BackendSetting::BackendSetting </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceSoprano.html#ae82decb95b689a7c1252e735981b7fb2">BackendOption</a> </td>
<td class="paramname"> <em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" href="qvariant.html">QVariant</a> & </td>
<td class="paramname"> <em>value_</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a standard setting with option <code>s</code> and value <code>value_</code>. </p>
</div>
</div>
<a class="anchor" id="aabb00e62ae7579246f49b38978110055"></a><!-- doxytag: member="Soprano::BackendSetting::BackendSetting" ref="aabb00e62ae7579246f49b38978110055" args="(const QString &userOption, const QVariant &value_)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Soprano::BackendSetting::BackendSetting </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td>
<td class="paramname"> <em>userOption</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" href="qvariant.html">QVariant</a> & </td>
<td class="paramname"> <em>value_</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a user setting with user option name <code>userOption</code> and value <code>value_</code>. </p>
</div>
</div>
<a class="anchor" id="aaf23eb9616beaec997b63f4af0d8b251"></a><!-- doxytag: member="Soprano::BackendSetting::BackendSetting" ref="aaf23eb9616beaec997b63f4af0d8b251" args="(const BackendSetting &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Soprano::BackendSetting::BackendSetting </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classSoprano_1_1BackendSetting.html">BackendSetting</a> & </td>
<td class="paramname"> <em>other</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Copy constructor. </p>
</div>
</div>
<a class="anchor" id="a0e9bcc96d8addc8024e93a0588f73533"></a><!-- doxytag: member="Soprano::BackendSetting::~BackendSetting" ref="a0e9bcc96d8addc8024e93a0588f73533" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Soprano::BackendSetting::~BackendSetting </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ac6ba39878e84cb90784033133680e767"></a><!-- doxytag: member="Soprano::BackendSetting::operator=" ref="ac6ba39878e84cb90784033133680e767" args="(const BackendSetting &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classSoprano_1_1BackendSetting.html">BackendSetting</a>& Soprano::BackendSetting::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classSoprano_1_1BackendSetting.html">BackendSetting</a> & </td>
<td class="paramname"> <em>other</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Copy operator. </p>
</div>
</div>
<a class="anchor" id="a9c5e45ef33872f6299059789ba339592"></a><!-- doxytag: member="Soprano::BackendSetting::option" ref="a9c5e45ef33872f6299059789ba339592" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceSoprano.html#ae82decb95b689a7c1252e735981b7fb2">BackendOption</a> Soprano::BackendSetting::option </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The option that this setting sets. If <a class="el" href="namespaceSoprano.html#ae82decb95b689a7c1252e735981b7fb2a4ed220736d4c1563ae0186b79ca1e68d">Soprano::BackendOptionUser</a> the option is identified by <a class="el" href="classSoprano_1_1BackendSetting.html#aacbc7b4b566792b5fd21a0e7d727e779">userOptionName()</a>. </p>
</div>
</div>
<a class="anchor" id="aacbc7b4b566792b5fd21a0e7d727e779"></a><!-- doxytag: member="Soprano::BackendSetting::userOptionName" ref="aacbc7b4b566792b5fd21a0e7d727e779" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="qstring.html">QString</a> Soprano::BackendSetting::userOptionName </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The name of the user option if <a class="el" href="classSoprano_1_1BackendSetting.html#a9c5e45ef33872f6299059789ba339592">option()</a> is <a class="el" href="namespaceSoprano.html#ae82decb95b689a7c1252e735981b7fb2a4ed220736d4c1563ae0186b79ca1e68d">Soprano::BackendOptionUser</a>. </p>
</div>
</div>
<a class="anchor" id="a3d1f29bd8be088007a66361a2a30d15a"></a><!-- doxytag: member="Soprano::BackendSetting::value" ref="a3d1f29bd8be088007a66361a2a30d15a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="qvariant.html">QVariant</a> Soprano::BackendSetting::value </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The value of the setting. </p>
</div>
</div>
<a class="anchor" id="aa41f4a5a715115b16f6909d9a01e16eb"></a><!-- doxytag: member="Soprano::BackendSetting::setValue" ref="aa41f4a5a715115b16f6909d9a01e16eb" args="(const QVariant &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Soprano::BackendSetting::setValue </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qvariant.html">QVariant</a> & </td>
<td class="paramname"> <em>value</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the value of the Setting. </p>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="ac74f8e6a28e49ff4a62851684365971a"></a><!-- doxytag: member="Soprano::BackendSetting::isOptionInSettings" ref="ac74f8e6a28e49ff4a62851684365971a" args="(const BackendSettings &settings, BackendOption option, const QString &userOptionName=QString())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SOPRANO_EXPORT bool isOptionInSettings </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qlist.html">BackendSettings</a> & </td>
<td class="paramname"> <em>settings</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceSoprano.html#ae82decb95b689a7c1252e735981b7fb2">BackendOption</a> </td>
<td class="paramname"> <em>option</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td>
<td class="paramname"> <em>userOptionName</em> = <code><a class="elRef" href="qstring.html">QString</a>()</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check if a certain option is defined in a list of BackendSettings.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>settings</em> </td><td>The list to check. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>option</em> </td><td>The option to check. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>userOptionName</em> </td><td>If <code>option</code> is <a class="el" href="namespaceSoprano.html#ae82decb95b689a7c1252e735981b7fb2a4ed220736d4c1563ae0186b79ca1e68d">Soprano::BackendOptionUser</a>, this defines the user option to be checked.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if the option is defined.</dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>2.2 </dd></dl>
</div>
</div>
<a class="anchor" id="abcca1aed3b8d676eae19fb6aef5f52c9"></a><!-- doxytag: member="Soprano::BackendSetting::settingInSettings" ref="abcca1aed3b8d676eae19fb6aef5f52c9" args="(BackendSettings &settings, BackendOption option, const QString &userOptionName=QString())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SOPRANO_EXPORT <a class="el" href="classSoprano_1_1BackendSetting.html">BackendSetting</a> & settingInSettings </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="qlist.html">BackendSettings</a> & </td>
<td class="paramname"> <em>settings</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceSoprano.html#ae82decb95b689a7c1252e735981b7fb2">BackendOption</a> </td>
<td class="paramname"> <em>option</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td>
<td class="paramname"> <em>userOptionName</em> = <code><a class="elRef" href="qstring.html">QString</a>()</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a setting from the set, allowing to modify it.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>settings</em> </td><td>The list to check. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>option</em> </td><td>The option to extract. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>userOptionName</em> </td><td>If <code>option</code> is <a class="el" href="namespaceSoprano.html#ae82decb95b689a7c1252e735981b7fb2a4ed220736d4c1563ae0186b79ca1e68d">Soprano::BackendOptionUser</a>, this defines the user option to be extracted.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The extracted setting. An empty setting is added to <code>settings</code> in case the option is not found in <code>settings</code>.</dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>2.2 </dd></dl>
</div>
</div>
<a class="anchor" id="adf806f8fa2240527d38e34b024e9b21a"></a><!-- doxytag: member="Soprano::BackendSetting::settingInSettings" ref="adf806f8fa2240527d38e34b024e9b21a" args="(BackendSettings &settings, const QString &userOptionName)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SOPRANO_EXPORT <a class="el" href="classSoprano_1_1BackendSetting.html">BackendSetting</a> & settingInSettings </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="qlist.html">BackendSettings</a> & </td>
<td class="paramname"> <em>settings</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td>
<td class="paramname"> <em>userOptionName</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>settings</em> </td><td>The list to check. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>userOptionName</em> </td><td>The user option to be extracted.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The extracted setting. An empty setting is added to <code>settings</code> in case the option is not found in <code>settings</code>.</dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>2.4 </dd></dl>
</div>
</div>
<a class="anchor" id="ac56d78161cdddfa96cc12b53f55ba4c0"></a><!-- doxytag: member="Soprano::BackendSetting::settingInSettings" ref="ac56d78161cdddfa96cc12b53f55ba4c0" args="(const BackendSettings &settings, BackendOption option, const QString &userOptionName=QString())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SOPRANO_EXPORT <a class="el" href="classSoprano_1_1BackendSetting.html">BackendSetting</a> settingInSettings </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qlist.html">BackendSettings</a> & </td>
<td class="paramname"> <em>settings</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceSoprano.html#ae82decb95b689a7c1252e735981b7fb2">BackendOption</a> </td>
<td class="paramname"> <em>option</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td>
<td class="paramname"> <em>userOptionName</em> = <code><a class="elRef" href="qstring.html">QString</a>()</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a setting from the set.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>settings</em> </td><td>The list to check. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>option</em> </td><td>The option to extract. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>userOptionName</em> </td><td>If <code>option</code> is <a class="el" href="namespaceSoprano.html#ae82decb95b689a7c1252e735981b7fb2a4ed220736d4c1563ae0186b79ca1e68d">Soprano::BackendOptionUser</a>, this defines the user option to be extracted.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The extracted setting. If the setting is not found an empty <a class="el" href="classSoprano_1_1BackendSetting.html" title="Wraps one setting for Model creation.">BackendSetting</a> is returned.</dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>2.4 </dd></dl>
</div>
</div>
<a class="anchor" id="acecf21db899dfc4f6f7d5163fe520ce9"></a><!-- doxytag: member="Soprano::BackendSetting::settingInSettings" ref="acecf21db899dfc4f6f7d5163fe520ce9" args="(const BackendSettings &settings, const QString &userOptionName=QString())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SOPRANO_EXPORT <a class="el" href="classSoprano_1_1BackendSetting.html">BackendSetting</a> settingInSettings </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qlist.html">BackendSettings</a> & </td>
<td class="paramname"> <em>settings</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td>
<td class="paramname"> <em>userOptionName</em> = <code><a class="elRef" href="qstring.html">QString</a>()</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>settings</em> </td><td>The list to check. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>userOptionName</em> </td><td>The user option to be extracted.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The extracted setting. If the setting is not found an empty <a class="el" href="classSoprano_1_1BackendSetting.html" title="Wraps one setting for Model creation.">BackendSetting</a> is returned.</dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>2.4 </dd></dl>
</div>
</div>
<a class="anchor" id="a3b1367523802a20e3a911a6e59440b3d"></a><!-- doxytag: member="Soprano::BackendSetting::valueInSettings" ref="a3b1367523802a20e3a911a6e59440b3d" args="(const BackendSettings &settings, BackendOption option, const QString &userOptionName=QString())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SOPRANO_EXPORT <a class="elRef" href="qvariant.html">QVariant</a> valueInSettings </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qlist.html">BackendSettings</a> & </td>
<td class="paramname"> <em>settings</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceSoprano.html#ae82decb95b689a7c1252e735981b7fb2">BackendOption</a> </td>
<td class="paramname"> <em>option</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td>
<td class="paramname"> <em>userOptionName</em> = <code><a class="elRef" href="qstring.html">QString</a>()</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve the value of an option.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>settings</em> </td><td>The list to check. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>option</em> </td><td>The option to retrieve. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>userOptionName</em> </td><td>If <code>option</code> is <a class="el" href="namespaceSoprano.html#ae82decb95b689a7c1252e735981b7fb2a4ed220736d4c1563ae0186b79ca1e68d">Soprano::BackendOptionUser</a>, this defines the user option to be retrieved.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The value of the specified option or an invalid variant if the set does not contain the option.</dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>2.2 </dd></dl>
</div>
</div>
<a class="anchor" id="a030afb9e36eb3729031682232a0ba76f"></a><!-- doxytag: member="Soprano::BackendSetting::valueInSettings" ref="a030afb9e36eb3729031682232a0ba76f" args="(const BackendSettings &settings, const QString &userOptionName, const QVariant &defaultValue=QVariant())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SOPRANO_EXPORT <a class="elRef" href="qvariant.html">QVariant</a> valueInSettings </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qlist.html">BackendSettings</a> & </td>
<td class="paramname"> <em>settings</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td>
<td class="paramname"> <em>userOptionName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" href="qvariant.html">QVariant</a> & </td>
<td class="paramname"> <em>defaultValue</em> = <code><a class="elRef" href="qvariant.html">QVariant</a>()</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>settings</em> </td><td>The list to check. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>userOptionName</em> </td><td>The user option to retrieve. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>defaultValue</em> </td><td>The default to use if <code>option</code> is not part of <code>settings</code> </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The value of the specified option or <code>default</code> if <code>settings</code> does not contain the option.</dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>2.4 </dd></dl>
</div>
</div>
<a class="anchor" id="adf562d80f3bd67d584417f6e5c51f51e"></a><!-- doxytag: member="Soprano::BackendSetting::valueInSettingsWithDefault" ref="adf562d80f3bd67d584417f6e5c51f51e" args="(const BackendSettings &settings, BackendOption option, const QVariant &defaultValue)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SOPRANO_EXPORT <a class="elRef" href="qvariant.html">QVariant</a> valueInSettingsWithDefault </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qlist.html">BackendSettings</a> & </td>
<td class="paramname"> <em>settings</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceSoprano.html#ae82decb95b689a7c1252e735981b7fb2">BackendOption</a> </td>
<td class="paramname"> <em>option</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" href="qvariant.html">QVariant</a> & </td>
<td class="paramname"> <em>defaultValue</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve the value of an option with a fallback default.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>settings</em> </td><td>The list to check. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>option</em> </td><td>The option to retrieve. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>defaultValue</em> </td><td>The default to use if <code>option</code> is not part of <code>settings</code> </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The value of the specified option or <code>default</code> if <code>settings</code> does not contain the option.</dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>2.4 </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="backend_8h_source.html">backend.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>
distrib
>
Fedora
>
13
>
x86_64
>
media
>
updates
>
by-pkgid
>
fc669c0115c2f74e1d26807f2cb98f7a
>
files
>
47
