Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_transparent_util.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: CTransparentUtil 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>CTransparentUtil Class Reference</h1><!-- doxytag: class="CTransparentUtil" -->
<p><a href="class_c_transparent_util-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_transparent_util.html#a5ac75e00750e9cd60fdf575bf3e400e4">CTransparentUtil</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_transparent_util.html#acc7952414bc448ede845d4ee1a6306ab">~CTransparentUtil</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_transparent_util.html#a913184d6e06574a7b843e17c021caad6">ConstructL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_transparent_util.html#a1b609f4a41da207c7a42610a42529752">ClearWindow</a> (RWsSession &aSession, RWindow &aWindow, CWindowGc *aGc, TRgb aColor)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_transparent_util.html#a253c26d5668451d3186cabe1744e364a">DrawWindow</a> (RWindow &aWindow, TRgb aColor1, TRgb aColor2, TRect aRect, 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_transparent_util.html#ab552b1972db4ef4c22a6733e8f48a959">DrawWindowRegion</a> (RWindow &aWindow, TRgb aColor1, TRgb aColor2, TRect aChopRect, TRect aRect, const TDesC &aText, const TPoint &aPoint)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_transparent_util.html#a8789a4bf5bdbbd7ee94c91ac91a5c04f">TransparencyVarianceL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_transparent_util.html#a5177889bde1510d758ef8e84b6416e5f">TransparentRegionL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TBool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_transparent_util.html#ae5c53597e173f8e554c7f4fbda81a154">DoChangeTransparencyL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a64bcaad66753044e3ff0b985fc4ef346"></a><!-- doxytag: member="CTransparentUtil::DoSetTransparentRegion" ref="a64bcaad66753044e3ff0b985fc4ef346" args="()" -->
TBool </td><td class="memItemRight" valign="bottom"><b>DoSetTransparentRegion</b> ()</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_transparent_util.html">CTransparentUtil</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_transparent_util.html#a9d8db23cebc357a94cfa21213db8a2ab">NewL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afeefad9502ff38288d9eb8c6453c8e4f"></a><!-- doxytag: member="CTransparentUtil::Flag" ref="afeefad9502ff38288d9eb8c6453c8e4f" args="()" -->
static TBool </td><td class="memItemRight" valign="bottom"><b>Flag</b> ()</td></tr>
<tr><td colspan="2"><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4135115c4d379b09d56f90cdd2f77d2a"></a><!-- doxytag: member="CTransparentUtil::iRegion" ref="a4135115c4d379b09d56f90cdd2f77d2a" args="" -->
TRegionFix< 2 > </td><td class="memItemRight" valign="bottom"><b>iRegion</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>View class </p>
<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" id="a5ac75e00750e9cd60fdf575bf3e400e4"></a><!-- doxytag: member="CTransparentUtil::CTransparentUtil" ref="a5ac75e00750e9cd60fdf575bf3e400e4" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor </p>
<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>
<a class="anchor" id="acc7952414bc448ede845d4ee1a6306ab"></a><!-- doxytag: member="CTransparentUtil::~CTransparentUtil" ref="acc7952414bc448ede845d4ee1a6306ab" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor </p>
<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>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a9d8db23cebc357a94cfa21213db8a2ab"></a><!-- doxytag: member="CTransparentUtil::NewL" ref="a9d8db23cebc357a94cfa21213db8a2ab" 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><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> </p>
<dl class="return"><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>
<a class="anchor" id="a913184d6e06574a7b843e17c021caad6"></a><!-- doxytag: member="CTransparentUtil::ConstructL" ref="a913184d6e06574a7b843e17c021caad6" 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></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>
<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>
<a class="anchor" id="a1b609f4a41da207c7a42610a42529752"></a><!-- doxytag: member="CTransparentUtil::ClearWindow" ref="a1b609f4a41da207c7a42610a42529752" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Clears the window to the selected colour </p>
<dl><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>
</dd>
</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>
<a class="anchor" id="a253c26d5668451d3186cabe1744e364a"></a><!-- doxytag: member="CTransparentUtil::DrawWindow" ref="a253c26d5668451d3186cabe1744e364a" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Clears the window to the selected colour and redraws the background window </p>
<dl><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>
</dd>
</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>
<a class="anchor" id="ab552b1972db4ef4c22a6733e8f48a959"></a><!-- doxytag: member="CTransparentUtil::DrawWindowRegion" ref="ab552b1972db4ef4c22a6733e8f48a959" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Clears the window to the selected colour and redraws the region of the foreground window </p>
<dl><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>
</dd>
</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>
<a class="anchor" id="a8789a4bf5bdbbd7ee94c91ac91a5c04f"></a><!-- doxytag: member="CTransparentUtil::TransparencyVarianceL" ref="a8789a4bf5bdbbd7ee94c91ac91a5c04f" 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></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>
<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>
<a class="anchor" id="a5177889bde1510d758ef8e84b6416e5f"></a><!-- doxytag: member="CTransparentUtil::TransparentRegionL" ref="a5177889bde1510d758ef8e84b6416e5f" 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></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>
<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>
<a class="anchor" id="ae5c53597e173f8e554c7f4fbda81a154"></a><!-- doxytag: member="CTransparentUtil::DoChangeTransparencyL" ref="ae5c53597e173f8e554c7f4fbda81a154" 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></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 </p>
<dl class="return"><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>
</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>