<?xml version="1.0" encoding="UTF-8"?>
<!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" lang="en" xml:lang="en">
<head>
<title>KRES::Resource Class Reference</title>
<style type="text/css">
.cp-doNotDisplay { display: none; }
@media aural, braille, handheld, tty { .cp-doNotDisplay { display: inline; speak: normal; }}
.cp-edit { text-align: right; }
@media print, embossed { .cp-edit { display: none; }}
</style>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<link rel="meta" href="http://www.kde.org/labels.rdf" type="application/rdf+xml" title="ICRA labels" />
<meta name="trademark" content="KDE e.V." />
<meta name="description" content="K Desktop Environment Homepage, KDE.org" />
<meta name="MSSmartTagsPreventParsing" content="true" />
<meta name="robots" content="all" />
<meta name="no-email-collection" content="http://www.unspam.com/noemailcollection" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link rel="shortcut icon" href="../../favicon.ico" /><link rel="icon" href="../../favicon.ico" />
<link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../../kde.css" />
<link rel="stylesheet" media="print, embossed" type="text/css" href="../../print.css" />
<link rel="stylesheet" media="screen, aural, handheld, tty, braille" type="text/css" title="Flat" href="../../flat.css" />
<link rel="stylesheet" type="text/css" href="../../doxygen.css" />
<link rel="stylesheet" type="text/css" href="../../tabs.css" />
</head>
<body>
<ul class="cp-doNotDisplay">
<li><a href="#cp-content" accesskey="2">Skip to content</a></li>
<li><a href="#cp-menu" accesskey="5">Skip to link menu</a></li>
</ul>
<div id="container">
<div id="header">
<div id="header_top"><div><div>
<img alt ="" src="../../top-kde.jpg"/>
</div></div></div>
<div id="header_bottom">
<div id="location">
<ul>
<li><a href="http://api.kde.org">KDE API Reference</a></li>
<li><a href="../../index.html">kdepimlibs-4.10.5 API Reference</a></li>
</ul>
</div>
<div id="menu">
<ul>
<li><a href="http://www.kde.org/">KDE Home</a></li>
<li><a href="http://kde.org/contact/">Contact Us</a></li>
</ul>
</div>
</div>
</div>
<!-- End page header -->
<div id="body_wrapper">
<div id="body">
<!-- begin main content -->
<div id="right">
<div class="content">
<div id="main">
<div class="clearer"> </div>
<h2><a name="content"></a>kresources</h2>
<!-- BC -->
<div id="top">
<!-- Generated by Doxygen 1.8.3.1 -->
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>KRES</b></li><li class="navelem"><a class="el" href="classKRES_1_1Resource.html">Resource</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="classKRES_1_1Resource-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">KRES::Resource Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="resource_8h_source.html">resource.h</a>></code></p>
<p>Inherits QObject.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:aaefa36c6bdd809923ed43eda96523ca7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaefa36c6bdd809923ed43eda96523ca7"></a>
typedef QList< <a class="el" href="classKRES_1_1Resource.html">Resource</a> * > </td><td class="memItemRight" valign="bottom"><b>List</b></td></tr>
<tr class="separator:aaefa36c6bdd809923ed43eda96523ca7"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:a5a87b23dc0327bbf8d53c6f38f637f48"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1Resource.html#a5a87b23dc0327bbf8d53c6f38f637f48">Resource</a> ()</td></tr>
<tr class="separator:a5a87b23dc0327bbf8d53c6f38f637f48"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:add73bf38a6cc4fe1d285063bf8509d9a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1Resource.html#add73bf38a6cc4fe1d285063bf8509d9a">Resource</a> (const KConfigGroup &group)</td></tr>
<tr class="separator:add73bf38a6cc4fe1d285063bf8509d9a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0e5ec475e2601bdb33644468e86f6f10"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1Resource.html#a0e5ec475e2601bdb33644468e86f6f10">~Resource</a> ()</td></tr>
<tr class="separator:a0e5ec475e2601bdb33644468e86f6f10"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abd1bb168eccdd27ea4aecbb86836bc62"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1Resource.html#abd1bb168eccdd27ea4aecbb86836bc62">close</a> ()</td></tr>
<tr class="separator:abd1bb168eccdd27ea4aecbb86836bc62"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6b66cd10ba2b00886d0b191622be9c38"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1Resource.html#a6b66cd10ba2b00886d0b191622be9c38">dump</a> () const </td></tr>
<tr class="separator:a6b66cd10ba2b00886d0b191622be9c38"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae17cf4470b97c121651c4fa5a75a0b83"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1Resource.html#ae17cf4470b97c121651c4fa5a75a0b83">identifier</a> () const </td></tr>
<tr class="separator:ae17cf4470b97c121651c4fa5a75a0b83"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a879c67fdfc7b040a96925bb24400cb19"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1Resource.html#a879c67fdfc7b040a96925bb24400cb19">isActive</a> () const </td></tr>
<tr class="separator:a879c67fdfc7b040a96925bb24400cb19"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4dfd930f90d81362c8e2a64ad2481b39"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1Resource.html#a4dfd930f90d81362c8e2a64ad2481b39">isOpen</a> () const </td></tr>
<tr class="separator:a4dfd930f90d81362c8e2a64ad2481b39"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0bace10c217883eea74fbd584ce5097b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1Resource.html#a0bace10c217883eea74fbd584ce5097b">open</a> ()</td></tr>
<tr class="separator:a0bace10c217883eea74fbd584ce5097b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2a35a353d26abefad3ecb113ee5c5de4"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1Resource.html#a2a35a353d26abefad3ecb113ee5c5de4">readOnly</a> () const </td></tr>
<tr class="separator:a2a35a353d26abefad3ecb113ee5c5de4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a52ebe0cdda9c7968b99b25f85446ef89"><td class="memItemLeft" align="right" valign="top">virtual QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1Resource.html#a52ebe0cdda9c7968b99b25f85446ef89">resourceName</a> () const </td></tr>
<tr class="separator:a52ebe0cdda9c7968b99b25f85446ef89"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adbbb6904d693a1e82470c00af000ed1f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1Resource.html#adbbb6904d693a1e82470c00af000ed1f">setActive</a> (bool active)</td></tr>
<tr class="separator:adbbb6904d693a1e82470c00af000ed1f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abebb9edb9158d481d5d6a8d9e8fb8ea2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1Resource.html#abebb9edb9158d481d5d6a8d9e8fb8ea2">setIdentifier</a> (const QString &<a class="el" href="classKRES_1_1Resource.html#ae17cf4470b97c121651c4fa5a75a0b83">identifier</a>)</td></tr>
<tr class="separator:abebb9edb9158d481d5d6a8d9e8fb8ea2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a021163f496e0d69936118a7960edb02a"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1Resource.html#a021163f496e0d69936118a7960edb02a">setReadOnly</a> (bool value)</td></tr>
<tr class="separator:a021163f496e0d69936118a7960edb02a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a54ecadca62801e08b9881af3593a05b2"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1Resource.html#a54ecadca62801e08b9881af3593a05b2">setResourceName</a> (const QString &name)</td></tr>
<tr class="separator:a54ecadca62801e08b9881af3593a05b2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5fd37bff36721435a837754372ab68f3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1Resource.html#a5fd37bff36721435a837754372ab68f3">setType</a> (const QString &<a class="el" href="classKRES_1_1Resource.html#ab6a1040675eb77a2b86592d122a17a90">type</a>)</td></tr>
<tr class="separator:a5fd37bff36721435a837754372ab68f3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab6a1040675eb77a2b86592d122a17a90"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1Resource.html#ab6a1040675eb77a2b86592d122a17a90">type</a> () const </td></tr>
<tr class="separator:ab6a1040675eb77a2b86592d122a17a90"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab3baaac13e2733723b143ea82851aca9"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1Resource.html#ab3baaac13e2733723b143ea82851aca9">writeConfig</a> (KConfigGroup &group)</td></tr>
<tr class="separator:ab3baaac13e2733723b143ea82851aca9"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a145007aa59912120c2363b109bda18d1"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1Resource.html#a145007aa59912120c2363b109bda18d1">doClose</a> ()</td></tr>
<tr class="separator:a145007aa59912120c2363b109bda18d1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8b17cf8733d0c747080e14c3143bf265"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1Resource.html#a8b17cf8733d0c747080e14c3143bf265">doOpen</a> ()</td></tr>
<tr class="separator:a8b17cf8733d0c747080e14c3143bf265"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This class provides a resource which is managed in a general way. </p>
<p>A <a class="el" href="classKRES_1_1Resource.html" title="This class provides a resource which is managed in a general way.">Resource</a> represents the concept of an object with the following attributes:</p>
<ul>
<li>Applications operate on sets of one or more <a class="el" href="classKRES_1_1Resource.html" title="This class provides a resource which is managed in a general way.">Resource</a> objects.</li>
<li>Creation and deletetion of <a class="el" href="classKRES_1_1Resource.html" title="This class provides a resource which is managed in a general way.">Resource</a> objects is done in a general way, independent of concrete functionality of the <a class="el" href="classKRES_1_1Resource.html" title="This class provides a resource which is managed in a general way.">Resource</a>.</li>
<li>The end user has control over creation, deletion and configuration of <a class="el" href="classKRES_1_1Resource.html" title="This class provides a resource which is managed in a general way.">Resource</a> object.</li>
<li>Properties, behaviour and configuration of different <a class="el" href="classKRES_1_1Resource.html" title="This class provides a resource which is managed in a general way.">Resource</a> objects can widely differ.</li>
<li>Resources can be active or inactive.</li>
<li>There is one special <a class="el" href="classKRES_1_1Resource.html" title="This class provides a resource which is managed in a general way.">Resource</a> which is the standard <a class="el" href="classKRES_1_1Resource.html" title="This class provides a resource which is managed in a general way.">Resource</a>. This can for example be used as default destination for newly created object managed by a certain <a class="el" href="classKRES_1_1Resource.html" title="This class provides a resource which is managed in a general way.">Resource</a> family.</li>
<li>Activation of Resources can be covered by a two step process of being opened and then loaded. Deactivation corresponds to saving and closing.</li>
<li>Different application ususally share the same set of Resources.</li>
</ul>
<p>The <a class="el" href="classKRES_1_1Resource.html" title="This class provides a resource which is managed in a general way.">Resource</a> base class provides the management functionality. Classes inheriting from <a class="el" href="classKRES_1_1Resource.html" title="This class provides a resource which is managed in a general way.">Resource</a> automatically appear in the general kresources kcontrol module.</p>
<p>Concrete functionality of Resources is specified per family by a subclass of <a class="el" href="classKRES_1_1Resource.html" title="This class provides a resource which is managed in a general way.">Resource</a>. This classes in turn have subclasses which implement the different flavors of the functionality represented by the family.</p>
<p>A subclass should reimplement at least the constructor and the writeConfig method.</p>
<p>An example for a <a class="el" href="classKRES_1_1Resource.html" title="This class provides a resource which is managed in a general way.">Resource</a> subclass hierarchy would be the "calendar" family. The ResourceCalendar subclass would specify an API for accessing calendar data. Subclasses of ResourceCalendar would implement this API for local files, remote files, specific calendar servers etc. </p>
<p>Definition at line <a class="el" href="resource_8h_source.html#l00075">75</a> of file <a class="el" href="resource_8h_source.html">resource.h</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a5a87b23dc0327bbf8d53c6f38f637f48"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Resource::Resource </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<p>Construct resource with default settings. </p>
<p>Definition at line <a class="el" href="resource_8cpp_source.html#l00072">72</a> of file <a class="el" href="resource_8cpp_source.html">resource.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="add73bf38a6cc4fe1d285063bf8509d9a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Resource::Resource </td>
<td>(</td>
<td class="paramtype">const KConfigGroup & </td>
<td class="paramname"><em>group</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<p>Construct resource from configuration group. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">group</td><td>Configuration group to read persistence information from </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="resource_8cpp_source.html#l00085">85</a> of file <a class="el" href="resource_8cpp_source.html">resource.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a0e5ec475e2601bdb33644468e86f6f10"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Resource::~Resource </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
<p>Definition at line <a class="el" href="resource_8cpp_source.html#l00098">98</a> of file <a class="el" href="resource_8cpp_source.html">resource.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="abd1bb168eccdd27ea4aecbb86836bc62"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Resource::close </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Decrease the open count of this object, and if the count reaches zero, close this resource by calling <a class="el" href="classKRES_1_1Resource.html#a145007aa59912120c2363b109bda18d1" title="Close this resource.">doClose()</a>. </p>
<p>This method may block while another thread is concurrently closing or opening the resource. </p>
<p>Definition at line <a class="el" href="resource_8cpp_source.html#l00128">128</a> of file <a class="el" href="resource_8cpp_source.html">resource.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a145007aa59912120c2363b109bda18d1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Resource::doClose </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Close this resource. </p>
<p>Pre-condition: resource is open. Post-condition: resource is closed. </p>
<p>Definition at line <a class="el" href="resource_8cpp_source.html#l00221">221</a> of file <a class="el" href="resource_8cpp_source.html">resource.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a8b17cf8733d0c747080e14c3143bf265"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Resource::doOpen </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Open this resource. </p>
<p>When called, the resource must be in a closed state.</p>
<p>Returns true if the resource was opened successfully; returns false if the resource was not opened successfully.</p>
<p>The result of this call can be accessed later by <a class="el" href="classKRES_1_1Resource.html#a4dfd930f90d81362c8e2a64ad2481b39" title="Returns whether the resource is open or not.">isOpen()</a> </p>
<p>Definition at line <a class="el" href="resource_8cpp_source.html#l00216">216</a> of file <a class="el" href="resource_8cpp_source.html">resource.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a6b66cd10ba2b00886d0b191622be9c38"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Resource::dump </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Print resource information as debug output. </p>
<p>Definition at line <a class="el" href="resource_8cpp_source.html#l00204">204</a> of file <a class="el" href="resource_8cpp_source.html">resource.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ae17cf4470b97c121651c4fa5a75a0b83"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString Resource::identifier </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a unique identifier. </p>
<p>The identifier is unique for this resource. It is created when the resource is first created, and it is retained in the resource family configuration file for this resource. </p>
<dl class="section return"><dt>Returns</dt><dd>This resource's identifier </dd></dl>
<p>Definition at line <a class="el" href="resource_8cpp_source.html#l00159">159</a> of file <a class="el" href="resource_8cpp_source.html">resource.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a879c67fdfc7b040a96925bb24400cb19"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Resource::isActive </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return true, if the resource is active. </p>
<p>Definition at line <a class="el" href="resource_8cpp_source.html#l00199">199</a> of file <a class="el" href="resource_8cpp_source.html">resource.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a4dfd930f90d81362c8e2a64ad2481b39"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Resource::isOpen </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns whether the resource is open or not. </p>
<p>Definition at line <a class="el" href="resource_8cpp_source.html#l00149">149</a> of file <a class="el" href="resource_8cpp_source.html">resource.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a0bace10c217883eea74fbd584ce5097b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Resource::open </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Open this resource, if it not already open. </p>
<p>Increase the open count of this object, and open the resource by calling <a class="el" href="classKRES_1_1Resource.html#a8b17cf8733d0c747080e14c3143bf265" title="Open this resource.">doOpen()</a>. This method may block while another thread is concurrently opening or closing the resource.</p>
<p>Returns true if the resource was already opened or if it was opened successfully; returns false if the resource was not opened successfully. </p>
<p>Definition at line <a class="el" href="resource_8cpp_source.html#l00114">114</a> of file <a class="el" href="resource_8cpp_source.html">resource.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a2a35a353d26abefad3ecb113ee5c5de4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Resource::readOnly </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns, if the resource is read-only. </p>
<p>Definition at line <a class="el" href="resource_8cpp_source.html#l00179">179</a> of file <a class="el" href="resource_8cpp_source.html">resource.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a52ebe0cdda9c7968b99b25f85446ef89"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">QString Resource::resourceName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the name of resource. </p>
<p>Definition at line <a class="el" href="resource_8cpp_source.html#l00189">189</a> of file <a class="el" href="resource_8cpp_source.html">resource.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="adbbb6904d693a1e82470c00af000ed1f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Resource::setActive </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>active</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets, if the resource is active. </p>
<p>Definition at line <a class="el" href="resource_8cpp_source.html#l00194">194</a> of file <a class="el" href="resource_8cpp_source.html">resource.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="abebb9edb9158d481d5d6a8d9e8fb8ea2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Resource::setIdentifier </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>identifier</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the resource unique identifier. </p>
<p>Definition at line <a class="el" href="resource_8cpp_source.html#l00154">154</a> of file <a class="el" href="resource_8cpp_source.html">resource.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a021163f496e0d69936118a7960edb02a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Resource::setReadOnly </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Mark the resource as read-only. </p>
<p>You can override this method, but also remember to call <a class="el" href="classKRES_1_1Resource.html#a021163f496e0d69936118a7960edb02a" title="Mark the resource as read-only.">Resource::setReadOnly()</a>. </p>
<p>Definition at line <a class="el" href="resource_8cpp_source.html#l00174">174</a> of file <a class="el" href="resource_8cpp_source.html">resource.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a54ecadca62801e08b9881af3593a05b2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Resource::setResourceName </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the name of resource. </p>
<p>You can override this method, but also remember to call <a class="el" href="classKRES_1_1Resource.html#a54ecadca62801e08b9881af3593a05b2" title="Set the name of resource.">Resource::setResourceName()</a>. </p>
<p>Definition at line <a class="el" href="resource_8cpp_source.html#l00184">184</a> of file <a class="el" href="resource_8cpp_source.html">resource.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a5fd37bff36721435a837754372ab68f3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Resource::setType </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>type</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the resource type. </p>
<p>Definition at line <a class="el" href="resource_8cpp_source.html#l00164">164</a> of file <a class="el" href="resource_8cpp_source.html">resource.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ab6a1040675eb77a2b86592d122a17a90"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString Resource::type </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the type of this resource. </p>
<p>Definition at line <a class="el" href="resource_8cpp_source.html#l00169">169</a> of file <a class="el" href="resource_8cpp_source.html">resource.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ab3baaac13e2733723b143ea82851aca9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Resource::writeConfig </td>
<td>(</td>
<td class="paramtype">KConfigGroup & </td>
<td class="paramname"><em>group</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Write configuration information for this resource to a configuration file. </p>
<p>If you override this method, remember to call <a class="el" href="classKRES_1_1Resource.html#ab3baaac13e2733723b143ea82851aca9" title="Write configuration information for this resource to a configuration file.">Resource::writeConfig</a> or Terrible Things(TM) will happen. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">group</td><td>Configuration group to write persistence information to. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="resource_8cpp_source.html#l00103">103</a> of file <a class="el" href="resource_8cpp_source.html">resource.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="resource_8h_source.html">resource.h</a></li>
<li><a class="el" href="resource_8cpp_source.html">resource.cpp</a></li>
</ul>
</div><!-- contents -->
<div class="copyrights">
This file is part of the KDE documentation.<br/>
Documentation copyright © 1996-2013 The KDE developers.<br/>
Generated on Fri Jul 12 2013 16:48:47 by
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.3.1 written
by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, © 1997-2006
<p>
KDE's <a href="http://techbase.kde.org/Policies/Library_Documentation_Policy">Doxygen guidelines</a> are available online.
</p>
</div>
</div>
</div>
</div>
<div id="left">
<div class="menu_box">
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">kresources</h2>
<a href="#cp-skip-project" class="cp-doNotDisplay">Skip menu "kresources"</a>
</div></div>
<ul><li><a href="index.html">Main Page</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="functions.html">Class Members</a></li><li><a href="files.html">File List</a></li><li><a href="pages.html">Related Pages</a></li></ul>
<!--
<h2>Class Picker</h2>
<div style="text-align: center;">
<form name="guideform">
<select name="guidelinks" style="width:100%;" onChange="window.location=document.guideform.guidelinks.options[document.guideform.guidelinks.selectedIndex].value">
<option value="annotated.html">-- Choose --</option>
<option value="classKRES_1_1ConfigDialog.html">kres::configdialog</option>, <option value="classKRES_1_1ConfigPage.html">kres::configpage</option>, <option value="classKRES_1_1ConfigWidget.html">kres::configwidget</option>, <option value="classKRES_1_1Factory.html">kres::factory</option>, <option value="classKRES_1_1IdMapper.html">kres::idmapper</option>, <option value="classKRES_1_1Manager.html">kres::manager</option>, <option value="classKRES_1_1Manager_1_1ActiveIterator.html">kres::manager::activeiterator</option>, <option value="classKRES_1_1Manager_1_1Iterator.html">kres::manager::iterator</option>, <option value="classKRES_1_1ManagerImpl.html">kres::managerimpl</option>, <option value="classKRES_1_1ManagerNotifier.html">kres::managernotifier</option>, <option value="classKRES_1_1ManagerObserver.html">kres::managerobserver</option>, <option value="classKRES_1_1Resource.html">kres::resource</option>, <option value="classKRES_1_1SelectDialog.html">kres::selectdialog</option>,
</select>
</form>
</div>
-->
<div class="menu_box">
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">kdepimlibs-4.10.5 API Reference</h2>
<a href="#cp-skip-project" class="cp-doNotDisplay">Skip menu "kdepimlibs-4.10.5 API Reference"</a>
</div></div>
<div class="nav_list">
<ul>
<li><a href="../../akonadi/html/index.html">akonadi</a></li><li> <a href="../../akonadi/contact/html/index.html">contact</a></li><li> <a href="../../akonadi/kmime/html/index.html">kmime</a></li><li> <a href="../../akonadi/socialutils/html/index.html">socialutils</a></li><li><a href="../../kabc/html/index.html">kabc</a></li><li><a href="../../kalarmcal/html/index.html">kalarmcal</a></li><li><a href="../../kblog/html/index.html">kblog</a></li><li><a href="../../kcal/html/index.html">kcal</a></li><li><a href="../../kcalcore/html/index.html">kcalcore</a></li><li><a href="../../kcalutils/html/index.html">kcalutils</a></li><li><a href="../../kholidays/html/index.html">kholidays</a></li><li><a href="../../kimap/html/index.html">kimap</a></li><li><a href="../../kioslave/html/index.html">kioslave</a></li><li> <a href="../../kioslave/imap4/html/index.html">imap4</a></li><li> <a href="../../kioslave/mbox/html/index.html">mbox</a></li><li> <a href="../../kioslave/nntp/html/index.html">nntp</a></li><li><a href="../../kldap/html/index.html">kldap</a></li><li><a href="../../kmbox/html/index.html">kmbox</a></li><li><a href="../../kmime/html/index.html">kmime</a></li><li><a href="../../kontactinterface/html/index.html">kontactinterface</a></li><li><a href="../../kpimidentities/html/index.html">kpimidentities</a></li><li><a href="../../kpimtextedit/html/index.html">kpimtextedit</a></li><li><a href="../../kpimutils/html/index.html">kpimutils</a></li><li><a href="../../kresources/html/index.html">kresources</a></li><li><a href="../../ktnef/html/index.html">ktnef</a></li><li><a href="../../kxmlrpcclient/html/index.html">kxmlrpcclient</a></li><li><a href="../../mailtransport/html/index.html">mailtransport</a></li><li><a href="../../microblog/html/index.html">microblog</a></li><li><a href="../../qgpgme/html/index.html">qgpgme</a></li><li><a href="../../syndication/html/index.html">syndication</a></li><li> <a href="../../syndication/atom/html/index.html">atom</a></li><li> <a href="../../syndication/rdf/html/index.html">rdf</a></li><li> <a href="../../syndication/rss2/html/index.html">rss2</a></li>
</ul></div></div>
<!-- api_searchbox -->
</div>
</div>
<div class="clearer"></div>
</div>
<div class="clearer"></div>
</div>
<div id="end_body"></div>
<div id="footer"><div id="footer_text">
Report problems with this website to <a href="https://bugs.kde.org/enter_sysadmin_request.cgi?component=api.kde.org">our bug tracking system</a>.<br>
Contact the specific authors with questions and comments about the page contents.<p>
KDE<sup>®</sup> and <a href="/media/images/kde_gear_black.png">the K Desktop Environment<sup>®</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a></p>
</div></div>
</div>
<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-45abe0e0c3bebc77@kde.org">Block me</a>
WARNING END
-->
</body>
</html>
