Sophie

Sophie

distrib > Mandriva > 2010.0 > x86_64 > by-pkgid > 9ac0f970b86472ed1e748202d2848da8 > files > 147

colorer-take5-docs-0-0.beta5.4mdv2010.0.x86_64.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Colorer-take5 Library: StyledRegion Class Reference</title>
<link href="../styles/styles.css" rel="stylesheet" type="text/css">
<link href="../styles/doc.css" rel="stylesheet" type="text/css">
<link rel="icon" href="../images/logo-small-api.png"/>
</head>
<body>
<div align='center'>
<a href="../index.html">Home</a> |
<a href="modules.html">Modules</a> |
<a href="hierarchy.html">Class Hierarchy</a> |
<a href="classes.html">Alphabetical List</a> |
<a href="annotated.html">Compound List</a> |
<a href="pages.html">Related Pages</a>
</div>
<!-- Generated by Doxygen 1.4.6 -->
<h1>StyledRegion Class Reference<br>
<small>
[<a class="el" href="group__colorer__handlers.html">Handlers</a>]</small>
</h1><!-- doxytag: class="StyledRegion" --><!-- doxytag: inherits="RegionDefine" --><p>Inheritance diagram for StyledRegion:
<p><center><img src="classStyledRegion.png" usemap="#StyledRegion_map" border="0" alt=""></center>
<map name="StyledRegion_map">
<area href="classRegionDefine.html" alt="RegionDefine" shape="rect" coords="0,0,88,24">
</map>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Contains information about region mapping into real colors. 
<p>
These mappings are stored in HRD files and processed by <a class="el" href="classStyledHRDMapper.html">StyledHRDMapper</a> class. 
<p>
<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"><a class="anchor" name="fa9c4956e1b5c709cfefd6fbad2949bd"></a><!-- doxytag: member="StyledRegion::StyledRegion" ref="fa9c4956e1b5c709cfefd6fbad2949bd" args="(bool _bfore, bool _bback, unsigned int _fore, unsigned int _back, unsigned int _style)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStyledRegion.html#fa9c4956e1b5c709cfefd6fbad2949bd">StyledRegion</a> (bool _bfore, bool _bback, unsigned int _fore, unsigned int _back, unsigned int _style)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Common constructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ef98f6bf7b84ce4f156ef1a64e3e5db1"></a><!-- doxytag: member="StyledRegion::StyledRegion" ref="ef98f6bf7b84ce4f156ef1a64e3e5db1" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStyledRegion.html#ef98f6bf7b84ce4f156ef1a64e3e5db1">StyledRegion</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Empty constructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStyledRegion.html#9763fcd32c2f0ba3e8dbfe0d0ebd3ac7">StyledRegion</a> (const <a class="el" href="classStyledRegion.html">StyledRegion</a> &amp;rd)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Copy constructor.  <a href="#9763fcd32c2f0ba3e8dbfe0d0ebd3ac7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStyledRegion.html#267ece6b8bc1f98a8f35d95f969ab605">assignParent</a> (const <a class="el" href="classRegionDefine.html">RegionDefine</a> *_parent)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Completes region define with it's parent values.  <a href="#267ece6b8bc1f98a8f35d95f969ab605"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6868348e3c8eaff79779ff990865b369"></a><!-- doxytag: member="StyledRegion::setValues" ref="6868348e3c8eaff79779ff990865b369" args="(const RegionDefine *_rd)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>setValues</b> (const <a class="el" href="classRegionDefine.html">RegionDefine</a> *_rd)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6a918127bfd39a06f0ba9a5a41e6d2b3"></a><!-- doxytag: member="StyledRegion::clone" ref="6a918127bfd39a06f0ba9a5a41e6d2b3" args="() const " -->
<a class="el" href="classRegionDefine.html">RegionDefine</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>clone</b> () const </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 const <a class="el" href="classStyledRegion.html">StyledRegion</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStyledRegion.html#9105b2e92a5983c8ec0d2aa80d5c71f3">cast</a> (const <a class="el" href="classRegionDefine.html">RegionDefine</a> *rd)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Static method, used to cast <a class="el" href="classRegionDefine.html">RegionDefine</a> class into <a class="el" href="classStyledRegion.html">StyledRegion</a> class.  <a href="#9105b2e92a5983c8ec0d2aa80d5c71f3"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2536e4897fd14fe391b7ce67234368cb"></a><!-- doxytag: member="StyledRegion::bfore" ref="2536e4897fd14fe391b7ce67234368cb" args="" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStyledRegion.html#2536e4897fd14fe391b7ce67234368cb">bfore</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Is foreground value assigned? <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b4a42b7e38e5940356f9a4c436cb6bee"></a><!-- doxytag: member="StyledRegion::bback" ref="b4a42b7e38e5940356f9a4c436cb6bee" args="" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStyledRegion.html#b4a42b7e38e5940356f9a4c436cb6bee">bback</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Is background value assigned? <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cfdde44a3f68b3063c8c2312879c5b18"></a><!-- doxytag: member="StyledRegion::fore" ref="cfdde44a3f68b3063c8c2312879c5b18" args="" -->
unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStyledRegion.html#cfdde44a3f68b3063c8c2312879c5b18">fore</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Foreground color of region. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="859fac5c6583e9f535dbfa0ea83eced8"></a><!-- doxytag: member="StyledRegion::back" ref="859fac5c6583e9f535dbfa0ea83eced8" args="" -->
unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStyledRegion.html#859fac5c6583e9f535dbfa0ea83eced8">back</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Background color of region. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f4fd9e8dfef2f756e6d0567275d78f08"></a><!-- doxytag: member="StyledRegion::style" ref="f4fd9e8dfef2f756e6d0567275d78f08" args="" -->
unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStyledRegion.html#f4fd9e8dfef2f756e6d0567275d78f08">style</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Bit mask of region's style (bold, italic, underline). <br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a7c3162ff7ecd229df4cb5efbd896a95"></a><!-- doxytag: member="StyledRegion::RD_BOLD" ref="a7c3162ff7ecd229df4cb5efbd896a95" args="" -->
static const int&nbsp;</td><td class="memItemRight" valign="bottom"><b>RD_BOLD</b> = 1</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6574d40c1a0804d1d6bcb319a31b3743"></a><!-- doxytag: member="StyledRegion::RD_ITALIC" ref="6574d40c1a0804d1d6bcb319a31b3743" args="" -->
static const int&nbsp;</td><td class="memItemRight" valign="bottom"><b>RD_ITALIC</b> = 2</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a72fd9bd1005346ce159ba451e029ecd"></a><!-- doxytag: member="StyledRegion::RD_UNDERLINE" ref="a72fd9bd1005346ce159ba451e029ecd" args="" -->
static const int&nbsp;</td><td class="memItemRight" valign="bottom"><b>RD_UNDERLINE</b> = 4</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6488bea627dd04bd0a192707297c8020"></a><!-- doxytag: member="StyledRegion::RD_STRIKEOUT" ref="6488bea627dd04bd0a192707297c8020" args="" -->
static const int&nbsp;</td><td class="memItemRight" valign="bottom"><b>RD_STRIKEOUT</b> = 8</td></tr>

</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="9763fcd32c2f0ba3e8dbfe0d0ebd3ac7"></a><!-- doxytag: member="StyledRegion::StyledRegion" ref="9763fcd32c2f0ba3e8dbfe0d0ebd3ac7" args="(const StyledRegion &amp;rd)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">StyledRegion::StyledRegion           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="classStyledRegion.html">StyledRegion</a> &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>rd</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [inline]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Copy constructor. 
<p>
Clones all values including region reference.     </td>
  </tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="9105b2e92a5983c8ec0d2aa80d5c71f3"></a><!-- doxytag: member="StyledRegion::cast" ref="9105b2e92a5983c8ec0d2aa80d5c71f3" args="(const RegionDefine *rd)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">static const <a class="el" href="classStyledRegion.html">StyledRegion</a>* StyledRegion::cast           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="classRegionDefine.html">RegionDefine</a> *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>rd</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [inline, static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Static method, used to cast <a class="el" href="classRegionDefine.html">RegionDefine</a> class into <a class="el" href="classStyledRegion.html">StyledRegion</a> class. 
<p>
<dl compact><dt><b>Exceptions:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classException.html">Exception</a></em>&nbsp;</td><td>If casing is not available. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="267ece6b8bc1f98a8f35d95f969ab605"></a><!-- doxytag: member="StyledRegion::assignParent" ref="267ece6b8bc1f98a8f35d95f969ab605" args="(const RegionDefine *_parent)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">void StyledRegion::assignParent           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="classRegionDefine.html">RegionDefine</a> *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>_parent</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [inline, virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Completes region define with it's parent values. 
<p>
The values only replaced, are these, which are empty in this region define. Style is replaced using OR operation. 
<p>
Implements <a class="el" href="classRegionDefine.html#6c7f32f70ccd04979262d657afae4dc2">RegionDefine</a>.    </td>
  </tr>
</table>

<br><br>
<center><small>
Colorer-take5 Library. Copyright &copy; 1999-2006 Igor Russkih.<br>
Generated at Fri Nov 24 17:13:14 2006 by doxygen 1.4.6.
</small><center>
    </BODY>
  </HTML>