Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_transparent_util.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: CTransparentUtil 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>CTransparentUtil Class Reference</h1><!-- doxytag: class="CTransparentUtil" -->
<p>
<a href="class_c_transparent_util-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_transparent_util.html#5ac75e00750e9cd60fdf575bf3e400e4">CTransparentUtil</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_transparent_util.html#cc7952414bc448ede845d4ee1a6306ab">~CTransparentUtil</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_transparent_util.html#913184d6e06574a7b843e17c021caad6">ConstructL</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_transparent_util.html#1b609f4a41da207c7a42610a42529752">ClearWindow</a> (RWsSession &aSession, RWindow &aWindow, CWindowGc *aGc, TRgb aColor)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_transparent_util.html#253c26d5668451d3186cabe1744e364a">DrawWindow</a> (RWindow &aWindow, TRgb aColor1, TRgb aColor2, TRect aRect, const TDesC &aText)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_transparent_util.html#b552b1972db4ef4c22a6733e8f48a959">DrawWindowRegion</a> (RWindow &aWindow, TRgb aColor1, TRgb aColor2, TRect aChopRect, TRect aRect, const TDesC &aText, const TPoint &aPoint)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_transparent_util.html#8789a4bf5bdbbd7ee94c91ac91a5c04f">TransparencyVarianceL</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_transparent_util.html#5177889bde1510d758ef8e84b6416e5f">TransparentRegionL</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">TBool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_transparent_util.html#e5c53597e173f8e554c7f4fbda81a154">DoChangeTransparencyL</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="64bcaad66753044e3ff0b985fc4ef346"></a><!-- doxytag: member="CTransparentUtil::DoSetTransparentRegion" ref="64bcaad66753044e3ff0b985fc4ef346" args="()" -->
TBool </td><td class="memItemRight" valign="bottom"><b>DoSetTransparentRegion</b> ()</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_transparent_util.html">CTransparentUtil</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_transparent_util.html#9d8db23cebc357a94cfa21213db8a2ab">NewL</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="feefad9502ff38288d9eb8c6453c8e4f"></a><!-- doxytag: member="CTransparentUtil::Flag" ref="feefad9502ff38288d9eb8c6453c8e4f" args="()" -->
static TBool </td><td class="memItemRight" valign="bottom"><b>Flag</b> ()</td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4135115c4d379b09d56f90cdd2f77d2a"></a><!-- doxytag: member="CTransparentUtil::iRegion" ref="4135115c4d379b09d56f90cdd2f77d2a" args="" -->
TRegionFix< 2 > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_transparent_util.html#4135115c4d379b09d56f90cdd2f77d2a">iRegion</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
View class
<p>Definition at line <a class="el" href="transparent_8h-source.html#l00064">64</a> of file <a class="el" href="transparent_8h-source.html">transparent.h</a>.</p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="5ac75e00750e9cd60fdf575bf3e400e4"></a><!-- doxytag: member="CTransparentUtil::CTransparentUtil" ref="5ac75e00750e9cd60fdf575bf3e400e4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CTransparentUtil::CTransparentUtil </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor
<p>Definition at line <a class="el" href="transparent__util_8cpp-source.html#l00045">45</a> of file <a class="el" href="transparent__util_8cpp-source.html">transparent_util.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="cc7952414bc448ede845d4ee1a6306ab"></a><!-- doxytag: member="CTransparentUtil::~CTransparentUtil" ref="cc7952414bc448ede845d4ee1a6306ab" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CTransparentUtil::~CTransparentUtil </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor
<p>Definition at line <a class="el" href="transparent__util_8cpp-source.html#l00065">65</a> of file <a class="el" href="transparent__util_8cpp-source.html">transparent_util.cpp</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="9d8db23cebc357a94cfa21213db8a2ab"></a><!-- doxytag: member="CTransparentUtil::NewL" ref="9d8db23cebc357a94cfa21213db8a2ab" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_transparent_util.html">CTransparentUtil</a> * CTransparentUtil::NewL </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Creates an object of type <a class="el" href="class_c_transparent_util.html">CTransparentUtil</a> <dl class="return" compact><dt><b>Returns:</b></dt><dd>New <a class="el" href="class_c_transparent_util.html">CTransparentUtil</a> object </dd></dl>
<p>Definition at line <a class="el" href="transparent__util_8cpp-source.html#l00053">53</a> of file <a class="el" href="transparent__util_8cpp-source.html">transparent_util.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="913184d6e06574a7b843e17c021caad6"></a><!-- doxytag: member="CTransparentUtil::ConstructL" ref="913184d6e06574a7b843e17c021caad6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CTransparentUtil::ConstructL </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Initializations for window server session, screen device, graphics context window group, background window, foreground window, event handler, blank window and active object for delay. KErrNoMemory System-wide error codes.
<p>Definition at line <a class="el" href="transparent__util_8cpp-source.html#l00093">93</a> of file <a class="el" href="transparent__util_8cpp-source.html">transparent_util.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="1b609f4a41da207c7a42610a42529752"></a><!-- doxytag: member="CTransparentUtil::ClearWindow" ref="1b609f4a41da207c7a42610a42529752" args="(RWsSession &aSession, RWindow &aWindow, CWindowGc *aGc, TRgb aColor)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CTransparentUtil::ClearWindow </td>
<td>(</td>
<td class="paramtype">RWsSession & </td>
<td class="paramname"> <em>aSession</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">RWindow & </td>
<td class="paramname"> <em>aWindow</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">CWindowGc * </td>
<td class="paramname"> <em>aGc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TRgb </td>
<td class="paramname"> <em>aColor</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Clears the window to the selected colour <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aSession</em> </td><td>The window server session </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aWindow</em> </td><td>The handle to the window </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aGc</em> </td><td>Graphics context of the window </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aColor</em> </td><td>Colour to be used when the window is cleared </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="transparent__util_8cpp-source.html#l00217">217</a> of file <a class="el" href="transparent__util_8cpp-source.html">transparent_util.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="253c26d5668451d3186cabe1744e364a"></a><!-- doxytag: member="CTransparentUtil::DrawWindow" ref="253c26d5668451d3186cabe1744e364a" args="(RWindow &aWindow, TRgb aColor1, TRgb aColor2, TRect aRect, const TDesC &aText)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CTransparentUtil::DrawWindow </td>
<td>(</td>
<td class="paramtype">RWindow & </td>
<td class="paramname"> <em>aWindow</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TRgb </td>
<td class="paramname"> <em>aColor1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TRgb </td>
<td class="paramname"> <em>aColor2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TRect </td>
<td class="paramname"> <em>aRect</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const TDesC & </td>
<td class="paramname"> <em>aText</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Clears the window to the selected colour and redraws the background window <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aWindow</em> </td><td>The handle to the window </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aColor1</em> </td><td>Colour to be used when the window is cleared </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aColor2</em> </td><td>Colour in which the window must be drawn </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aRect</em> </td><td>Area to be drawn </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="transparent__util_8cpp-source.html#l00171">171</a> of file <a class="el" href="transparent__util_8cpp-source.html">transparent_util.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="b552b1972db4ef4c22a6733e8f48a959"></a><!-- doxytag: member="CTransparentUtil::DrawWindowRegion" ref="b552b1972db4ef4c22a6733e8f48a959" args="(RWindow &aWindow, TRgb aColor1, TRgb aColor2, TRect aChopRect, TRect aRect, const TDesC &aText, const TPoint &aPoint)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CTransparentUtil::DrawWindowRegion </td>
<td>(</td>
<td class="paramtype">RWindow & </td>
<td class="paramname"> <em>aWindow</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TRgb </td>
<td class="paramname"> <em>aColor1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TRgb </td>
<td class="paramname"> <em>aColor2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TRect </td>
<td class="paramname"> <em>aChopRect</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TRect </td>
<td class="paramname"> <em>aRect</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const TDesC & </td>
<td class="paramname"> <em>aText</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const TPoint & </td>
<td class="paramname"> <em>aPoint</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Clears the window to the selected colour and redraws the region of the foreground window <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aWindow</em> </td><td>The handle to the window </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aColor1</em> </td><td>Colour to be used when the window is cleared </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aColor2</em> </td><td>Colour in which the window must be drawn </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aChopRect</em> </td><td>Region of the foreground window to be drawn. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aRect</em> </td><td>Area to be drawn </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aText</em> </td><td>Text to be drawn. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aPoint</em> </td><td>Point at which text should be drawn. </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="transparent__util_8cpp-source.html#l00314">314</a> of file <a class="el" href="transparent__util_8cpp-source.html">transparent_util.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="8789a4bf5bdbbd7ee94c91ac91a5c04f"></a><!-- doxytag: member="CTransparentUtil::TransparencyVarianceL" ref="8789a4bf5bdbbd7ee94c91ac91a5c04f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CTransparentUtil::TransparencyVarianceL </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Creates an opaque background window and draws a circle onto it. Creates a transparent foreground window and draws an ellipse onto it. Waits for button press events and starts the active scheduler upon the corresponding button being pressed. System-wide error codes.
<p>Definition at line <a class="el" href="transparent__util_8cpp-source.html#l00197">197</a> of file <a class="el" href="transparent__util_8cpp-source.html">transparent_util.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="5177889bde1510d758ef8e84b6416e5f"></a><!-- doxytag: member="CTransparentUtil::TransparentRegionL" ref="5177889bde1510d758ef8e84b6416e5f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CTransparentUtil::TransparentRegionL </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Creates an transparent foreground window with some region of it made opaque. Waits for button press events and starts the active scheduler upon the corresponding button being pressed. System-wide error codes.
<p>Definition at line <a class="el" href="transparent__util_8cpp-source.html#l00263">263</a> of file <a class="el" href="transparent__util_8cpp-source.html">transparent_util.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="e5c53597e173f8e554c7f4fbda81a154"></a><!-- doxytag: member="CTransparentUtil::DoChangeTransparencyL" ref="e5c53597e173f8e554c7f4fbda81a154" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TBool CTransparentUtil::DoChangeTransparencyL </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Varies the alpha value of the window up to 255 i.e. until the window turns opaque <dl class="return" compact><dt><b>Returns:</b></dt><dd>ETrue if the alpha value is less than its maximum limit otherwise return EFalse. </dd></dl>
<p>Definition at line <a class="el" href="transparent__util_8cpp-source.html#l00234">234</a> of file <a class="el" href="transparent__util_8cpp-source.html">transparent_util.cpp</a>.</p>
</div>
</div><p>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:33:07 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>