<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Colorer-take5 Library: LineRegion 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>LineRegion Class Reference<br>
<small>
[<a class="el" href="group__colorer__handlers.html">Handlers</a>]</small>
</h1><!-- doxytag: class="LineRegion" --><hr><a name="_details"></a><h2>Detailed Description</h2>
Defines region position properties.
<p>
These properties are created dynamically during text parsing and stores region's position on line and mapping of region into the <a class="el" href="classRegionDefine.html">RegionDefine</a> instance.
<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="d06f8db396c65fadc4a5bf939c08d3ce"></a><!-- doxytag: member="LineRegion::styled" ref="d06f8db396c65fadc4a5bf939c08d3ce" args="()" -->
const <a class="el" href="classStyledRegion.html">StyledRegion</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classLineRegion.html#d06f8db396c65fadc4a5bf939c08d3ce">styled</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Transforms this region's reference into styled region define and returns new pointer. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ae8c86856226a31ef495a0fddf4f4b5d"></a><!-- doxytag: member="LineRegion::texted" ref="ae8c86856226a31ef495a0fddf4f4b5d" args="()" -->
const <a class="el" href="classTextRegion.html">TextRegion</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classLineRegion.html#ae8c86856226a31ef495a0fddf4f4b5d">texted</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Transforms this region's reference into text region define and returns new pointer. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="90c652b148865bbe7f4ddf77b20ad10d"></a><!-- doxytag: member="LineRegion::operator=" ref="90c652b148865bbe7f4ddf77b20ad10d" args="(const LineRegion &lr)" -->
<a class="el" href="classLineRegion.html">LineRegion</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classLineRegion.html#90c652b148865bbe7f4ddf77b20ad10d">operator=</a> (const <a class="el" href="classLineRegion.html">LineRegion</a> &lr)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy operator. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="649afcaf44ed20a6e54a1bdb1c821e06"></a><!-- doxytag: member="LineRegion::LineRegion" ref="649afcaf44ed20a6e54a1bdb1c821e06" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classLineRegion.html#649afcaf44ed20a6e54a1bdb1c821e06">LineRegion</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clears all fields. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLineRegion.html#3981147007b10cdbabc1a5255f05c8f8">LineRegion</a> (const <a class="el" href="classLineRegion.html">LineRegion</a> &lr)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#3981147007b10cdbabc1a5255f05c8f8"></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="d3e076e3d34b6c6d2cef4f180ea12dfd"></a><!-- doxytag: member="LineRegion::region" ref="d3e076e3d34b6c6d2cef4f180ea12dfd" args="" -->
const <a class="el" href="classRegion.html">Region</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classLineRegion.html#d3e076e3d34b6c6d2cef4f180ea12dfd">region</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reference to HRC region, which identifies type of this range. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classRegionDefine.html">RegionDefine</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classLineRegion.html#cee04c82ac69efbd5e932d91821a6853">rdef</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reference to <a class="el" href="classRegionDefine.html">RegionDefine</a> class (it's subclass). <a href="#cee04c82ac69efbd5e932d91821a6853"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5b8f098a11e0f9241d5a8f164aa1c54a"></a><!-- doxytag: member="LineRegion::start" ref="5b8f098a11e0f9241d5a8f164aa1c54a" args="" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classLineRegion.html#5b8f098a11e0f9241d5a8f164aa1c54a">start</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start and End position of region in line. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bdb4df47328942b0ba0dafb5c5e0db7d"></a><!-- doxytag: member="LineRegion::end" ref="bdb4df47328942b0ba0dafb5c5e0db7d" args="" -->
int </td><td class="memItemRight" valign="bottom"><b>end</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8c115ae8224a817c3637a7e94543c1e4"></a><!-- doxytag: member="LineRegion::scheme" ref="8c115ae8224a817c3637a7e94543c1e4" args="" -->
const <a class="el" href="classScheme.html">Scheme</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classLineRegion.html#8c115ae8224a817c3637a7e94543c1e4">scheme</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reference to region's HRC scheme. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classLineRegion.html">LineRegion</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classLineRegion.html#fb003311e807359517a4413f22c6b079">next</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Previous and next links to ranged region in this line. <a href="#fb003311e807359517a4413f22c6b079"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="80bc47d857805aa3b2641ca3bc75dbc2"></a><!-- doxytag: member="LineRegion::prev" ref="80bc47d857805aa3b2641ca3bc75dbc2" args="" -->
<a class="el" href="classLineRegion.html">LineRegion</a> * </td><td class="memItemRight" valign="bottom"><b>prev</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classLineRegion.html#b4a84ee7b7f9ecbb97966c9b53e90e2d">special</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Special meaning marker. <a href="#b4a84ee7b7f9ecbb97966c9b53e90e2d"></a><br></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="3981147007b10cdbabc1a5255f05c8f8"></a><!-- doxytag: member="LineRegion::LineRegion" ref="3981147007b10cdbabc1a5255f05c8f8" args="(const LineRegion &lr)" --><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">LineRegion::LineRegion </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classLineRegion.html">LineRegion</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>lr</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>
Do not copies next and prev pointers. </td>
</tr>
</table>
<hr><h2>Field Documentation</h2>
<a class="anchor" name="cee04c82ac69efbd5e932d91821a6853"></a><!-- doxytag: member="LineRegion::rdef" ref="cee04c82ac69efbd5e932d91821a6853" 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"><a class="el" href="classRegionDefine.html">RegionDefine</a>* <a class="el" href="classLineRegion.html#cee04c82ac69efbd5e932d91821a6853">LineRegion::rdef</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Reference to <a class="el" href="classRegionDefine.html">RegionDefine</a> class (it's subclass).
<p>
This reference can contain concrete information about region extended properties. Can be null, if no region mapping were defined. </td>
</tr>
</table>
<a class="anchor" name="fb003311e807359517a4413f22c6b079"></a><!-- doxytag: member="LineRegion::next" ref="fb003311e807359517a4413f22c6b079" 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"><a class="el" href="classLineRegion.html">LineRegion</a>* <a class="el" href="classLineRegion.html#fb003311e807359517a4413f22c6b079">LineRegion::next</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Previous and next links to ranged region in this line.
<p>
First region of each line contains reference to it's last region in prev field. If <code>next</code> field is null, this is a last region in line. </td>
</tr>
</table>
<a class="anchor" name="b4a84ee7b7f9ecbb97966c9b53e90e2d"></a><!-- doxytag: member="LineRegion::special" ref="b4a84ee7b7f9ecbb97966c9b53e90e2d" 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">bool <a class="el" href="classLineRegion.html#b4a84ee7b7f9ecbb97966c9b53e90e2d">LineRegion::special</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Special meaning marker.
<p>
Generally this is used to inform application about paired regions, which are invisible during ordinary text drawing. </td>
</tr>
</table>
<br><br>
<center><small>
Colorer-take5 Library. Copyright © 1999-2006 Igor Russkih.<br>
Generated at Fri Nov 24 17:13:13 2006 by doxygen 1.4.6.
</small><center>
</BODY>
</HTML>
