Sophie

Sophie

distrib > Mandriva > 2010.2 > x86_64 > by-pkgid > 9ac0f970b86472ed1e748202d2848da8 > files > 152

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: TextHRDMapper 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>TextHRDMapper Class Reference<br>
<small>
[<a class="el" href="group__colorer__handlers.html">Handlers</a>]</small>
</h1><!-- doxytag: class="TextHRDMapper" --><!-- doxytag: inherits="RegionMapperImpl" --><p>Inheritance diagram for TextHRDMapper:
<p><center><img src="classTextHRDMapper.png" usemap="#TextHRDMapper_map" border="0" alt=""></center>
<map name="TextHRDMapper_map">
<area href="classRegionMapperImpl.html" alt="RegionMapperImpl" shape="rect" coords="0,56,117,80">
<area href="classRegionMapper.html" alt="RegionMapper" shape="rect" coords="0,0,117,24">
</map>
<hr><a name="_details"></a><h2>Detailed Description</h2>
HRD files reader. 
<p>
HRD Files format contains mappings of HRC syntax regions into text indention information. For example, HTML indention (<code>stext</code>, <code>sback</code>, <code>etext</code>, <code>eback</code>) allows to create colorized HTML code. 
<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">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTextHRDMapper.html#1e49beb53281a97282c4586e59b4e56b">loadRegionMappings</a> (<a class="el" href="classInputSource.html">InputSource</a> *is)</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>.  <a href="#1e49beb53281a97282c4586e59b4e56b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTextHRDMapper.html#777c8700bf793d7ede1802983d1411de">saveRegionMappings</a> (<a class="el" href="classWriter.html">Writer</a> *writer) const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Saves all loaded region defines into <code>writer</code>.  <a href="#777c8700bf793d7ede1802983d1411de"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTextHRDMapper.html#e76f4c72f5e9df9075bd4042b32f9e5e">setRegionDefine</a> (const <a class="el" href="classString.html">String</a> &amp;region, const <a class="el" href="classRegionDefine.html">RegionDefine</a> *rdnew)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Changes specified region definition to <code>rdnew</code>.  <a href="#e76f4c72f5e9df9075bd4042b32f9e5e"></a><br></td></tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="1e49beb53281a97282c4586e59b4e56b"></a><!-- doxytag: member="TextHRDMapper::loadRegionMappings" ref="1e49beb53281a97282c4586e59b4e56b" args="(InputSource *is)" --><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 TextHRDMapper::loadRegionMappings           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="classInputSource.html">InputSource</a> *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>is</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Loads region defines from <code>is</code> <a class="el" href="classInputSource.html">InputSource</a>. 
<p>
Multiple files could be loaded. 
<p>
Implements <a class="el" href="classRegionMapperImpl.html#096d7af0e31c90784bd8526917d60829">RegionMapperImpl</a>.    </td>
  </tr>
</table>
<a class="anchor" name="777c8700bf793d7ede1802983d1411de"></a><!-- doxytag: member="TextHRDMapper::saveRegionMappings" ref="777c8700bf793d7ede1802983d1411de" args="(Writer *writer) 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">void TextHRDMapper::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> [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>
Implements <a class="el" href="classRegionMapperImpl.html#876684f28ea75414081f5017f14337dd">RegionMapperImpl</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e76f4c72f5e9df9075bd4042b32f9e5e"></a><!-- doxytag: member="TextHRDMapper::setRegionDefine" ref="e76f4c72f5e9df9075bd4042b32f9e5e" args="(const String &amp;region, const RegionDefine *rdnew)" --><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 TextHRDMapper::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> [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>
Implements <a class="el" href="classRegionMapperImpl.html#e26a01d52d622d77f8b5861206eadcc2">RegionMapperImpl</a>.    </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>