Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_feat_mngr_example.html
author Dominic Pinkman <dominic.pinkman@nokia.com>
Fri, 13 Aug 2010 16:47:46 +0100
changeset 14 578be2adaf3e
parent 6 43e37759235e
permissions -rw-r--r--
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: CFeatMngrExample 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>CFeatMngrExample Class Reference</h1><!-- doxytag: class="CFeatMngrExample" -->
<p><a href="class_c_feat_mngr_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">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_feat_mngr_example.html#a3ae7073d06744fb9088d2fa0dbbad3f5">~CFeatMngrExample</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4317ac96ed2dd3ce07bb491d1cb7438d"></a><!-- doxytag: member="CFeatMngrExample::RequestCharacter" ref="a4317ac96ed2dd3ce07bb491d1cb7438d" args="()" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>RequestCharacter</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_feat_mngr_example.html#a85093d5fbf8f322d40d9847ad56f4dc1">ProcessKeyPressL</a> (TChar)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3659fa6612953937b60c58f3ce44013a"></a><!-- doxytag: member="CFeatMngrExample::DoCancel" ref="a3659fa6612953937b60c58f3ce44013a" args="()" -->
virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><b>DoCancel</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a992baac644a9bb62cde479ea18855311"></a><!-- doxytag: member="CFeatMngrExample::RunL" ref="a992baac644a9bb62cde479ea18855311" args="()" -->
virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><b>RunL</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_feat_mngr_example.html#a31dd0f3394355f0e1a3ff9472c7e1c36">AddL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_feat_mngr_example.html#a82b08ef640e63540424ce1c45d8dc88f">DeleteL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_feat_mngr_example.html#a61e725ad3ad030deb9785fdd5e9624b3">UpdateL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_feat_mngr_example.html#a841f40d4b9488f6e02f5abfaaf692bd2">ListFeaturesL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_feat_mngr_example.html#ab294a09f4686c515062329e045563445">CheckFeatureSupportL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_feat_mngr_example.html#aac0b9cf0f234a0342df2b80f12fe13c6">EnableFeatureL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TInt64&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_feat_mngr_example.html#a97ca8c2de0959fe9235c182a9af9a744">GetUserInput</a> (TBool aDecimal)</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="acccda3705abe16c80ac6c83ca5213a24"></a><!-- doxytag: member="CFeatMngrExample::NewL" ref="acccda3705abe16c80ac6c83ca5213a24" args="(TInt aPriority=EPriorityStandard)" -->
static <a class="el" href="class_c_feat_mngr_example.html">CFeatMngrExample</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>NewL</b> (TInt aPriority=EPriorityStandard)</td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7a1b591deb88ee5d8422d96e802e0da9"></a><!-- doxytag: member="CFeatMngrExample::ConstructL" ref="a7a1b591deb88ee5d8422d96e802e0da9" args="()" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>ConstructL</b> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Demonstrates how to use the RFeatureControl class to add, delete, update and modify features.</p>
<p>This class presents the main menu to the user. Depending on the user's input, it performs various feature-related operations. It also creates and runs the FeatureChecker process so that any changes to features made in this process receive corresponding notification. </p>

<p>Definition at line <a class="el" href="_feat_mngr_example_8h_source.html#l00033">33</a> of file <a class="el" href="_feat_mngr_example_8h_source.html">FeatMngrExample.h</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a3ae7073d06744fb9088d2fa0dbbad3f5"></a><!-- doxytag: member="CFeatMngrExample::~CFeatMngrExample" ref="a3ae7073d06744fb9088d2fa0dbbad3f5" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CFeatMngrExample::~CFeatMngrExample </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Destructor </p>

<p>Definition at line <a class="el" href="_feat_mngr_example_8cpp_source.html#l00058">58</a> of file <a class="el" href="_feat_mngr_example_8cpp_source.html">FeatMngrExample.cpp</a>.</p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a85093d5fbf8f322d40d9847ad56f4dc1"></a><!-- doxytag: member="CFeatMngrExample::ProcessKeyPressL" ref="a85093d5fbf8f322d40d9847ad56f4dc1" args="(TChar)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CFeatMngrExample::ProcessKeyPressL </td>
          <td>(</td>
          <td class="paramtype">TChar&nbsp;</td>
          <td class="paramname"> <em>aChar</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>This function is called after the user has made a selection from the menu options. Depending on the user's choice, the appropriate function is called. </p>

<p>Definition at line <a class="el" href="_feat_mngr_example_8cpp_source.html#l00080">80</a> of file <a class="el" href="_feat_mngr_example_8cpp_source.html">FeatMngrExample.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a31dd0f3394355f0e1a3ff9472c7e1c36"></a><!-- doxytag: member="CFeatMngrExample::AddL" ref="a31dd0f3394355f0e1a3ff9472c7e1c36" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CFeatMngrExample::AddL </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Gets the UID of a feature added by the user. A limited range of UIDs is subscribed to by the FeatureChecker process. The UID should be in that range. </p>

<p>Definition at line <a class="el" href="_feat_mngr_example_8cpp_source.html#l00124">124</a> of file <a class="el" href="_feat_mngr_example_8cpp_source.html">FeatMngrExample.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a82b08ef640e63540424ce1c45d8dc88f"></a><!-- doxytag: member="CFeatMngrExample::DeleteL" ref="a82b08ef640e63540424ce1c45d8dc88f" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CFeatMngrExample::DeleteL </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Gets the UID of the feature which needs to be deleted and deletes it. This causes the corresponding notification to be received by the featurechecker process. </p>

<p>Definition at line <a class="el" href="_feat_mngr_example_8cpp_source.html#l00162">162</a> of file <a class="el" href="_feat_mngr_example_8cpp_source.html">FeatMngrExample.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a61e725ad3ad030deb9785fdd5e9624b3"></a><!-- doxytag: member="CFeatMngrExample::UpdateL" ref="a61e725ad3ad030deb9785fdd5e9624b3" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CFeatMngrExample::UpdateL </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Updates the feature data. </p>

<p>Definition at line <a class="el" href="_feat_mngr_example_8cpp_source.html#l00315">315</a> of file <a class="el" href="_feat_mngr_example_8cpp_source.html">FeatMngrExample.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a841f40d4b9488f6e02f5abfaaf692bd2"></a><!-- doxytag: member="CFeatMngrExample::ListFeaturesL" ref="a841f40d4b9488f6e02f5abfaaf692bd2" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CFeatMngrExample::ListFeaturesL </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Gets the list of all the current features. </p>

<p>Definition at line <a class="el" href="_feat_mngr_example_8cpp_source.html#l00245">245</a> of file <a class="el" href="_feat_mngr_example_8cpp_source.html">FeatMngrExample.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="ab294a09f4686c515062329e045563445"></a><!-- doxytag: member="CFeatMngrExample::CheckFeatureSupportL" ref="ab294a09f4686c515062329e045563445" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CFeatMngrExample::CheckFeatureSupportL </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Checks if the given feature is supported in the current environment. If it is not supported it prints an error message, depending on the value returned by RFeatureControl::FeatureSupported(). </p>

<p>Definition at line <a class="el" href="_feat_mngr_example_8cpp_source.html#l00207">207</a> of file <a class="el" href="_feat_mngr_example_8cpp_source.html">FeatMngrExample.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="aac0b9cf0f234a0342df2b80f12fe13c6"></a><!-- doxytag: member="CFeatMngrExample::EnableFeatureL" ref="aac0b9cf0f234a0342df2b80f12fe13c6" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CFeatMngrExample::EnableFeatureL </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Gets the UID of the feature whose feature flag needs to be updated. This causes the corresponding notification to be received by the featurechecker process. </p>

<p>Definition at line <a class="el" href="_feat_mngr_example_8cpp_source.html#l00182">182</a> of file <a class="el" href="_feat_mngr_example_8cpp_source.html">FeatMngrExample.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a97ca8c2de0959fe9235c182a9af9a744"></a><!-- doxytag: member="CFeatMngrExample::GetUserInput" ref="a97ca8c2de0959fe9235c182a9af9a744" args="(TBool aDecimal)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TInt64 CFeatMngrExample::GetUserInput </td>
          <td>(</td>
          <td class="paramtype">TBool&nbsp;</td>
          <td class="paramname"> <em>aDecimal</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Takes input from the console and returns a TInt64 value. It resembles scanf. It takes a boolean value as a parameter which identifies whether the data to be scanned is decimal or hexadecimal.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>aDecimal</em>&nbsp;</td><td>When the user inputs a decimal number this is set to true and when the input is hexadecimal, it is false. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="_feat_mngr_example_8cpp_source.html#l00277">277</a> of file <a class="el" href="_feat_mngr_example_8cpp_source.html">FeatMngrExample.cpp</a>.</p>

</div>
</div>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>