Sophie

Sophie

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

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: RegionMapperImpl 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>RegionMapperImpl Class Reference<br>
<small>
[<a class="el" href="group__colorer__handlers.html">Handlers</a>]</small>
</h1><!-- doxytag: class="RegionMapperImpl" --><!-- doxytag: inherits="RegionMapper" --><p>Inheritance diagram for RegionMapperImpl:
<p><center><img src="classRegionMapperImpl.png" usemap="#RegionMapperImpl_map" border="0" alt=""></center>
<map name="RegionMapperImpl_map">
<area href="classRegionMapper.html" alt="RegionMapper" shape="rect" coords="63,0,180,24">
<area href="classStyledHRDMapper.html" alt="StyledHRDMapper" shape="rect" coords="0,112,117,136">
<area href="classTextHRDMapper.html" alt="TextHRDMapper" shape="rect" coords="127,112,244,136">
</map>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Abstract <a class="el" href="classRegionMapper.html">RegionMapper</a>. 
<p>
Stores all region mappings in hashtable and sequental vector. 
<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="096d7af0e31c90784bd8526917d60829"></a><!-- doxytag: member="RegionMapperImpl::loadRegionMappings" ref="096d7af0e31c90784bd8526917d60829" args="(InputSource *is)=0" -->
virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRegionMapperImpl.html#096d7af0e31c90784bd8526917d60829">loadRegionMappings</a> (<a class="el" href="classInputSource.html">InputSource</a> *is)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Loads region defines from <code>is</code> <a class="el" href="classInputSource.html">InputSource</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="classRegionMapperImpl.html#876684f28ea75414081f5017f14337dd">saveRegionMappings</a> (<a class="el" href="classWriter.html">Writer</a> *writer) const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Saves all loaded region defines into <code>writer</code>.  <a href="#876684f28ea75414081f5017f14337dd"></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="classRegionMapperImpl.html#e26a01d52d622d77f8b5861206eadcc2">setRegionDefine</a> (const <a class="el" href="classString.html">String</a> &amp;region, const <a class="el" href="classRegionDefine.html">RegionDefine</a> *rdnew)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Changes specified region definition to <code>rdnew</code>.  <a href="#e26a01d52d622d77f8b5861206eadcc2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classRegionDefine.html">RegionDefine</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRegionMapperImpl.html#5da9144755a1395cd556c6a2cd4c4b48">enumerateRegionDefines</a> (int idx) const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Enumerates all loaded region defines.  <a href="#5da9144755a1395cd556c6a2cd4c4b48"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="23d86706b5cbc0eb631892c3c5d461bd"></a><!-- doxytag: member="RegionMapperImpl::getRegionDefine" ref="23d86706b5cbc0eb631892c3c5d461bd" args="(const Region *region) const " -->
const <a class="el" href="classRegionDefine.html">RegionDefine</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>getRegionDefine</b> (const <a class="el" href="classRegion.html">Region</a> *region) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e2f8051162466a4dbc7e378021cbed4d"></a><!-- doxytag: member="RegionMapperImpl::getRegionDefine" ref="e2f8051162466a4dbc7e378021cbed4d" args="(const String &amp;name) const " -->
const <a class="el" href="classRegionDefine.html">RegionDefine</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRegionMapperImpl.html#e2f8051162466a4dbc7e378021cbed4d">getRegionDefine</a> (const <a class="el" href="classString.html">String</a> &amp;name) const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns region mapping by it's full qualified name. <br></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="d2fd16ecfe377e7ab06bc2e214d990a7"></a><!-- doxytag: member="RegionMapperImpl::RegionMapperImpl" ref="d2fd16ecfe377e7ab06bc2e214d990a7" args="(const RegionMapperImpl &amp;)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>RegionMapperImpl</b> (const <a class="el" href="classRegionMapperImpl.html">RegionMapperImpl</a> &amp;)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0d743e10396dd53f8770f133702f5762"></a><!-- doxytag: member="RegionMapperImpl::operator=" ref="0d743e10396dd53f8770f133702f5762" args="(const RegionMapperImpl &amp;)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classRegionMapperImpl.html">RegionMapperImpl</a> &amp;)</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="b2a0b8a741d49828cb38910652e21c6f"></a><!-- doxytag: member="RegionMapperImpl::regionDefines" ref="b2a0b8a741d49828cb38910652e21c6f" args="" -->
<a class="el" href="classHashtable.html">Hashtable</a>&lt; <a class="el" href="classRegionDefine.html">RegionDefine</a> * &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>regionDefines</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2ef9ddc992564b533c34436eb73f975b"></a><!-- doxytag: member="RegionMapperImpl::regionDefinesVector" ref="2ef9ddc992564b533c34436eb73f975b" args="" -->
<a class="el" href="classVector.html">Vector</a>&lt; const <a class="el" href="classRegionDefine.html">RegionDefine</a> * &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>regionDefinesVector</b></td></tr>

</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="876684f28ea75414081f5017f14337dd"></a><!-- doxytag: member="RegionMapperImpl::saveRegionMappings" ref="876684f28ea75414081f5017f14337dd" args="(Writer *writer) 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 void RegionMapperImpl::saveRegionMappings           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="classWriter.html">Writer</a> *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>writer</em>          </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>
Saves all loaded region defines into <code>writer</code>. 
<p>
Note, that result document would not be equal to input one, because there could be multiple input documents. 
<p>
Implemented in <a class="el" href="classStyledHRDMapper.html#1e847e2b83d619c793566359f6d12ebc">StyledHRDMapper</a>, and <a class="el" href="classTextHRDMapper.html#777c8700bf793d7ede1802983d1411de">TextHRDMapper</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e26a01d52d622d77f8b5861206eadcc2"></a><!-- doxytag: member="RegionMapperImpl::setRegionDefine" ref="e26a01d52d622d77f8b5861206eadcc2" args="(const String &amp;region, const RegionDefine *rdnew)=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 RegionMapperImpl::setRegionDefine           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="classString.html">String</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>region</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>const <a class="el" href="classRegionDefine.html">RegionDefine</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>rdnew</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [pure virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Changes specified region definition to <code>rdnew</code>. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>region</em>&nbsp;</td><td><a class="el" href="classRegion.html">Region</a> full qualified name. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>rdnew</em>&nbsp;</td><td>New region definition to replace old one </td></tr>
  </table>
</dl>

<p>
Implemented in <a class="el" href="classStyledHRDMapper.html#965f16ba93cefc9eec5195afee26e522">StyledHRDMapper</a>, and <a class="el" href="classTextHRDMapper.html#e76f4c72f5e9df9075bd4042b32f9e5e">TextHRDMapper</a>.    </td>
  </tr>
</table>
<a class="anchor" name="5da9144755a1395cd556c6a2cd4c4b48"></a><!-- doxytag: member="RegionMapperImpl::enumerateRegionDefines" ref="5da9144755a1395cd556c6a2cd4c4b48" args="(int idx) 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">const <a class="el" href="classRegionDefine.html">RegionDefine</a> * RegionMapperImpl::enumerateRegionDefines           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">int&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>idx</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>
Enumerates all loaded region defines. 
<p>
<dl compact><dt><b>Returns:</b></dt><dd><a class="el" href="classRegionDefine.html">RegionDefine</a> with specified internal index, or null if <code>idx</code> is too big </dd></dl>
    </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>