<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Colorer-take5 Library: TextRegion 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>TextRegion Class Reference<br>
<small>
[<a class="el" href="group__colorer__handlers.html">Handlers</a>]</small>
</h1><!-- doxytag: class="TextRegion" --><!-- doxytag: inherits="RegionDefine" --><p>Inheritance diagram for TextRegion:
<p><center><img src="classTextRegion.png" usemap="#TextRegion_map" border="0" alt=""></center>
<map name="TextRegion_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 textual prefix/suffix.
<p>
These mappings are stored in HRD files.
<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="817278053bfe2ff0d6d6cba8ad7e41eb"></a><!-- doxytag: member="TextRegion::TextRegion" ref="817278053bfe2ff0d6d6cba8ad7e41eb" args="(const String *_stext, const String *_etext, const String *_sback, const String *_eback)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classTextRegion.html#817278053bfe2ff0d6d6cba8ad7e41eb">TextRegion</a> (const <a class="el" href="classString.html">String</a> *_stext, const <a class="el" href="classString.html">String</a> *_etext, const <a class="el" href="classString.html">String</a> *_sback, const <a class="el" href="classString.html">String</a> *_eback)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initial constructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTextRegion.html#9063ff04ebd7cf967b02291ee88a5df6">TextRegion</a> (const <a class="el" href="classTextRegion.html">TextRegion</a> &rd)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#9063ff04ebd7cf967b02291ee88a5df6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTextRegion.html#a1dd803085234a2c15a794cd5e4af31c">assignParent</a> (const <a class="el" href="classRegionDefine.html">RegionDefine</a> *_parent)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assigns region define with it's parent values. <a href="#a1dd803085234a2c15a794cd5e4af31c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTextRegion.html#52da73f620dfd99e0346e73b60b4b468">setValues</a> (const <a class="el" href="classRegionDefine.html">RegionDefine</a> *_rd)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Direct assign of all passed <code>rd</code> values. <a href="#52da73f620dfd99e0346e73b60b4b468"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dc3562b4f4f3e1d6a13541dd55694405"></a><!-- doxytag: member="TextRegion::clone" ref="dc3562b4f4f3e1d6a13541dd55694405" args="() const " -->
<a class="el" href="classRegionDefine.html">RegionDefine</a> * </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="classTextRegion.html">TextRegion</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTextRegion.html#cf3fd3343cf65b7dab2780098fb32be4">cast</a> (const <a class="el" href="classRegionDefine.html">RegionDefine</a> *rd)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Static method, used to cast <a class="el" href="classRegionDefine.html">RegionDefine</a> class into <a class="el" href="classTextRegion.html">TextRegion</a> class. <a href="#cf3fd3343cf65b7dab2780098fb32be4"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classString.html">String</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTextRegion.html#639609942b71a039a1500c87fc254e16">stext</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classText.html">Text</a> wrapping information. <a href="#639609942b71a039a1500c87fc254e16"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7ec629aa669223fd1d57efdbbccd8107"></a><!-- doxytag: member="TextRegion::etext" ref="7ec629aa669223fd1d57efdbbccd8107" args="" -->
const <a class="el" href="classString.html">String</a> * </td><td class="memItemRight" valign="bottom"><b>etext</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a9648072d63c2b2484e58937b6323889"></a><!-- doxytag: member="TextRegion::sback" ref="a9648072d63c2b2484e58937b6323889" args="" -->
const <a class="el" href="classString.html">String</a> * </td><td class="memItemRight" valign="bottom"><b>sback</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c4f27e0126c71fe5e0a9b193c0d6c81b"></a><!-- doxytag: member="TextRegion::eback" ref="c4f27e0126c71fe5e0a9b193c0d6c81b" args="" -->
const <a class="el" href="classString.html">String</a> * </td><td class="memItemRight" valign="bottom"><b>eback</b></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="9063ff04ebd7cf967b02291ee88a5df6"></a><!-- doxytag: member="TextRegion::TextRegion" ref="9063ff04ebd7cf967b02291ee88a5df6" args="(const TextRegion &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">TextRegion::TextRegion </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classTextRegion.html">TextRegion</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>rd</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</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="cf3fd3343cf65b7dab2780098fb32be4"></a><!-- doxytag: member="TextRegion::cast" ref="cf3fd3343cf65b7dab2780098fb32be4" 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="classTextRegion.html">TextRegion</a>* TextRegion::cast </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classRegionDefine.html">RegionDefine</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>rd</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline, static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Static method, used to cast <a class="el" href="classRegionDefine.html">RegionDefine</a> class into <a class="el" href="classTextRegion.html">TextRegion</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> </td><td>If casing is not available. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="a1dd803085234a2c15a794cd5e4af31c"></a><!-- doxytag: member="TextRegion::assignParent" ref="a1dd803085234a2c15a794cd5e4af31c" 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 TextRegion::assignParent </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classRegionDefine.html">RegionDefine</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>_parent</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Assigns region define with it's parent values.
<p>
All fields are to be replaced, if they are null-ed.
<p>
Implements <a class="el" href="classRegionDefine.html#6c7f32f70ccd04979262d657afae4dc2">RegionDefine</a>. </td>
</tr>
</table>
<a class="anchor" name="52da73f620dfd99e0346e73b60b4b468"></a><!-- doxytag: member="TextRegion::setValues" ref="52da73f620dfd99e0346e73b60b4b468" 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">void TextRegion::setValues </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classRegionDefine.html">RegionDefine</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>_rd</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Direct assign of all passed <code>rd</code> values.
<p>
Do not assign region reference.
<p>
Implements <a class="el" href="classRegionDefine.html#1fd164f822b7a3aace27ce11eaf033e7">RegionDefine</a>. </td>
</tr>
</table>
<hr><h2>Field Documentation</h2>
<a class="anchor" name="639609942b71a039a1500c87fc254e16"></a><!-- doxytag: member="TextRegion::stext" ref="639609942b71a039a1500c87fc254e16" args="" --><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">const <a class="el" href="classString.html">String</a>* <a class="el" href="classTextRegion.html#639609942b71a039a1500c87fc254e16">TextRegion::stext</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
<a class="el" href="classText.html">Text</a> wrapping information.
<p>
Pointers are managed externally. </td>
</tr>
</table>
<br><br>
<center><small>
Colorer-take5 Library. Copyright © 1999-2006 Igor Russkih.<br>
Generated at Fri Nov 24 17:13:14 2006 by doxygen 1.4.6.
</small><center>
</BODY>
</HTML>
