Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_battery_info.html
Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>TB10.1 Example Applications: CBatteryInfo Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.3 -->
<h1>CBatteryInfo Class Reference</h1><!-- doxytag: class="CBatteryInfo" --><!-- doxytag: inherits="CISVAPIAsync" --><div class="dynheader">
Inheritance diagram for CBatteryInfo:</div>
<div class="dynsection">
<p><center><img src="class_c_battery_info.png" usemap="#CBatteryInfo_map" border="0" alt=""></center>
<map name="CBatteryInfo_map">
<area href="class_c_i_s_v_a_p_i_async.html" alt="CISVAPIAsync" shape="rect" coords="0,56,97,80">
<area href="class_c_i_s_v_a_p_i_base.html" alt="CISVAPIBase" shape="rect" coords="0,0,97,24">
</map>
</div>
<p>
<a href="class_c_battery_info-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_battery_info.html#f8e41e058fe1bbc60a94ad8473d03c05">~CBatteryInfo</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_battery_info.html#268d2caf629b3914a216ccd9a2086d28">DoStartRequestL</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_battery_info.html#b6b32126941aa49f977e0a4bcdbfb2d3">DoRequestNotificationL</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="class_c_battery_info.html">CBatteryInfo</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_battery_info.html#85ba46a300b9a3c59d8d3650427965f6">NewL</a> (<a class="el" href="class_m_exec_async.html">MExecAsync</a> *aController)</td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">CTelephony::TBatteryInfoV1 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_battery_info.html#1e2c2f264314ddcc90a1036678c5683e">iBatteryInfoV1</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Retrieves the current state of the battery charge level can be notified on change of battery status.
<p>Definition at line <a class="el" href="_c_battery_info_8h-source.html#l00033">33</a> of file <a class="el" href="_c_battery_info_8h-source.html">CBatteryInfo.h</a>.</p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="f8e41e058fe1bbc60a94ad8473d03c05"></a><!-- doxytag: member="CBatteryInfo::~CBatteryInfo" ref="f8e41e058fe1bbc60a94ad8473d03c05" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CBatteryInfo::~CBatteryInfo </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor. Cancels outstanding requests.
<p>Definition at line <a class="el" href="_c_battery_info_8cpp-source.html#l00039">39</a> of file <a class="el" href="_c_battery_info_8cpp-source.html">CBatteryInfo.cpp</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="85ba46a300b9a3c59d8d3650427965f6"></a><!-- doxytag: member="CBatteryInfo::NewL" ref="85ba46a300b9a3c59d8d3650427965f6" args="(MExecAsync *aController)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_battery_info.html">CBatteryInfo</a> * CBatteryInfo::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 width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Factory constructor.<p>
<dl compact><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>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Instance of <a class="el" href="class_c_battery_info.html">CBatteryInfo</a> class </dd></dl>
<p>Definition at line <a class="el" href="_c_battery_info_8cpp-source.html#l00026">26</a> of file <a class="el" href="_c_battery_info_8cpp-source.html">CBatteryInfo.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="268d2caf629b3914a216ccd9a2086d28"></a><!-- doxytag: member="CBatteryInfo::DoStartRequestL" ref="268d2caf629b3914a216ccd9a2086d28" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CBatteryInfo::DoStartRequestL </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets battery information and stores it in the iBatteryInfoV1Pckg.
<p>Reimplemented from <a class="el" href="class_c_i_s_v_a_p_i_base.html#f5a272546d704790a27788fcd45598b5">CISVAPIBase</a>.</p>
<p>Definition at line <a class="el" href="_c_battery_info_8cpp-source.html#l00047">47</a> of file <a class="el" href="_c_battery_info_8cpp-source.html">CBatteryInfo.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="b6b32126941aa49f977e0a4bcdbfb2d3"></a><!-- doxytag: member="CBatteryInfo::DoRequestNotificationL" ref="b6b32126941aa49f977e0a4bcdbfb2d3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CBatteryInfo::DoRequestNotificationL </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Requests to receive notifications of change in the battery information.
<p>Reimplemented from <a class="el" href="class_c_i_s_v_a_p_i_base.html#0c13d9526d07940b6c8f6504e6e2c559">CISVAPIBase</a>.</p>
<p>Definition at line <a class="el" href="_c_battery_info_8cpp-source.html#l00140">140</a> of file <a class="el" href="_c_battery_info_8cpp-source.html">CBatteryInfo.cpp</a>.</p>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="1e2c2f264314ddcc90a1036678c5683e"></a><!-- doxytag: member="CBatteryInfo::iBatteryInfoV1" ref="1e2c2f264314ddcc90a1036678c5683e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CTelephony::TBatteryInfoV1 <a class="el" href="class_c_battery_info.html#1e2c2f264314ddcc90a1036678c5683e">CBatteryInfo::iBatteryInfoV1</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Stores retrieved phone battery information.
<p>Definition at line <a class="el" href="_c_battery_info_8h-source.html#l00056">56</a> of file <a class="el" href="_c_battery_info_8h-source.html">CBatteryInfo.h</a>.</p>
</div>
</div><p>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:33:03 2010 for TB10.1 Example Applications by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
</body>
</html>