Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_sys_state_manager_example.html
Week 32 contribution of PDK documentation content. See release notes for details. Fixes bug Bug 3582
<!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>TB9.2 Example Applications: CSysStateManagerExample 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.6.2 -->
<div class="contents">
<h1>CSysStateManagerExample Class Reference</h1><!-- doxytag: class="CSysStateManagerExample" -->
<p><a href="class_c_sys_state_manager_example-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_sys_state_manager_example.html#a944fe05cd6a679bca6011802bc3dba33">~CSysStateManagerExample</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a95a80d051be2932231699fbe6656a8a6"></a><!-- doxytag: member="CSysStateManagerExample::SSManagerL" ref="a95a80d051be2932231699fbe6656a8a6" args="()" -->
void </td><td class="memItemRight" valign="bottom"><b>SSManagerL</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_sys_state_manager_example.html#a1c585579a816b7e0f8393267a7a7a97a">RequestSwpChange</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_sys_state_manager_example.html#a6b5511414b63e07e00fbff5af8808cad">RequestSsChange</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_sys_state_manager_example.html#a7c3ee7dd5826eb98097e2c2ef43ed980">RequestSwpChangeWithNotificationL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_sys_state_manager_example.html#a3e70c77631e8cd6092de93f51cab49ad">RequestSsChangeWithNotification</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_sys_state_manager_example.html#a0c096e8f81f4c40a24bd43d9962f274e">SwpChanged</a> (TSsmSwp aSwp)</td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8880c28fb3d6b4e8c201a7f26a02449f"></a><!-- doxytag: member="CSysStateManagerExample::NewLC" ref="a8880c28fb3d6b4e8c201a7f26a02449f" args="()" -->
static <a class="el" href="class_c_sys_state_manager_example.html">CSysStateManagerExample</a> * </td><td class="memItemRight" valign="bottom"><b>NewLC</b> ()</td></tr>
<tr><td colspan="2"><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3a3dac4dd201fcc1c9ce102ed97db609"></a><!-- doxytag: member="CSysStateManagerExample::iConsole" ref="a3a3dac4dd201fcc1c9ce102ed97db609" args="" -->
CConsoleBase * </td><td class="memItemRight" valign="bottom"><b>iConsole</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9a55134f0afaeac87fac47d1961b6132"></a><!-- doxytag: member="CSysStateManagerExample::iSsmStateManager" ref="a9a55134f0afaeac87fac47d1961b6132" args="" -->
RSsmStateManager </td><td class="memItemRight" valign="bottom"><b>iSsmStateManager</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="class_c_sys_state_manager_example.html">CSysStateManagerExample</a> demonstrates the various utilities of the System State Manager. 1 - Requesting a change in a System Wide Property (SwP) or in System State (SS), 2 - Notifying the client about a change in a System Wide Property (SwP) or in System State (SS) </p>
<p>Definition at line <a class="el" href="ssmanager_8h_source.html#l00032">32</a> of file <a class="el" href="ssmanager_8h_source.html">ssmanager.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a944fe05cd6a679bca6011802bc3dba33"></a><!-- doxytag: member="CSysStateManagerExample::~CSysStateManagerExample" ref="a944fe05cd6a679bca6011802bc3dba33" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CSysStateManagerExample::~CSysStateManagerExample </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
<p>Definition at line <a class="el" href="ssmanager_8cpp_source.html#l00073">73</a> of file <a class="el" href="ssmanager_8cpp_source.html">ssmanager.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a1c585579a816b7e0f8393267a7a7a97a"></a><!-- doxytag: member="CSysStateManagerExample::RequestSwpChange" ref="a1c585579a816b7e0f8393267a7a7a97a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSysStateManagerExample::RequestSwpChange </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Makes a System Wide Property change request. </p>
<p><p>Example SwP is created and registered using the Normal state policy resource file (<a class="el" href="gsanormalcmdlist_8rss_source.html">gsanormalcmdlist.rss</a>) provided with the example.</p>
</p>
<p>Definition at line <a class="el" href="ssmanager_8cpp_source.html#l00091">91</a> of file <a class="el" href="ssmanager_8cpp_source.html">ssmanager.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a6b5511414b63e07e00fbff5af8808cad"></a><!-- doxytag: member="CSysStateManagerExample::RequestSsChange" ref="a6b5511414b63e07e00fbff5af8808cad" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSysStateManagerExample::RequestSsChange </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Makes a System State Change request. </p>
<p>Definition at line <a class="el" href="ssmanager_8cpp_source.html#l00109">109</a> of file <a class="el" href="ssmanager_8cpp_source.html">ssmanager.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a7c3ee7dd5826eb98097e2c2ef43ed980"></a><!-- doxytag: member="CSysStateManagerExample::RequestSwpChangeWithNotificationL" ref="a7c3ee7dd5826eb98097e2c2ef43ed980" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSysStateManagerExample::RequestSwpChangeWithNotificationL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Makes a System Wide Property change request, and subscribes to receive notifications of when the change is made. </p>
<p><p>CSsmSystemWideProperty is used to monitor for Swp changes. It maintains a list of subscribers for the Swp. Each of the subscribers will be notified about the change.</p>
</p>
<p>Definition at line <a class="el" href="ssmanager_8cpp_source.html#l00146">146</a> of file <a class="el" href="ssmanager_8cpp_source.html">ssmanager.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a3e70c77631e8cd6092de93f51cab49ad"></a><!-- doxytag: member="CSysStateManagerExample::RequestSsChangeWithNotification" ref="a3e70c77631e8cd6092de93f51cab49ad" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSysStateManagerExample::RequestSsChangeWithNotification </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Makes a System State change request, and subscribes to receive notifications of when the change is made. </p>
<p>Definition at line <a class="el" href="ssmanager_8cpp_source.html#l00190">190</a> of file <a class="el" href="ssmanager_8cpp_source.html">ssmanager.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a0c096e8f81f4c40a24bd43d9962f274e"></a><!-- doxytag: member="CSysStateManagerExample::SwpChanged" ref="a0c096e8f81f4c40a24bd43d9962f274e" args="(TSsmSwp aSwp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSysStateManagerExample::SwpChanged </td>
<td>(</td>
<td class="paramtype">TSsmSwp </td>
<td class="paramname"> <em>aSwp</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This API is called to notify the program about a change in a SwP value. </p>
<p>Definition at line <a class="el" href="ssmanager_8cpp_source.html#l00082">82</a> of file <a class="el" href="ssmanager_8cpp_source.html">ssmanager.cpp</a>.</p>
</div>
</div>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>