Sophie

Sophie

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

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: RegionDefine 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>RegionDefine Class Reference<br>
<small>
[<a class="el" href="group__colorer__handlers.html">Handlers</a>]</small>
</h1><!-- doxytag: class="RegionDefine" --><p>Inheritance diagram for RegionDefine:
<p><center><img src="classRegionDefine.png" usemap="#RegionDefine_map" border="0" alt=""></center>
<map name="RegionDefine_map">
<area href="classStyledRegion.html" alt="StyledRegion" shape="rect" coords="0,56,88,80">
<area href="classTextRegion.html" alt="TextRegion" shape="rect" coords="98,56,186,80">
</map>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Object contains information about region mapping into real colors or other properties. 
<p>
This class represents abstract mapping information and declares required methods to be implemented in it's subclasses. 
<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">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRegionDefine.html#6c7f32f70ccd04979262d657afae4dc2">assignParent</a> (const <a class="el" href="classRegionDefine.html">RegionDefine</a> *parent)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Completes region define values with it's parent values.  <a href="#6c7f32f70ccd04979262d657afae4dc2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRegionDefine.html#1fd164f822b7a3aace27ce11eaf033e7">setValues</a> (const <a class="el" href="classRegionDefine.html">RegionDefine</a> *rd)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Direct assign of all passed <code>rd</code> values.  <a href="#1fd164f822b7a3aace27ce11eaf033e7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classRegionDefine.html">RegionDefine</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRegionDefine.html#784e9a4d9e8e6b120336adedd929474e">operator=</a> (const <a class="el" href="classRegionDefine.html">RegionDefine</a> &amp;rd)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Assign operator.  <a href="#784e9a4d9e8e6b120336adedd929474e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classRegionDefine.html">RegionDefine</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRegionDefine.html#06d6e97428f5a9679ad963dd53a7a1fe">clone</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Clones current region and creates it's duplicate.  <a href="#06d6e97428f5a9679ad963dd53a7a1fe"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c1ae47de09a191ac0371f44c7934fe56"></a><!-- doxytag: member="RegionDefine::~RegionDefine" ref="c1ae47de09a191ac0371f44c7934fe56" args="()" -->
virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRegionDefine.html#c1ae47de09a191ac0371f44c7934fe56">~RegionDefine</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default Destructor. <br></td></tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="6c7f32f70ccd04979262d657afae4dc2"></a><!-- doxytag: member="RegionDefine::assignParent" ref="6c7f32f70ccd04979262d657afae4dc2" args="(const RegionDefine *parent)=0" --><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">virtual void RegionDefine::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> [pure virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Completes region define values with it's parent values. 
<p>
If region define has some incomplete information (fe some transparent fields), this methods completes them with passed parent's values. 
<p>
Implemented in <a class="el" href="classStyledRegion.html#267ece6b8bc1f98a8f35d95f969ab605">StyledRegion</a>, and <a class="el" href="classTextRegion.html#a1dd803085234a2c15a794cd5e4af31c">TextRegion</a>.    </td>
  </tr>
</table>
<a class="anchor" name="1fd164f822b7a3aace27ce11eaf033e7"></a><!-- doxytag: member="RegionDefine::setValues" ref="1fd164f822b7a3aace27ce11eaf033e7" args="(const RegionDefine *rd)=0" --><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">virtual void RegionDefine::setValues           </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> [pure virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Direct assign of all passed <code>rd</code> values. 
<p>
Copies all information from passed definition into this region. 
<p>
Implemented in <a class="el" href="classTextRegion.html#52da73f620dfd99e0346e73b60b4b468">TextRegion</a>.    </td>
  </tr>
</table>
<a class="anchor" name="784e9a4d9e8e6b120336adedd929474e"></a><!-- doxytag: member="RegionDefine::operator=" ref="784e9a4d9e8e6b120336adedd929474e" args="(const RegionDefine &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">virtual <a class="el" href="classRegionDefine.html">RegionDefine</a>&amp; RegionDefine::operator=           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="classRegionDefine.html">RegionDefine</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, virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Assign operator. 
<p>
Clones all values. Works as setValues method.     </td>
  </tr>
</table>
<a class="anchor" name="06d6e97428f5a9679ad963dd53a7a1fe"></a><!-- doxytag: member="RegionDefine::clone" ref="06d6e97428f5a9679ad963dd53a7a1fe" args="() const =0" --><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">virtual <a class="el" href="classRegionDefine.html">RegionDefine</a>* RegionDefine::clone           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap> const<code> [pure virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Clones current region and creates it's duplicate. 
<p>
To be implemented in subclasses.     </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>