Mercurial Mercurial > oss > MCL > sftools > depl > docscontent / comparison
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_battery_info.html
changeset 6 43e37759235e
parent 1 25a17d01db0c
equal deleted inserted replaced
5:f345bda72bc4 6:43e37759235e 
     1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
     1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
     2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
 
     2 <html xmlns="http://www.w3.org/1999/xhtml">
 
     3 <title>TB10.1 Example Applications: CBatteryInfo Class Reference</title>
 
     3 <head>
 
     4 <link href="doxygen.css" rel="stylesheet" type="text/css">
 
     4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 
     5 <link href="tabs.css" rel="stylesheet" type="text/css">
 
     5 <title>TB9.2 Example Applications: CBatteryInfo Class Reference</title>
 
     6 </head><body>
 
     6 <link href="tabs.css" rel="stylesheet" type="text/css"/>
 
     7 <!-- Generated by Doxygen 1.5.3 -->
 
     7 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
 
     8 <h1>CBatteryInfo Class Reference</h1><!-- doxytag: class="CBatteryInfo" --><!-- doxytag: inherits="CISVAPIAsync" --><div class="dynheader">
 
     8 </head>
 
     9 Inheritance diagram for CBatteryInfo:</div>
 
     9 <body>
 
    10 <div class="dynsection">
 
    10 <!-- Generated by Doxygen 1.6.2 -->
 
       
    11 <div class="contents">
 
       
    12 <h1>CBatteryInfo Class Reference</h1><!-- doxytag: class="CBatteryInfo" --><!-- doxytag: inherits="CISVAPIAsync" -->
 
       
    13 <p>Inherits <a class="el" href="class_c_i_s_v_a_p_i_async.html">CISVAPIAsync</a>.</p>
 
    11 
    14 
    12 <p><center><img src="class_c_battery_info.png" usemap="#CBatteryInfo_map" border="0" alt=""></center>
 
    15 <p><a href="class_c_battery_info-members.html">List of all members.</a></p>
 
    13 <map name="CBatteryInfo_map">
 
    16 <table border="0" cellpadding="0" cellspacing="0">
 
    14 <area href="class_c_i_s_v_a_p_i_async.html" alt="CISVAPIAsync" shape="rect" coords="0,56,97,80">
 
    17 <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
 
    15 <area href="class_c_i_s_v_a_p_i_base.html" alt="CISVAPIBase" shape="rect" coords="0,0,97,24">
 
    18 <tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_battery_info.html#af8e41e058fe1bbc60a94ad8473d03c05">~CBatteryInfo</a> ()</td></tr>
 
    16 </map>
 
    19 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_battery_info.html#a268d2caf629b3914a216ccd9a2086d28">DoStartRequestL</a> ()</td></tr>
 
    17 </div>
 
    20 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_battery_info.html#ab6b32126941aa49f977e0a4bcdbfb2d3">DoRequestNotificationL</a> ()</td></tr>
 
       
    21 <tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
 
       
    22 <tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_battery_info.html">CBatteryInfo</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_battery_info.html#a85ba46a300b9a3c59d8d3650427965f6">NewL</a> (<a class="el" href="class_m_exec_async.html">MExecAsync</a> *aController)</td></tr>
 
       
    23 <tr><td colspan="2"><h2>Public Attributes</h2></td></tr>
 
       
    24 <tr><td class="memItemLeft" align="right" valign="top">CTelephony::TBatteryInfoV1&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_battery_info.html#a1e2c2f264314ddcc90a1036678c5683e">iBatteryInfoV1</a></td></tr>
 
       
    25 </table>
 
       
    26 <hr/><a name="_details"></a><h2>Detailed Description</h2>
 
       
    27 <p>Retrieves the current state of the battery charge level can be notified on change of battery status. </p>
 
    18 
    28 
    19 <p>
 
    29 <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>
 
    20 <a href="class_c_battery_info-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
 
    30 <hr/><h2>Constructor &amp; Destructor Documentation</h2>
 
    21 <tr><td></td></tr>
 
    31 <a class="anchor" id="af8e41e058fe1bbc60a94ad8473d03c05"></a><!-- doxytag: member="CBatteryInfo::~CBatteryInfo" ref="af8e41e058fe1bbc60a94ad8473d03c05" args="()" -->
 
    22 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
 
       
    23 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_battery_info.html#f8e41e058fe1bbc60a94ad8473d03c05">~CBatteryInfo</a> ()</td></tr>
 
       
    24 
       
    25 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_battery_info.html#268d2caf629b3914a216ccd9a2086d28">DoStartRequestL</a> ()</td></tr>
 
       
    26 
       
    27 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_battery_info.html#b6b32126941aa49f977e0a4bcdbfb2d3">DoRequestNotificationL</a> ()</td></tr>
 
       
    28 
       
    29 <tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
 
       
    30 <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="class_c_battery_info.html">CBatteryInfo</a> *&nbsp;</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>
 
       
    31 
       
    32 <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
 
       
    33 <tr><td class="memItemLeft" nowrap align="right" valign="top">CTelephony::TBatteryInfoV1&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_battery_info.html#1e2c2f264314ddcc90a1036678c5683e">iBatteryInfoV1</a></td></tr>
 
       
    34 
       
    35 </table>
 
       
    36 <hr><a name="_details"></a><h2>Detailed Description</h2>
 
       
    37 Retrieves the current state of the battery charge level can be notified on change of battery status. 
       
    38 <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>
 
       
    39 <hr><h2>Constructor &amp; Destructor Documentation</h2>
 
       
    40 <a class="anchor" name="f8e41e058fe1bbc60a94ad8473d03c05"></a><!-- doxytag: member="CBatteryInfo::~CBatteryInfo" ref="f8e41e058fe1bbc60a94ad8473d03c05" args="()" -->
 
       
    41 <div class="memitem">
 
    32 <div class="memitem">
 
    42 <div class="memproto">
 
    33 <div class="memproto">
 
    43       <table class="memname">
 
    34       <table class="memname">
 
    44         <tr>
 
    35         <tr>
 
    45           <td class="memname">CBatteryInfo::~CBatteryInfo           </td>
 
    36           <td class="memname">CBatteryInfo::~CBatteryInfo </td>
 
    46           <td>(</td>
 
    37           <td>(</td>
 
    47           <td class="paramname">          </td>
 
    38           <td class="paramname"></td>
 
    48           <td>&nbsp;)&nbsp;</td>
 
    39           <td>&nbsp;)&nbsp;</td>
 
    49           <td width="100%"></td>
 
    40           <td></td>
 
    50         </tr>
 
    41         </tr>
 
    51       </table>
 
    42       </table>
 
    52 </div>
 
    43 </div>
 
    53 <div class="memdoc">
 
    44 <div class="memdoc">
 
       
    45 <p>Destructor. Cancels outstanding requests. </p>
 
    54 
    46 
    55 <p>
 
    47 <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>
 
    56 Destructor. Cancels outstanding requests. 
       
    57 <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>
 
       
    58 
    48 
    59 </div>
 
    49 </div>
 
    60 </div><p>
 
    50 </div>
 
    61 <hr><h2>Member Function Documentation</h2>
 
    51 <hr/><h2>Member Function Documentation</h2>
 
    62 <a class="anchor" name="85ba46a300b9a3c59d8d3650427965f6"></a><!-- doxytag: member="CBatteryInfo::NewL" ref="85ba46a300b9a3c59d8d3650427965f6" args="(MExecAsync *aController)" -->
 
    52 <a class="anchor" id="a85ba46a300b9a3c59d8d3650427965f6"></a><!-- doxytag: member="CBatteryInfo::NewL" ref="a85ba46a300b9a3c59d8d3650427965f6" args="(MExecAsync *aController)" -->
 
    63 <div class="memitem">
 
    53 <div class="memitem">
 
    64 <div class="memproto">
 
    54 <div class="memproto">
 
    65       <table class="memname">
 
    55       <table class="memname">
 
    66         <tr>
 
    56         <tr>
 
    67           <td class="memname"><a class="el" href="class_c_battery_info.html">CBatteryInfo</a> * CBatteryInfo::NewL           </td>
 
    57           <td class="memname"><a class="el" href="class_c_battery_info.html">CBatteryInfo</a> * CBatteryInfo::NewL </td>
 
    68           <td>(</td>
 
    58           <td>(</td>
 
    69           <td class="paramtype"><a class="el" href="class_m_exec_async.html">MExecAsync</a> *&nbsp;</td>
 
    59           <td class="paramtype"><a class="el" href="class_m_exec_async.html">MExecAsync</a> *&nbsp;</td>
 
    70           <td class="paramname"> <em>aController</em>          </td>
 
    60           <td class="paramname"> <em>aController</em></td>
 
    71           <td>&nbsp;)&nbsp;</td>
 
    61           <td>&nbsp;)&nbsp;</td>
 
    72           <td width="100%"><code> [static]</code></td>
 
    62           <td><code> [static]</code></td>
 
    73         </tr>
 
    63         </tr>
 
    74       </table>
 
    64       </table>
 
    75 </div>
 
    65 </div>
 
    76 <div class="memdoc">
 
    66 <div class="memdoc">
 
    77 
    67 <p>Factory constructor.</p>
 
    78 <p>
 
    68 <dl><dt><b>Parameters:</b></dt><dd>
 
    79 Factory constructor.<p>
 
       
    80 <dl compact><dt><b>Parameters:</b></dt><dd>
 
       
    81   <table border="0" cellspacing="2" cellpadding="0">
 
    69   <table border="0" cellspacing="2" cellpadding="0">
 
    82     <tr><td valign="top"></td><td valign="top"><em>aController</em>&nbsp;</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>
 
    70     <tr><td valign="top"></td><td valign="top"><em>aController</em>&nbsp;</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>
 
    83   </table>
 
    71   </table>
 
       
    72   </dd>
 
    84 </dl>
 
    73 </dl>
 
    85 <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>
 
    74 <dl class="return"><dt><b>Returns:</b></dt><dd>Instance of <a class="el" href="class_c_battery_info.html">CBatteryInfo</a> class </dd></dl>
 
    86 
    75 
    87 <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>
 
    76 <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>
 
    88 
    77 
    89 </div>
 
    78 </div>
 
    90 </div><p>
 
    79 </div>
 
    91 <a class="anchor" name="268d2caf629b3914a216ccd9a2086d28"></a><!-- doxytag: member="CBatteryInfo::DoStartRequestL" ref="268d2caf629b3914a216ccd9a2086d28" args="()" -->
 
    80 <a class="anchor" id="a268d2caf629b3914a216ccd9a2086d28"></a><!-- doxytag: member="CBatteryInfo::DoStartRequestL" ref="a268d2caf629b3914a216ccd9a2086d28" args="()" -->
 
    92 <div class="memitem">
 
    81 <div class="memitem">
 
    93 <div class="memproto">
 
    82 <div class="memproto">
 
    94       <table class="memname">
 
    83       <table class="memname">
 
    95         <tr>
 
    84         <tr>
 
    96           <td class="memname">void CBatteryInfo::DoStartRequestL           </td>
 
    85           <td class="memname">void CBatteryInfo::DoStartRequestL </td>
 
    97           <td>(</td>
 
    86           <td>(</td>
 
    98           <td class="paramname">          </td>
 
    87           <td class="paramname"></td>
 
    99           <td>&nbsp;)&nbsp;</td>
 
    88           <td>&nbsp;)&nbsp;</td>
 
   100           <td width="100%"><code> [virtual]</code></td>
 
    89           <td><code> [virtual]</code></td>
 
   101         </tr>
 
    90         </tr>
 
   102       </table>
 
    91       </table>
 
   103 </div>
 
    92 </div>
 
   104 <div class="memdoc">
 
    93 <div class="memdoc">
 
       
    94 <p>Gets battery information and stores it in the iBatteryInfoV1Pckg. </p>
 
   105 
    95 
   106 <p>
 
    96 <p>Reimplemented from <a class="el" href="class_c_i_s_v_a_p_i_base.html#af5a272546d704790a27788fcd45598b5">CISVAPIBase</a>.</p>
 
   107 Gets battery information and stores it in the iBatteryInfoV1Pckg. 
       
   108 <p>Reimplemented from <a class="el" href="class_c_i_s_v_a_p_i_base.html#f5a272546d704790a27788fcd45598b5">CISVAPIBase</a>.</p>
 
       
   109 
    97 
   110 <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>
 
    98 <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>
 
   111 
    99 
   112 </div>
 
   100 </div>
 
   113 </div><p>
 
   101 </div>
 
   114 <a class="anchor" name="b6b32126941aa49f977e0a4bcdbfb2d3"></a><!-- doxytag: member="CBatteryInfo::DoRequestNotificationL" ref="b6b32126941aa49f977e0a4bcdbfb2d3" args="()" -->
 
   102 <a class="anchor" id="ab6b32126941aa49f977e0a4bcdbfb2d3"></a><!-- doxytag: member="CBatteryInfo::DoRequestNotificationL" ref="ab6b32126941aa49f977e0a4bcdbfb2d3" args="()" -->
 
   115 <div class="memitem">
 
   103 <div class="memitem">
 
   116 <div class="memproto">
 
   104 <div class="memproto">
 
   117       <table class="memname">
 
   105       <table class="memname">
 
   118         <tr>
 
   106         <tr>
 
   119           <td class="memname">void CBatteryInfo::DoRequestNotificationL           </td>
 
   107           <td class="memname">void CBatteryInfo::DoRequestNotificationL </td>
 
   120           <td>(</td>
 
   108           <td>(</td>
 
   121           <td class="paramname">          </td>
 
   109           <td class="paramname"></td>
 
   122           <td>&nbsp;)&nbsp;</td>
 
   110           <td>&nbsp;)&nbsp;</td>
 
   123           <td width="100%"><code> [virtual]</code></td>
 
   111           <td><code> [virtual]</code></td>
 
   124         </tr>
 
   112         </tr>
 
   125       </table>
 
   113       </table>
 
   126 </div>
 
   114 </div>
 
   127 <div class="memdoc">
 
   115 <div class="memdoc">
 
       
   116 <p>Requests to receive notifications of change in the battery information. </p>
 
   128 
   117 
   129 <p>
 
   118 <p>Reimplemented from <a class="el" href="class_c_i_s_v_a_p_i_base.html#a0c13d9526d07940b6c8f6504e6e2c559">CISVAPIBase</a>.</p>
 
   130 Requests to receive notifications of change in the battery information. 
       
   131 <p>Reimplemented from <a class="el" href="class_c_i_s_v_a_p_i_base.html#0c13d9526d07940b6c8f6504e6e2c559">CISVAPIBase</a>.</p>
 
       
   132 
   119 
   133 <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>
 
   120 <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>
 
   134 
   121 
   135 </div>
 
   122 </div>
 
   136 </div><p>
 
   123 </div>
 
   137 <hr><h2>Member Data Documentation</h2>
 
   124 <hr/><h2>Member Data Documentation</h2>
 
   138 <a class="anchor" name="1e2c2f264314ddcc90a1036678c5683e"></a><!-- doxytag: member="CBatteryInfo::iBatteryInfoV1" ref="1e2c2f264314ddcc90a1036678c5683e" args="" -->
 
   125 <a class="anchor" id="a1e2c2f264314ddcc90a1036678c5683e"></a><!-- doxytag: member="CBatteryInfo::iBatteryInfoV1" ref="a1e2c2f264314ddcc90a1036678c5683e" args="" -->
 
   139 <div class="memitem">
 
   126 <div class="memitem">
 
   140 <div class="memproto">
 
   127 <div class="memproto">
 
   141       <table class="memname">
 
   128       <table class="memname">
 
   142         <tr>
 
   129         <tr>
 
   143           <td class="memname">CTelephony::TBatteryInfoV1 <a class="el" href="class_c_battery_info.html#1e2c2f264314ddcc90a1036678c5683e">CBatteryInfo::iBatteryInfoV1</a>          </td>
 
   130           <td class="memname">CTelephony::TBatteryInfoV1 <a class="el" href="class_c_battery_info.html#a1e2c2f264314ddcc90a1036678c5683e">CBatteryInfo::iBatteryInfoV1</a></td>
 
   144         </tr>
 
   131         </tr>
 
   145       </table>
 
   132       </table>
 
   146 </div>
 
   133 </div>
 
   147 <div class="memdoc">
 
   134 <div class="memdoc">
 
       
   135 <p>Stores retrieved phone battery information. </p>
 
   148 
   136 
   149 <p>
 
   137 <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>
 
   150 Stores retrieved phone battery information. 
       
   151 <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>
 
       
   152 
   138 
   153 </div>
 
   139 </div>
 
   154 </div><p>
 
   140 </div>
 
   155 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:33:03 2010 for TB10.1 Example Applications by&nbsp;
 
   141 </div>
 
       
   142 <hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
 
   156 <a href="http://www.doxygen.org/index.html">
 
   143 <a href="http://www.doxygen.org/index.html">
 
   157 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
 
   144 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
 
   158 </body>
 
   145 </body>
 
   159 </html>
 
   146 </html>
MCL/sftools/depl/docscontent