Sophie

Sophie

distrib > Mageia > 7 > x86_64 > by-pkgid > 9406df6f885a8f97005c2d7e241d165f > files > 96

colorer-take5-docs-0-0.beta5.14.mga7.x86_64.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Colorer-take5 Library: LineRegionsSupport 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>LineRegionsSupport Class Reference<br>
<small>
[<a class="el" href="group__colorer__handlers.html">Handlers</a>]</small>
</h1><!-- doxytag: class="LineRegionsSupport" --><!-- doxytag: inherits="RegionHandler" --><p>Inheritance diagram for LineRegionsSupport:
<p><center><img src="classLineRegionsSupport.png" usemap="#LineRegionsSupport_map" border="0" alt=""></center>
<map name="LineRegionsSupport_map">
<area href="classRegionHandler.html" alt="RegionHandler" shape="rect" coords="0,0,174,24">
<area href="classLineRegionsCompactSupport.html" alt="LineRegionsCompactSupport" shape="rect" coords="0,112,174,136">
</map>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="classRegion.html">Region</a> store implementation of <a class="el" href="classRegionHandler.html">RegionHandler</a>. 
<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="9fabec38e959dca7e30a7b7b24b6c111"></a><!-- doxytag: member="LineRegionsSupport::resize" ref="9fabec38e959dca7e30a7b7b24b6c111" args="(int lineCount)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLineRegionsSupport.html#9fabec38e959dca7e30a7b7b24b6c111">resize</a> (int lineCount)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Resizes structures to mantain regions for <code>lineCount</code> lines. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ac7d55fbd1cb85402c6b42068c413d6f"></a><!-- doxytag: member="LineRegionsSupport::size" ref="ac7d55fbd1cb85402c6b42068c413d6f" args="()" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLineRegionsSupport.html#ac7d55fbd1cb85402c6b42068c413d6f">size</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return current size of this line regions structure. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="db8cc3e5d12d06bd31241c0d64057156"></a><!-- doxytag: member="LineRegionsSupport::clear" ref="db8cc3e5d12d06bd31241c0d64057156" args="()" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLineRegionsSupport.html#db8cc3e5d12d06bd31241c0d64057156">clear</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Drops all internal structures. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLineRegionsSupport.html#20320372758b84ebc2ad928145073bf1">setFirstLine</a> (int first)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets start line position of line structures.  <a href="#20320372758b84ebc2ad928145073bf1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6823422ece02a98ff585283a21c30bf2"></a><!-- doxytag: member="LineRegionsSupport::getFirstLine" ref="6823422ece02a98ff585283a21c30bf2" args="()" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLineRegionsSupport.html#6823422ece02a98ff585283a21c30bf2">getFirstLine</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns first line position, installed in this line structures. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLineRegionsSupport.html#a9981522bd737827e02a8e322bcc7443">setBackground</a> (const <a class="el" href="classRegionDefine.html">RegionDefine</a> *back)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Background region define, which is used to fill transparent regions.  <a href="#a9981522bd737827e02a8e322bcc7443"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b997c4d92cc2d1f2a2bb4ea588c26e3d"></a><!-- doxytag: member="LineRegionsSupport::setSpecialRegion" ref="b997c4d92cc2d1f2a2bb4ea588c26e3d" args="(const Region *special)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLineRegionsSupport.html#b997c4d92cc2d1f2a2bb4ea588c26e3d">setSpecialRegion</a> (const <a class="el" href="classRegion.html">Region</a> *special)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Tells handler to mark with special field all Regions with specified ancestor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLineRegionsSupport.html#784b2ee79d93c5aac9d3084f109082d2">setRegionMapper</a> (const <a class="el" href="classRegionMapper.html">RegionMapper</a> *rds)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Choose the source of <a class="el" href="classRegionDefine.html">RegionDefine</a> definitions.  <a href="#784b2ee79d93c5aac9d3084f109082d2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classLineRegion.html">LineRegion</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLineRegionsSupport.html#3cd13e4e7a3840c44df2e62a76f75c91">getLineRegions</a> (int lno) const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns <a class="el" href="classLineRegion.html">LineRegion</a> object for <code>lno</code> line number.  <a href="#3cd13e4e7a3840c44df2e62a76f75c91"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="84c6aa65205edc8eb937c4b89895c895"></a><!-- doxytag: member="LineRegionsSupport::startParsing" ref="84c6aa65205edc8eb937c4b89895c895" args="(int lno)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLineRegionsSupport.html#84c6aa65205edc8eb937c4b89895c895">startParsing</a> (int lno)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="classRegionHandler.html">RegionHandler</a> implementation. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dc625ddb9d92e58e21b1e41f41300c8a"></a><!-- doxytag: member="LineRegionsSupport::clearLine" ref="dc625ddb9d92e58e21b1e41f41300c8a" args="(int lno, String *line)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>clearLine</b> (int lno, <a class="el" href="classString.html">String</a> *line)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ca42346bcbeab730fff931b6d24a1eb0"></a><!-- doxytag: member="LineRegionsSupport::addRegion" ref="ca42346bcbeab730fff931b6d24a1eb0" args="(int lno, String *line, int sx, int ex, const Region *region)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>addRegion</b> (int lno, <a class="el" href="classString.html">String</a> *line, int sx, int ex, const <a class="el" href="classRegion.html">Region</a> *region)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8d8be7d4c8c20a678744234df7cb113b"></a><!-- doxytag: member="LineRegionsSupport::enterScheme" ref="8d8be7d4c8c20a678744234df7cb113b" args="(int lno, String *line, int sx, int ex, const Region *region, const Scheme *scheme)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>enterScheme</b> (int lno, <a class="el" href="classString.html">String</a> *line, int sx, int ex, const <a class="el" href="classRegion.html">Region</a> *region, const <a class="el" href="classScheme.html">Scheme</a> *scheme)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b9d0b30832dd0a567b047454afde566b"></a><!-- doxytag: member="LineRegionsSupport::leaveScheme" ref="b9d0b30832dd0a567b047454afde566b" args="(int lno, String *line, int sx, int ex, const Region *region, const Scheme *scheme)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>leaveScheme</b> (int lno, <a class="el" href="classString.html">String</a> *line, int sx, int ex, const <a class="el" href="classRegion.html">Region</a> *region, const <a class="el" href="classScheme.html">Scheme</a> *scheme)</td></tr>

<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="85f70e3db6db9e7de2eb021ef7ab04bd"></a><!-- doxytag: member="LineRegionsSupport::addLineRegion" ref="85f70e3db6db9e7de2eb021ef7ab04bd" args="(int lno, LineRegion *lr)" -->
virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLineRegionsSupport.html#85f70e3db6db9e7de2eb021ef7ab04bd">addLineRegion</a> (int lno, <a class="el" href="classLineRegion.html">LineRegion</a> *lr)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Behaviour is redefined in derived classes. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="854d0fba921729353937ed9b632135bd"></a><!-- doxytag: member="LineRegionsSupport::getLineIndex" ref="854d0fba921729353937ed9b632135bd" args="(int lno) const " -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>getLineIndex</b> (int lno) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ba13dfd039e3a968085049b034662e8f"></a><!-- doxytag: member="LineRegionsSupport::checkLine" ref="ba13dfd039e3a968085049b034662e8f" args="(int lno) const " -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>checkLine</b> (int lno) const </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="6d3e7fc5bab61e8658fb04ae169a94ed"></a><!-- doxytag: member="LineRegionsSupport::lineRegions" ref="6d3e7fc5bab61e8658fb04ae169a94ed" args="" -->
<a class="el" href="classVector.html">Vector</a>&lt; <a class="el" href="classLineRegion.html">LineRegion</a> * &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>lineRegions</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1711109d064fbbe4294d619713166014"></a><!-- doxytag: member="LineRegionsSupport::schemeStack" ref="1711109d064fbbe4294d619713166014" args="" -->
<a class="el" href="classVector.html">Vector</a>&lt; <a class="el" href="classLineRegion.html">LineRegion</a> * &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>schemeStack</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5446a1b57359838eb8891068400cb111"></a><!-- doxytag: member="LineRegionsSupport::regionMapper" ref="5446a1b57359838eb8891068400cb111" args="" -->
const <a class="el" href="classRegionMapper.html">RegionMapper</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>regionMapper</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="02d55b140774ab1aed3ed65f4a82c254"></a><!-- doxytag: member="LineRegionsSupport::flowBackground" ref="02d55b140774ab1aed3ed65f4a82c254" args="" -->
<a class="el" href="classLineRegion.html">LineRegion</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>flowBackground</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a53aeb7b29a7757fc801301218dbe12f"></a><!-- doxytag: member="LineRegionsSupport::special" ref="a53aeb7b29a7757fc801301218dbe12f" args="" -->
const <a class="el" href="classRegion.html">Region</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>special</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b4b1b39c71e8affdb342b51e4bb47f00"></a><!-- doxytag: member="LineRegionsSupport::background" ref="b4b1b39c71e8affdb342b51e4bb47f00" args="" -->
<a class="el" href="classLineRegion.html">LineRegion</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>background</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3422f8a8488a8cc01c4c7d9caa8f1b29"></a><!-- doxytag: member="LineRegionsSupport::firstLineNo" ref="3422f8a8488a8cc01c4c7d9caa8f1b29" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>firstLineNo</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="01bbbae1c49ea8e3e4f8a8fc9af866c5"></a><!-- doxytag: member="LineRegionsSupport::lineCount" ref="01bbbae1c49ea8e3e4f8a8fc9af866c5" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>lineCount</b></td></tr>

</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="20320372758b84ebc2ad928145073bf1"></a><!-- doxytag: member="LineRegionsSupport::setFirstLine" ref="20320372758b84ebc2ad928145073bf1" args="(int first)" --><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 LineRegionsSupport::setFirstLine           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">int&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>first</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Sets start line position of line structures. 
<p>
This position tells, that first line structure refers not to first line of text, but to <code>first</code> parameter value.     </td>
  </tr>
</table>
<a class="anchor" name="a9981522bd737827e02a8e322bcc7443"></a><!-- doxytag: member="LineRegionsSupport::setBackground" ref="a9981522bd737827e02a8e322bcc7443" args="(const RegionDefine *back)" --><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 LineRegionsSupport::setBackground           </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>back</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Background region define, which is used to fill transparent regions. 
<p>
If background is <code>null</code>, then regions with transparent fields would leave these fields unfilled     </td>
  </tr>
</table>
<a class="anchor" name="784b2ee79d93c5aac9d3084f109082d2"></a><!-- doxytag: member="LineRegionsSupport::setRegionMapper" ref="784b2ee79d93c5aac9d3084f109082d2" args="(const RegionMapper *rds)" --><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 LineRegionsSupport::setRegionMapper           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="classRegionMapper.html">RegionMapper</a> *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>rds</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Choose the source of <a class="el" href="classRegionDefine.html">RegionDefine</a> definitions. 
<p>
This source returns information about mapping <a class="el" href="classRegion.html">Region</a> objects into <a class="el" href="classRegionDefine.html">RegionDefine</a> objects.     </td>
  </tr>
</table>
<a class="anchor" name="3cd13e4e7a3840c44df2e62a76f75c91"></a><!-- doxytag: member="LineRegionsSupport::getLineRegions" ref="3cd13e4e7a3840c44df2e62a76f75c91" args="(int lno) 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"><a class="el" href="classLineRegion.html">LineRegion</a> * LineRegionsSupport::getLineRegions           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">int&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>lno</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap> const</td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns <a class="el" href="classLineRegion.html">LineRegion</a> object for <code>lno</code> line number. 
<p>
This object is linked with all other stored <code><a class="el" href="classLineRegion.html">LineRegion</a></code> objects     </td>
  </tr>
</table>

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