Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_get_indicator.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: CGetIndicator 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>CGetIndicator Class Reference</h1><!-- doxytag: class="CGetIndicator" --><!-- doxytag: inherits="CISVAPIAsync" -->
<p>Inherits <a class="el" href="class_c_i_s_v_a_p_i_async.html">CISVAPIAsync</a>.</p>
<p><a href="class_c_get_indicator-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_get_indicator.html#a77600d71a6f06c5bd04ae1cf5dde3576">~CGetIndicator</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_get_indicator.html#ae949e31554b2459d1419df06ca13941e">DoStartRequestL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_get_indicator.html#a6ef0f9aec7f2a7f56de340900e1fd40d">DoRequestNotificationL</a> ()</td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_get_indicator.html">CGetIndicator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_get_indicator.html#adf1e54018578d6d0126e217f33fc04f3">NewL</a> (<a class="el" href="class_m_exec_async.html">MExecAsync</a> *aController)</td></tr>
<tr><td colspan="2"><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">CTelephony::TIndicatorV1 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_get_indicator.html#a45ffb6c848034100371cf99ed9a8d379">iIndicatorV1</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Retrieves a bitmask pertaining to data on the current state of the network connection, whether the battery charger is connected and whether there is an active call or not. Can be notified on change. </p>
<p>Definition at line <a class="el" href="_c_get_indicator_8h_source.html#l00034">34</a> of file <a class="el" href="_c_get_indicator_8h_source.html">CGetIndicator.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a77600d71a6f06c5bd04ae1cf5dde3576"></a><!-- doxytag: member="CGetIndicator::~CGetIndicator" ref="a77600d71a6f06c5bd04ae1cf5dde3576" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CGetIndicator::~CGetIndicator </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. Cancels outstanding requests. </p>
<p>Definition at line <a class="el" href="_c_get_indicator_8cpp_source.html#l00038">38</a> of file <a class="el" href="_c_get_indicator_8cpp_source.html">CGetIndicator.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="adf1e54018578d6d0126e217f33fc04f3"></a><!-- doxytag: member="CGetIndicator::NewL" ref="adf1e54018578d6d0126e217f33fc04f3" args="(MExecAsync *aController)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_get_indicator.html">CGetIndicator</a> * CGetIndicator::NewL </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_m_exec_async.html">MExecAsync</a> * </td>
<td class="paramname"> <em>aController</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Factory constructor.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aController</em> </td><td>Pointer to <a class="el" href="class_m_exec_async.html">MExecAsync</a> object passed to constructor of <a class="el" href="class_c_i_s_v_a_p_i_base.html">CISVAPIBase</a> </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Instance of <a class="el" href="class_c_get_indicator.html">CGetIndicator</a> class </dd></dl>
<p>Definition at line <a class="el" href="_c_get_indicator_8cpp_source.html#l00025">25</a> of file <a class="el" href="_c_get_indicator_8cpp_source.html">CGetIndicator.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ae949e31554b2459d1419df06ca13941e"></a><!-- doxytag: member="CGetIndicator::DoStartRequestL" ref="ae949e31554b2459d1419df06ca13941e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CGetIndicator::DoStartRequestL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the indicator information (information regarding whether the battery charger is connected and stores it in the iIndicatorV1Pckg package. </p>
<p>Reimplemented from <a class="el" href="class_c_i_s_v_a_p_i_base.html#af5a272546d704790a27788fcd45598b5">CISVAPIBase</a>.</p>
<p>Definition at line <a class="el" href="_c_get_indicator_8cpp_source.html#l00047">47</a> of file <a class="el" href="_c_get_indicator_8cpp_source.html">CGetIndicator.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a6ef0f9aec7f2a7f56de340900e1fd40d"></a><!-- doxytag: member="CGetIndicator::DoRequestNotificationL" ref="a6ef0f9aec7f2a7f56de340900e1fd40d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CGetIndicator::DoRequestNotificationL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Requests to receive notifications of change in the indicator information. </p>
<p>Reimplemented from <a class="el" href="class_c_i_s_v_a_p_i_base.html#a0c13d9526d07940b6c8f6504e6e2c559">CISVAPIBase</a>.</p>
<p>Definition at line <a class="el" href="_c_get_indicator_8cpp_source.html#l00128">128</a> of file <a class="el" href="_c_get_indicator_8cpp_source.html">CGetIndicator.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a45ffb6c848034100371cf99ed9a8d379"></a><!-- doxytag: member="CGetIndicator::iIndicatorV1" ref="a45ffb6c848034100371cf99ed9a8d379" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CTelephony::TIndicatorV1 <a class="el" href="class_c_get_indicator.html#a45ffb6c848034100371cf99ed9a8d379">CGetIndicator::iIndicatorV1</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Stores retrieved indicator information. </p>
<p>Definition at line <a class="el" href="_c_get_indicator_8h_source.html#l00057">57</a> of file <a class="el" href="_c_get_indicator_8h_source.html">CGetIndicator.h</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>