<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Colorer-take5 Library: Region 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>Region Class Reference<br>
<small>
[<a class="el" href="group__colorer.html">Colorer interfaces</a>]</small>
</h1><!-- doxytag: class="Region" --><hr><a name="_details"></a><h2>Detailed Description</h2>
HRC <a class="el" href="classRegion.html">Region</a> implementation.
<p>
Contains information about HRC <a class="el" href="classRegion.html">Region</a> and it attributes: <ul>
<li>
name </li>
<li>
description </li>
<li>
parent </li>
</ul>
<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="912ab76537668ce81c2659327ee79b01"></a><!-- doxytag: member="Region::getName" ref="912ab76537668ce81c2659327ee79b01" args="() const " -->
virtual const <a class="el" href="classString.html">String</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classRegion.html#912ab76537668ce81c2659327ee79b01">getName</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Full Qualified region name (<code>def:<a class="el" href="classText.html">Text</a></code> for example). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="aaa352e3388ab966e1b4a7614dcbfd00"></a><!-- doxytag: member="Region::getDescription" ref="aaa352e3388ab966e1b4a7614dcbfd00" args="() const " -->
virtual const <a class="el" href="classString.html">String</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classRegion.html#aaa352e3388ab966e1b4a7614dcbfd00">getDescription</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classRegion.html">Region</a> description. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4e3a1977c855a357c2a3e3d524862af9"></a><!-- doxytag: member="Region::getParent" ref="4e3a1977c855a357c2a3e3d524862af9" args="() const " -->
virtual const <a class="el" href="classRegion.html">Region</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classRegion.html#4e3a1977c855a357c2a3e3d524862af9">getParent</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Direct region ancestor (parent). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1b0f3b6d2f52aff108385d590367e51d"></a><!-- doxytag: member="Region::getID" ref="1b0f3b6d2f52aff108385d590367e51d" args="() const " -->
virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classRegion.html#1b0f3b6d2f52aff108385d590367e51d">getID</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Quick access region id (incrementable). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classRegion.html#0f16b273787dd857d448f74c9c67a5e8">hasParent</a> (const <a class="el" href="classRegion.html">Region</a> *region) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks if region has the specified parent in all of it's ancestors. <a href="#0f16b273787dd857d448f74c9c67a5e8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRegion.html#f2bc69c0fa91f3699786cdf8c2cd66bf">Region</a> (const <a class="el" href="classString.html">String</a> *_name, const <a class="el" href="classString.html">String</a> *_description, const <a class="el" href="classRegion.html">Region</a> *_parent, int _id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Basic constructor. <a href="#f2bc69c0fa91f3699786cdf8c2cd66bf"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="752c0ae696223342bc6368b0ecb75b66"></a><!-- doxytag: member="Region::name" ref="752c0ae696223342bc6368b0ecb75b66" args="" -->
<a class="el" href="classString.html">String</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classRegion.html#752c0ae696223342bc6368b0ecb75b66">name</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Internal members. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="453036f38baec78849c2a2ab4e96d63c"></a><!-- doxytag: member="Region::description" ref="453036f38baec78849c2a2ab4e96d63c" args="" -->
<a class="el" href="classString.html">String</a> * </td><td class="memItemRight" valign="bottom"><b>description</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="12ce607c4a2993e4f9fabbd68fc7b35a"></a><!-- doxytag: member="Region::parent" ref="12ce607c4a2993e4f9fabbd68fc7b35a" args="" -->
const <a class="el" href="classRegion.html">Region</a> * </td><td class="memItemRight" valign="bottom"><b>parent</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c67acf41588cce0c17150cf5d3dd435d"></a><!-- doxytag: member="Region::id" ref="c67acf41588cce0c17150cf5d3dd435d" args="" -->
int </td><td class="memItemRight" valign="bottom"><b>id</b></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="f2bc69c0fa91f3699786cdf8c2cd66bf"></a><!-- doxytag: member="Region::Region" ref="f2bc69c0fa91f3699786cdf8c2cd66bf" args="(const String *_name, const String *_description, const Region *_parent, int _id)" --><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">Region::Region </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classString.html">String</a> * </td>
<td class="mdname" nowrap> <em>_name</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const <a class="el" href="classString.html">String</a> * </td>
<td class="mdname" nowrap> <em>_description</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const <a class="el" href="classRegion.html">Region</a> * </td>
<td class="mdname" nowrap> <em>_parent</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>_id</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Basic constructor.
<p>
Used only by <a class="el" href="classHRCParser.html">HRCParser</a>. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="0f16b273787dd857d448f74c9c67a5e8"></a><!-- doxytag: member="Region::hasParent" ref="0f16b273787dd857d448f74c9c67a5e8" args="(const Region *region) const " --><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">bool Region::hasParent </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classRegion.html">Region</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>region</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Checks if region has the specified parent in all of it's ancestors.
<p>
This method is useful to check if region has specified parent, and use this information, as region type specification. For example, <code>def:<a class="el" href="classComment.html">Comment</a></code> has <code>def:Syntax</code> parent, so, some syntax checking can be made with it's content. </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>
