Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_log_view.html
Initial contribution of the Adaptation Documentation.
<!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: CLogView 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>CLogView Class Reference</h1><!-- doxytag: class="CLogView" -->
<p><a href="class_c_log_view-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_log_view.html#a0d21a89655cc79416f64bb7449ceb9ea">~CLogView</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TUid </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_log_view.html#a3d3844728954242e0055eb2d59ee8561">Id</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_log_view.html#a044ac3a1fa166e828b8091882da7312a">HandleCommandL</a> (TInt aCommand)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_log_view.html#aa72bb3e0cfa1cfb380b37a00870bc979">DoActivateL</a> (const TVwsViewId &aPrevViewId, TUid aCustomMessageId, const TDesC8 &aCustomMessage)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_log_view.html#a3844e555ced5ef8c6c7a0005e5a205e9">DoDeactivate</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3b846f8c314af780c994026b83908742"></a><!-- doxytag: member="CLogView::SizeChanged" ref="a3b846f8c314af780c994026b83908742" args="()" -->
void </td><td class="memItemRight" valign="bottom"><b>SizeChanged</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_log_view.html#a3b8c699df18510fd84524a483b7945e5">DrawTextL</a> (const TDesC &aText)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_log_view.html#a969ede3e5afcf6913877d139a248adfb">DrawUnderlinedTextL</a> (const TDesC &aText)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_log_view.html#a629e54018a567f75798f93d4ff4fac19">DrawTextWithoutCarriageL</a> (const TDesC &aText)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_log_view.html#a162c28e1d721db301f9da7b1f5fab7cd">AddCarriageReturnL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_log_view.html#a227ff2a1e0b47ffafe7a303fd2c17307">LogEventBeginningL</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_log_view.html">CLogView</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_log_view.html#af727e5583e617cbb6ce9c2803921e387">NewL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_log_view.html">CLogView</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_log_view.html#a9aaa1e901a696306c9dd004da09d16e8">NewLC</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Log view that uses RichTextEditor. </p>
<p>Definition at line <a class="el" href="_s_m_s_example_log_view_8h_source.html#l00017">17</a> of file <a class="el" href="_s_m_s_example_log_view_8h_source.html">SMSExampleLogView.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a0d21a89655cc79416f64bb7449ceb9ea"></a><!-- doxytag: member="CLogView::~CLogView" ref="a0d21a89655cc79416f64bb7449ceb9ea" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CLogView::~CLogView </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destroy the object </p>
<p>Definition at line <a class="el" href="_s_m_s_example_log_view_8cpp_source.html#l00054">54</a> of file <a class="el" href="_s_m_s_example_log_view_8cpp_source.html">SMSExampleLogView.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="af727e5583e617cbb6ce9c2803921e387"></a><!-- doxytag: member="CLogView::NewL" ref="af727e5583e617cbb6ce9c2803921e387" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_log_view.html">CLogView</a> * CLogView::NewL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a <a class="el" href="class_c_log_view.html">CLogView</a> object </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to the created instance of <a class="el" href="class_c_log_view.html">CLogView</a> </dd></dl>
<p>Definition at line <a class="el" href="_s_m_s_example_log_view_8cpp_source.html#l00020">20</a> of file <a class="el" href="_s_m_s_example_log_view_8cpp_source.html">SMSExampleLogView.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a9aaa1e901a696306c9dd004da09d16e8"></a><!-- doxytag: member="CLogView::NewLC" ref="a9aaa1e901a696306c9dd004da09d16e8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_log_view.html">CLogView</a> * CLogView::NewLC </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a <a class="el" href="class_c_log_view.html">CLogView</a> object </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to the created instance of <a class="el" href="class_c_log_view.html">CLogView</a> </dd></dl>
<p>Definition at line <a class="el" href="_s_m_s_example_log_view_8cpp_source.html#l00032">32</a> of file <a class="el" href="_s_m_s_example_log_view_8cpp_source.html">SMSExampleLogView.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a3d3844728954242e0055eb2d59ee8561"></a><!-- doxytag: member="CLogView::Id" ref="a3d3844728954242e0055eb2d59ee8561" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TUid CLogView::Id </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Identity of this view to the system </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the ID of view </dd></dl>
<p>Definition at line <a class="el" href="_s_m_s_example_log_view_8cpp_source.html#l00080">80</a> of file <a class="el" href="_s_m_s_example_log_view_8cpp_source.html">SMSExampleLogView.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a044ac3a1fa166e828b8091882da7312a"></a><!-- doxytag: member="CLogView::HandleCommandL" ref="a044ac3a1fa166e828b8091882da7312a" args="(TInt aCommand)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CLogView::HandleCommandL </td>
<td>(</td>
<td class="paramtype">TInt </td>
<td class="paramname"> <em>aCommand</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Handle commands </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aCommand</em> </td><td>Command to be handled </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_s_m_s_example_log_view_8cpp_source.html#l00158">158</a> of file <a class="el" href="_s_m_s_example_log_view_8cpp_source.html">SMSExampleLogView.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aa72bb3e0cfa1cfb380b37a00870bc979"></a><!-- doxytag: member="CLogView::DoActivateL" ref="aa72bb3e0cfa1cfb380b37a00870bc979" args="(const TVwsViewId &aPrevViewId, TUid aCustomMessageId, const TDesC8 &aCustomMessage)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CLogView::DoActivateL </td>
<td>(</td>
<td class="paramtype">const TVwsViewId & </td>
<td class="paramname"> <em>aPrevViewId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TUid </td>
<td class="paramname"> <em>aCustomMessageId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const TDesC8 & </td>
<td class="paramname"> <em>aCustomMessage</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create the Container class object </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aPrevViewId</em> </td><td>The id of the previous view </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aCustomMessageId</em> </td><td>message identifier </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aCustomMessage</em> </td><td>custom message provided when view is changed </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_s_m_s_example_log_view_8cpp_source.html#l00093">93</a> of file <a class="el" href="_s_m_s_example_log_view_8cpp_source.html">SMSExampleLogView.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a3844e555ced5ef8c6c7a0005e5a205e9"></a><!-- doxytag: member="CLogView::DoDeactivate" ref="a3844e555ced5ef8c6c7a0005e5a205e9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CLogView::DoDeactivate </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Remove the container class instance from the App UI's stack </p>
<p>Definition at line <a class="el" href="_s_m_s_example_log_view_8cpp_source.html#l00107">107</a> of file <a class="el" href="_s_m_s_example_log_view_8cpp_source.html">SMSExampleLogView.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a3b8c699df18510fd84524a483b7945e5"></a><!-- doxytag: member="CLogView::DrawTextL" ref="a3b8c699df18510fd84524a483b7945e5" args="(const TDesC &aText)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CLogView::DrawTextL </td>
<td>(</td>
<td class="paramtype">const TDesC & </td>
<td class="paramname"> <em>aText</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Draw text into the log. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aText</em> </td><td>text to be drawn. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_s_m_s_example_log_view_8cpp_source.html#l00168">168</a> of file <a class="el" href="_s_m_s_example_log_view_8cpp_source.html">SMSExampleLogView.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a969ede3e5afcf6913877d139a248adfb"></a><!-- doxytag: member="CLogView::DrawUnderlinedTextL" ref="a969ede3e5afcf6913877d139a248adfb" args="(const TDesC &aText)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CLogView::DrawUnderlinedTextL </td>
<td>(</td>
<td class="paramtype">const TDesC & </td>
<td class="paramname"> <em>aText</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Draw underlined text into the log. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aText</em> </td><td>text to be drawn. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_s_m_s_example_log_view_8cpp_source.html#l00138">138</a> of file <a class="el" href="_s_m_s_example_log_view_8cpp_source.html">SMSExampleLogView.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a629e54018a567f75798f93d4ff4fac19"></a><!-- doxytag: member="CLogView::DrawTextWithoutCarriageL" ref="a629e54018a567f75798f93d4ff4fac19" args="(const TDesC &aText)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CLogView::DrawTextWithoutCarriageL </td>
<td>(</td>
<td class="paramtype">const TDesC & </td>
<td class="paramname"> <em>aText</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Draw text into the log. Do not add line break at the end of the text. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aText</em> </td><td>text to be drawn. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_s_m_s_example_log_view_8cpp_source.html#l00148">148</a> of file <a class="el" href="_s_m_s_example_log_view_8cpp_source.html">SMSExampleLogView.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a162c28e1d721db301f9da7b1f5fab7cd"></a><!-- doxytag: member="CLogView::AddCarriageReturnL" ref="a162c28e1d721db301f9da7b1f5fab7cd" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CLogView::AddCarriageReturnL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Line break. </p>
<p>Definition at line <a class="el" href="_s_m_s_example_log_view_8cpp_source.html#l00178">178</a> of file <a class="el" href="_s_m_s_example_log_view_8cpp_source.html">SMSExampleLogView.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a227ff2a1e0b47ffafe7a303fd2c17307"></a><!-- doxytag: member="CLogView::LogEventBeginningL" ref="a227ff2a1e0b47ffafe7a303fd2c17307" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CLogView::LogEventBeginningL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Begin a log event (prints a line and current time). </p>
<p>Definition at line <a class="el" href="_s_m_s_example_log_view_8cpp_source.html#l00123">123</a> of file <a class="el" href="_s_m_s_example_log_view_8cpp_source.html">SMSExampleLogView.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>