<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>accounts-qt: Provider Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">accounts-qt
 <span id="projectnumber">1.13</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<div id="navrow1" 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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classAccounts_1_1Provider.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#friends">Friends</a> |
<a href="classAccounts_1_1Provider-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Provider Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Representation of an account provider.
<a href="classAccounts_1_1Provider.html#details">More...</a></p>
<p><code>#include <<a class="el" href="provider_8h_source.html">Accounts/Provider</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a0a281cda2c25f17e851f76142d4527a0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0a281cda2c25f17e851f76142d4527a0"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classAccounts_1_1Provider.html#a0a281cda2c25f17e851f76142d4527a0">Provider</a> ()</td></tr>
<tr class="memdesc:a0a281cda2c25f17e851f76142d4527a0"><td class="mdescLeft"> </td><td class="mdescRight">Construct an invalid provider. <br /></td></tr>
<tr class="separator:a0a281cda2c25f17e851f76142d4527a0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abff16d2acc53f89d7f633e85a4b90634"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAccounts_1_1Provider.html#abff16d2acc53f89d7f633e85a4b90634">Provider</a> (const <a class="el" href="classAccounts_1_1Provider.html">Provider</a> &other)</td></tr>
<tr class="memdesc:abff16d2acc53f89d7f633e85a4b90634"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#abff16d2acc53f89d7f633e85a4b90634">More...</a><br /></td></tr>
<tr class="separator:abff16d2acc53f89d7f633e85a4b90634"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2ea3187c2cc7f9464d47da1aada7d78c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2ea3187c2cc7f9464d47da1aada7d78c"></a>
<a class="el" href="classAccounts_1_1Provider.html">Provider</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classAccounts_1_1Provider.html">Provider</a> &other)</td></tr>
<tr class="separator:a2ea3187c2cc7f9464d47da1aada7d78c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aac1b70a2ed67ead038c4d3f5ac4d8a81"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAccounts_1_1Provider.html#aac1b70a2ed67ead038c4d3f5ac4d8a81">isValid</a> () const </td></tr>
<tr class="memdesc:aac1b70a2ed67ead038c4d3f5ac4d8a81"><td class="mdescLeft"> </td><td class="mdescRight">Check whether this object represents a <a class="el" href="classAccounts_1_1Provider.html" title="Representation of an account provider. ">Provider</a>. <a href="#aac1b70a2ed67ead038c4d3f5ac4d8a81">More...</a><br /></td></tr>
<tr class="separator:aac1b70a2ed67ead038c4d3f5ac4d8a81"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2b0a198f837184bf6fff555cee3ce770"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classAccounts_1_1Provider.html#a2b0a198f837184bf6fff555cee3ce770">name</a> () const </td></tr>
<tr class="memdesc:a2b0a198f837184bf6fff555cee3ce770"><td class="mdescLeft"> </td><td class="mdescRight">Get the name of the provider. <a href="#a2b0a198f837184bf6fff555cee3ce770">More...</a><br /></td></tr>
<tr class="separator:a2b0a198f837184bf6fff555cee3ce770"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9def71dea12661002bb3a63b3b91d08d"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classAccounts_1_1Provider.html#a9def71dea12661002bb3a63b3b91d08d">displayName</a> () const </td></tr>
<tr class="memdesc:a9def71dea12661002bb3a63b3b91d08d"><td class="mdescLeft"> </td><td class="mdescRight">Get the display name of the provider, untranslated. <a href="#a9def71dea12661002bb3a63b3b91d08d">More...</a><br /></td></tr>
<tr class="separator:a9def71dea12661002bb3a63b3b91d08d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeaebc63d2181b1a4506603f4e03f1275"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classAccounts_1_1Provider.html#aeaebc63d2181b1a4506603f4e03f1275">description</a> () const </td></tr>
<tr class="memdesc:aeaebc63d2181b1a4506603f4e03f1275"><td class="mdescLeft"> </td><td class="mdescRight">Get the description of the provider, untranslated. <a href="#aeaebc63d2181b1a4506603f4e03f1275">More...</a><br /></td></tr>
<tr class="separator:aeaebc63d2181b1a4506603f4e03f1275"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac7fe5a9dd669a037edfa2930803311a5"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classAccounts_1_1Provider.html#ac7fe5a9dd669a037edfa2930803311a5">pluginName</a> () const </td></tr>
<tr class="memdesc:ac7fe5a9dd669a037edfa2930803311a5"><td class="mdescLeft"> </td><td class="mdescRight">Get the name of the account plugin associated with the provider. <a href="#ac7fe5a9dd669a037edfa2930803311a5">More...</a><br /></td></tr>
<tr class="separator:ac7fe5a9dd669a037edfa2930803311a5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6c73afd4753195ea4eee794c95a770dd"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classAccounts_1_1Provider.html#a6c73afd4753195ea4eee794c95a770dd">trCatalog</a> () const </td></tr>
<tr class="separator:a6c73afd4753195ea4eee794c95a770dd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a038b22680aca535f9972908fe2f1f6a1"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classAccounts_1_1Provider.html#a038b22680aca535f9972908fe2f1f6a1">iconName</a> () const </td></tr>
<tr class="separator:a038b22680aca535f9972908fe2f1f6a1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab0c2fc656cae3b09e456ec0747315ecc"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classAccounts_1_1Provider.html#ab0c2fc656cae3b09e456ec0747315ecc">domainsRegExp</a> () const </td></tr>
<tr class="separator:ab0c2fc656cae3b09e456ec0747315ecc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa785668bfd84285ad40299410c02367d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAccounts_1_1Provider.html#aa785668bfd84285ad40299410c02367d">isSingleAccount</a> () const </td></tr>
<tr class="separator:aa785668bfd84285ad40299410c02367d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a305fe3a04c76c8069c3465621a7967cc"><td class="memItemLeft" align="right" valign="top">const QDomDocument </td><td class="memItemRight" valign="bottom"><a class="el" href="classAccounts_1_1Provider.html#a305fe3a04c76c8069c3465621a7967cc">domDocument</a> () const </td></tr>
<tr class="separator:a305fe3a04c76c8069c3465621a7967cc"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:acad7a7994506519762f09b8a66c91c6a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acad7a7994506519762f09b8a66c91c6a"></a>
bool </td><td class="memItemRight" valign="bottom"><b>operator==</b> (const <a class="el" href="classAccounts_1_1Provider.html">Accounts::Provider</a> &p1, const <a class="el" href="classAccounts_1_1Provider.html">Accounts::Provider</a> &p2)</td></tr>
<tr class="separator:acad7a7994506519762f09b8a66c91c6a"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Representation of an account provider. </p>
<p>The <a class="el" href="classAccounts_1_1Provider.html" title="Representation of an account provider. ">Provider</a> object represents an account provider. It can be used to retrieve some basic properties of the provider (such as the name) and to get access to the contents of the XML file which defines it. </p>
<p>Definition at line <a class="el" href="provider_8h_source.html#l00048">48</a> of file <a class="el" href="provider_8h_source.html">provider.h</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="abff16d2acc53f89d7f633e85a4b90634"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classAccounts_1_1Provider.html">Provider</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classAccounts_1_1Provider.html">Provider</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Copy constructor. </p>
<p>Copying a <a class="el" href="classAccounts_1_1Provider.html" title="Representation of an account provider. ">Provider</a> object is very cheap, because the data is shared among copies. </p>
<p>Definition at line <a class="el" href="provider_8cpp_source.html#l00065">65</a> of file <a class="el" href="provider_8cpp_source.html">provider.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aeaebc63d2181b1a4506603f4e03f1275"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString description </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the description of the provider, untranslated. </p>
<dl class="section return"><dt>Returns</dt><dd>The description of the provider. </dd></dl>
<p>Definition at line <a class="el" href="provider_8cpp_source.html#l00124">124</a> of file <a class="el" href="provider_8cpp_source.html">provider.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a9def71dea12661002bb3a63b3b91d08d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString displayName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the display name of the provider, untranslated. </p>
<dl class="section return"><dt>Returns</dt><dd>The display name of the provider. </dd></dl>
<p>Definition at line <a class="el" href="provider_8cpp_source.html#l00115">115</a> of file <a class="el" href="provider_8cpp_source.html">provider.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ab0c2fc656cae3b09e456ec0747315ecc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString domainsRegExp </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>A regular expression pattern which matches all the internet domains in which this type of account can be used. </dd></dl>
<p>Definition at line <a class="el" href="provider_8cpp_source.html#l00161">161</a> of file <a class="el" href="provider_8cpp_source.html">provider.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a305fe3a04c76c8069c3465621a7967cc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const QDomDocument domDocument </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>The DOM of the whole XML provider file. </dd></dl>
<p>Definition at line <a class="el" href="provider_8cpp_source.html#l00177">177</a> of file <a class="el" href="provider_8cpp_source.html">provider.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a038b22680aca535f9972908fe2f1f6a1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString iconName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>The provider icon name. </dd></dl>
<p>Definition at line <a class="el" href="provider_8cpp_source.html#l00152">152</a> of file <a class="el" href="provider_8cpp_source.html">provider.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aa785668bfd84285ad40299410c02367d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool isSingleAccount </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>Whether the provider supports creating one account at most. </dd></dl>
<p>Definition at line <a class="el" href="provider_8cpp_source.html#l00169">169</a> of file <a class="el" href="provider_8cpp_source.html">provider.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aac1b70a2ed67ead038c4d3f5ac4d8a81"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool isValid </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Check whether this object represents a <a class="el" href="classAccounts_1_1Provider.html" title="Representation of an account provider. ">Provider</a>. </p>
<dl class="section return"><dt>Returns</dt><dd>true if the <a class="el" href="classAccounts_1_1Provider.html" title="Representation of an account provider. ">Provider</a> is a valid one. </dd></dl>
<p>Definition at line <a class="el" href="provider_8cpp_source.html#l00095">95</a> of file <a class="el" href="provider_8cpp_source.html">provider.cpp</a>.</p>
<p>Referenced by <a class="el" href="provider_8cpp_source.html#l00105">Provider::name()</a>.</p>
</div>
</div>
<a class="anchor" id="a2b0a198f837184bf6fff555cee3ce770"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString name </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the name of the provider. </p>
<p>This can be used as a unique identifier for this provider. </p><dl class="section return"><dt>Returns</dt><dd>The unique name of the provider. </dd></dl>
<p>Definition at line <a class="el" href="provider_8cpp_source.html#l00105">105</a> of file <a class="el" href="provider_8cpp_source.html">provider.cpp</a>.</p>
<p>References <a class="el" href="provider_8cpp_source.html#l00095">Provider::isValid()</a>.</p>
</div>
</div>
<a class="anchor" id="ac7fe5a9dd669a037edfa2930803311a5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString pluginName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the name of the account plugin associated with the provider. </p>
<p>Some platforms might find it useful to store plugin names in the provider XML files, especially when the same plugin can work for different providers. </p><dl class="section return"><dt>Returns</dt><dd>The plugin name. </dd></dl>
<p>Definition at line <a class="el" href="provider_8cpp_source.html#l00135">135</a> of file <a class="el" href="provider_8cpp_source.html">provider.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a6c73afd4753195ea4eee794c95a770dd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString trCatalog </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>The name of the translation catalog, which can be used to translate the <a class="el" href="classAccounts_1_1Provider.html#a9def71dea12661002bb3a63b3b91d08d" title="Get the display name of the provider, untranslated. ">displayName()</a>. </dd></dl>
<p>Definition at line <a class="el" href="provider_8cpp_source.html#l00144">144</a> of file <a class="el" href="provider_8cpp_source.html">provider.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>Accounts/<a class="el" href="provider_8h_source.html">provider.h</a></li>
<li>Accounts/<a class="el" href="provider_8cpp_source.html">provider.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><b>Accounts</b></li><li class="navelem"><a class="el" href="classAccounts_1_1Provider.html">Provider</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
</ul>
</div>
</body>
</html>
