<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>accounts-qt: Application 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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</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.15</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classAccounts_1_1Application.html','');});
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classAccounts_1_1Application-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Application Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Information on the client applications of libaccounts.
<a href="classAccounts_1_1Application.html#details">More...</a></p>
<p><code>#include <<a class="el" href="application_8h_source.html">Accounts/Application</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:aec7d6461aa7be31d98eff24b9d69ae3d"><td class="memItemLeft" align="right" valign="top"><a id="aec7d6461aa7be31d98eff24b9d69ae3d"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classAccounts_1_1Application.html#aec7d6461aa7be31d98eff24b9d69ae3d">Application</a> ()</td></tr>
<tr class="memdesc:aec7d6461aa7be31d98eff24b9d69ae3d"><td class="mdescLeft"> </td><td class="mdescRight">Construct an invalid application. <br /></td></tr>
<tr class="separator:aec7d6461aa7be31d98eff24b9d69ae3d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af5e0a77dad01833eddabf0def1caa475"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAccounts_1_1Application.html#af5e0a77dad01833eddabf0def1caa475">Application</a> (const <a class="el" href="classAccounts_1_1Application.html">Application</a> &other)</td></tr>
<tr class="memdesc:af5e0a77dad01833eddabf0def1caa475"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#af5e0a77dad01833eddabf0def1caa475">More...</a><br /></td></tr>
<tr class="separator:af5e0a77dad01833eddabf0def1caa475"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a645636c24dff51fd2b9ec75fc083b928"><td class="memItemLeft" align="right" valign="top"><a id="a645636c24dff51fd2b9ec75fc083b928"></a>
<a class="el" href="classAccounts_1_1Application.html">Application</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classAccounts_1_1Application.html">Application</a> &other)</td></tr>
<tr class="separator:a645636c24dff51fd2b9ec75fc083b928"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a713b51c450f3ae9db74cd857c2419173"><td class="memItemLeft" align="right" valign="top"><a id="a713b51c450f3ae9db74cd857c2419173"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classAccounts_1_1Application.html#a713b51c450f3ae9db74cd857c2419173">~Application</a> ()</td></tr>
<tr class="memdesc:a713b51c450f3ae9db74cd857c2419173"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:a713b51c450f3ae9db74cd857c2419173"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5bc2a781be2586924afce4e4a4ea6697"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAccounts_1_1Application.html#a5bc2a781be2586924afce4e4a4ea6697">isValid</a> () const</td></tr>
<tr class="memdesc:a5bc2a781be2586924afce4e4a4ea6697"><td class="mdescLeft"> </td><td class="mdescRight">Check whether this object represents an <a class="el" href="classAccounts_1_1Application.html" title="Information on the client applications of libaccounts.">Application</a>. <a href="#a5bc2a781be2586924afce4e4a4ea6697">More...</a><br /></td></tr>
<tr class="separator:a5bc2a781be2586924afce4e4a4ea6697"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a85e6ea749496bfaa328adc586fe00c87"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classAccounts_1_1Application.html#a85e6ea749496bfaa328adc586fe00c87">name</a> () const</td></tr>
<tr class="memdesc:a85e6ea749496bfaa328adc586fe00c87"><td class="mdescLeft"> </td><td class="mdescRight">Get the unique ID of the application. <a href="#a85e6ea749496bfaa328adc586fe00c87">More...</a><br /></td></tr>
<tr class="separator:a85e6ea749496bfaa328adc586fe00c87"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aacc388204f67d061b44e3b466a386328"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classAccounts_1_1Application.html#aacc388204f67d061b44e3b466a386328">displayName</a> () const</td></tr>
<tr class="memdesc:aacc388204f67d061b44e3b466a386328"><td class="mdescLeft"> </td><td class="mdescRight">Get the display name of the application. <a href="#aacc388204f67d061b44e3b466a386328">More...</a><br /></td></tr>
<tr class="separator:aacc388204f67d061b44e3b466a386328"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abb1a16962afe2be354aea02390dc6083"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classAccounts_1_1Application.html#abb1a16962afe2be354aea02390dc6083">description</a> () const</td></tr>
<tr class="memdesc:abb1a16962afe2be354aea02390dc6083"><td class="mdescLeft"> </td><td class="mdescRight">Get the description of the application. <a href="#abb1a16962afe2be354aea02390dc6083">More...</a><br /></td></tr>
<tr class="separator:abb1a16962afe2be354aea02390dc6083"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa8764093112ea4420f639386e6e82adb"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classAccounts_1_1Application.html#aa8764093112ea4420f639386e6e82adb">iconName</a> () const</td></tr>
<tr class="memdesc:aa8764093112ea4420f639386e6e82adb"><td class="mdescLeft"> </td><td class="mdescRight">Get the icon name of the application. <a href="#aa8764093112ea4420f639386e6e82adb">More...</a><br /></td></tr>
<tr class="separator:aa8764093112ea4420f639386e6e82adb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a991b696116095cb3275de5e6180ca39e"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classAccounts_1_1Application.html#a991b696116095cb3275de5e6180ca39e">desktopFilePath</a> () const</td></tr>
<tr class="memdesc:a991b696116095cb3275de5e6180ca39e"><td class="mdescLeft"> </td><td class="mdescRight">Get the .desktop file associated with this application. <a href="#a991b696116095cb3275de5e6180ca39e">More...</a><br /></td></tr>
<tr class="separator:a991b696116095cb3275de5e6180ca39e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae32451ab4b28182010b3aff33f13ef99"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classAccounts_1_1Application.html#ae32451ab4b28182010b3aff33f13ef99">trCatalog</a> () const</td></tr>
<tr class="memdesc:ae32451ab4b28182010b3aff33f13ef99"><td class="mdescLeft"> </td><td class="mdescRight">Get the translation catalog for the texts returned by the methods of this class. <a href="#ae32451ab4b28182010b3aff33f13ef99">More...</a><br /></td></tr>
<tr class="separator:ae32451ab4b28182010b3aff33f13ef99"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acbbd44076617b31fadf354675d9ad2f5"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAccounts_1_1Application.html#acbbd44076617b31fadf354675d9ad2f5">supportsService</a> (const <a class="el" href="classAccounts_1_1Service.html">Service</a> &service) const</td></tr>
<tr class="memdesc:acbbd44076617b31fadf354675d9ad2f5"><td class="mdescLeft"> </td><td class="mdescRight">Check whether the application supports the given service. <a href="#acbbd44076617b31fadf354675d9ad2f5">More...</a><br /></td></tr>
<tr class="separator:acbbd44076617b31fadf354675d9ad2f5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad21dacf3d0da37eba73ee4cc2e5a08cd"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classAccounts_1_1Application.html#ad21dacf3d0da37eba73ee4cc2e5a08cd">serviceUsage</a> (const <a class="el" href="classAccounts_1_1Service.html">Service</a> &service) const</td></tr>
<tr class="memdesc:ad21dacf3d0da37eba73ee4cc2e5a08cd"><td class="mdescLeft"> </td><td class="mdescRight">Get the description from the application XML file, for the specified service; if not found, get the service-type description instead. <a href="#ad21dacf3d0da37eba73ee4cc2e5a08cd">More...</a><br /></td></tr>
<tr class="separator:ad21dacf3d0da37eba73ee4cc2e5a08cd"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Information on the client applications of libaccounts. </p>
<p>The <a class="el" href="classAccounts_1_1Application.html" title="Information on the client applications of libaccounts.">Application</a> structure holds information on the client applications registered with libaccounts. It is instantiated by <a class="el" href="classAccounts_1_1Manager.html#a01f5a06c6f13450db5fab813ec65039d" title="Get an object representing an application.">Manager::application()</a> and <a class="el" href="classAccounts_1_1Manager.html#a2dc682cf5347c3d80dd037d82595c9d9" title="List the registered applications which support the given service.">Manager::applicationList()</a>. </p>
<p class="definition">Definition at line <a class="el" href="application_8h_source.html#l00041">41</a> of file <a class="el" href="application_8h_source.html">application.h</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="af5e0a77dad01833eddabf0def1caa475"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af5e0a77dad01833eddabf0def1caa475">◆ </a></span>Application()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classAccounts_1_1Application.html">Application</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classAccounts_1_1Application.html">Application</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 an <a class="el" href="classAccounts_1_1Application.html" title="Information on the client applications of libaccounts.">Application</a> object is very cheap, because the data is shared among copies. </p>
<p class="definition">Definition at line <a class="el" href="application_8cpp_source.html#l00062">62</a> of file <a class="el" href="application_8cpp_source.html">application.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="abb1a16962afe2be354aea02390dc6083"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abb1a16962afe2be354aea02390dc6083">◆ </a></span>description()</h2>
<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 application. </p>
<dl class="section return"><dt>Returns</dt><dd>The application description. </dd></dl>
<p class="definition">Definition at line <a class="el" href="application_8cpp_source.html#l00131">131</a> of file <a class="el" href="application_8cpp_source.html">application.cpp</a>.</p>
</div>
</div>
<a id="a991b696116095cb3275de5e6180ca39e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a991b696116095cb3275de5e6180ca39e">◆ </a></span>desktopFilePath()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString desktopFilePath </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the .desktop file associated with this application. </p>
<dl class="section return"><dt>Returns</dt><dd>The full path to the .desktop file. </dd></dl>
<p class="definition">Definition at line <a class="el" href="application_8cpp_source.html#l00160">160</a> of file <a class="el" href="application_8cpp_source.html">application.cpp</a>.</p>
</div>
</div>
<a id="aacc388204f67d061b44e3b466a386328"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aacc388204f67d061b44e3b466a386328">◆ </a></span>displayName()</h2>
<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 application. </p>
<dl class="section return"><dt>Returns</dt><dd>The application display name. </dd></dl>
<p class="definition">Definition at line <a class="el" href="application_8cpp_source.html#l00115">115</a> of file <a class="el" href="application_8cpp_source.html">application.cpp</a>.</p>
<p class="reference">References <a class="el" href="application_8cpp_source.html#l00105">Application::name()</a>.</p>
</div>
</div>
<a id="aa8764093112ea4420f639386e6e82adb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa8764093112ea4420f639386e6e82adb">◆ </a></span>iconName()</h2>
<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">
<p>Get the icon name of the application. </p>
<dl class="section return"><dt>Returns</dt><dd>The application icon name. </dd></dl>
<p class="definition">Definition at line <a class="el" href="application_8cpp_source.html#l00140">140</a> of file <a class="el" href="application_8cpp_source.html">application.cpp</a>.</p>
</div>
</div>
<a id="a5bc2a781be2586924afce4e4a4ea6697"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5bc2a781be2586924afce4e4a4ea6697">◆ </a></span>isValid()</h2>
<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 an <a class="el" href="classAccounts_1_1Application.html" title="Information on the client applications of libaccounts.">Application</a>. </p>
<dl class="section return"><dt>Returns</dt><dd>true if the <a class="el" href="classAccounts_1_1Application.html" title="Information on the client applications of libaccounts.">Application</a> is a valid one. </dd></dl>
<p class="definition">Definition at line <a class="el" href="application_8cpp_source.html#l00095">95</a> of file <a class="el" href="application_8cpp_source.html">application.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="application_8cpp_source.html#l00105">Application::name()</a>.</p>
</div>
</div>
<a id="a85e6ea749496bfaa328adc586fe00c87"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a85e6ea749496bfaa328adc586fe00c87">◆ </a></span>name()</h2>
<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 unique ID of the application. </p>
<p>This is the name of the .application file minus the .application suffix. </p><dl class="section return"><dt>Returns</dt><dd>The application unique ID. </dd></dl>
<p class="definition">Definition at line <a class="el" href="application_8cpp_source.html#l00105">105</a> of file <a class="el" href="application_8cpp_source.html">application.cpp</a>.</p>
<p class="reference">References <a class="el" href="application_8cpp_source.html#l00095">Application::isValid()</a>.</p>
<p class="reference">Referenced by <a class="el" href="application_8cpp_source.html#l00115">Application::displayName()</a>.</p>
</div>
</div>
<a id="ad21dacf3d0da37eba73ee4cc2e5a08cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad21dacf3d0da37eba73ee4cc2e5a08cd">◆ </a></span>serviceUsage()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString serviceUsage </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classAccounts_1_1Service.html">Service</a> & </td>
<td class="paramname"><em>service</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the description from the application XML file, for the specified service; if not found, get the service-type description instead. </p>
<dl class="section return"><dt>Returns</dt><dd>Usage description of the service. </dd></dl>
<p class="definition">Definition at line <a class="el" href="application_8cpp_source.html#l00198">198</a> of file <a class="el" href="application_8cpp_source.html">application.cpp</a>.</p>
</div>
</div>
<a id="acbbd44076617b31fadf354675d9ad2f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acbbd44076617b31fadf354675d9ad2f5">◆ </a></span>supportsService()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool supportsService </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classAccounts_1_1Service.html">Service</a> & </td>
<td class="paramname"><em>service</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Check whether the application supports the given service. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">service</td><td>Instance of a <a class="el" href="classAccounts_1_1Service.html" title="Representation of an account service.">Service</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>whether the service is supported by this application. </dd></dl>
<p class="definition">Definition at line <a class="el" href="application_8cpp_source.html#l00187">187</a> of file <a class="el" href="application_8cpp_source.html">application.cpp</a>.</p>
</div>
</div>
<a id="ae32451ab4b28182010b3aff33f13ef99"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae32451ab4b28182010b3aff33f13ef99">◆ </a></span>trCatalog()</h2>
<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">
<p>Get the translation catalog for the texts returned by the methods of this class. </p>
<dl class="section return"><dt>Returns</dt><dd>The translation catalog name. </dd></dl>
<p class="definition">Definition at line <a class="el" href="application_8cpp_source.html#l00177">177</a> of file <a class="el" href="application_8cpp_source.html">application.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>Accounts/<a class="el" href="application_8h_source.html">application.h</a></li>
<li>Accounts/<a class="el" href="application_8cpp_source.html">application.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_1Application.html">Application</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.15 </li>
</ul>
</div>
</body>
</html>
