Sophie

Sophie

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

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: ParsedLineWriter 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>ParsedLineWriter Class Reference<br>
<small>
[<a class="el" href="group__colorer__viewer.html">Viewer/streaming</a>]</small>
</h1><!-- doxytag: class="ParsedLineWriter" --><hr><a name="_details"></a><h2>Detailed Description</h2>
Static service methods of <a class="el" href="classLineRegion.html">LineRegion</a> output. 
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParsedLineWriter.html#386cdfcef4b1438a920ef21d58021172">tokenWrite</a> (<a class="el" href="classWriter.html">Writer</a> *markupWriter, <a class="el" href="classWriter.html">Writer</a> *textWriter, <a class="el" href="classHashtable.html">Hashtable</a>&lt; <a class="el" href="classString.html">String</a> * &gt; *docLinkHash, <a class="el" href="classString.html">String</a> *line, <a class="el" href="classLineRegion.html">LineRegion</a> *lineRegions)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Writes given line of text using list of passed line regions.  <a href="#386cdfcef4b1438a920ef21d58021172"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParsedLineWriter.html#dc3cca041af535c89b09a2345b47b4e6">markupWrite</a> (<a class="el" href="classWriter.html">Writer</a> *markupWriter, <a class="el" href="classWriter.html">Writer</a> *textWriter, <a class="el" href="classHashtable.html">Hashtable</a>&lt; <a class="el" href="classString.html">String</a> * &gt; *docLinkHash, <a class="el" href="classString.html">String</a> *line, <a class="el" href="classLineRegion.html">LineRegion</a> *lineRegions)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write specified line of text using list of LineRegion's.  <a href="#dc3cca041af535c89b09a2345b47b4e6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParsedLineWriter.html#71d81dd456ab540cf8451756e16ab2bd">htmlRGBWrite</a> (<a class="el" href="classWriter.html">Writer</a> *markupWriter, <a class="el" href="classWriter.html">Writer</a> *textWriter, <a class="el" href="classHashtable.html">Hashtable</a>&lt; <a class="el" href="classString.html">String</a> * &gt; *docLinkHash, <a class="el" href="classString.html">String</a> *line, <a class="el" href="classLineRegion.html">LineRegion</a> *lineRegions)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write specified line of text using list of LineRegion's.  <a href="#71d81dd456ab540cf8451756e16ab2bd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1079f368e548c7e30630fc3ee291330b"></a><!-- doxytag: member="ParsedLineWriter::writeStyle" ref="1079f368e548c7e30630fc3ee291330b" args="(Writer *writer, const StyledRegion *lr)" -->
static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParsedLineWriter.html#1079f368e548c7e30630fc3ee291330b">writeStyle</a> (<a class="el" href="classWriter.html">Writer</a> *writer, const <a class="el" href="classStyledRegion.html">StyledRegion</a> *lr)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Puts into stream style attributes from <a class="el" href="classRegionDefine.html">RegionDefine</a> object. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="16b2c3c73a4e0fe33ba8bc323cb29184"></a><!-- doxytag: member="ParsedLineWriter::writeStart" ref="16b2c3c73a4e0fe33ba8bc323cb29184" args="(Writer *writer, const StyledRegion *lr)" -->
static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParsedLineWriter.html#16b2c3c73a4e0fe33ba8bc323cb29184">writeStart</a> (<a class="el" href="classWriter.html">Writer</a> *writer, const <a class="el" href="classStyledRegion.html">StyledRegion</a> *lr)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Puts into stream starting HTML &lt;span&gt; tag with requested style specification. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d0446bcc79536c76c29e42ece3bdc821"></a><!-- doxytag: member="ParsedLineWriter::writeEnd" ref="d0446bcc79536c76c29e42ece3bdc821" args="(Writer *writer, const StyledRegion *lr)" -->
static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParsedLineWriter.html#d0446bcc79536c76c29e42ece3bdc821">writeEnd</a> (<a class="el" href="classWriter.html">Writer</a> *writer, const <a class="el" href="classStyledRegion.html">StyledRegion</a> *lr)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Puts into stream ending HTML &lt;/span&gt; tag. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2816e70bff79dde257edd730d19a7149"></a><!-- doxytag: member="ParsedLineWriter::writeHref" ref="2816e70bff79dde257edd730d19a7149" args="(Writer *writer, Hashtable&lt; String * &gt; *docLinkHash, const Scheme *scheme, const String &amp;token, bool start)" -->
static void&nbsp;</td><td class="memItemRight" valign="bottom"><b>writeHref</b> (<a class="el" href="classWriter.html">Writer</a> *writer, <a class="el" href="classHashtable.html">Hashtable</a>&lt; <a class="el" href="classString.html">String</a> * &gt; *docLinkHash, const <a class="el" href="classScheme.html">Scheme</a> *scheme, const <a class="el" href="classString.html">String</a> &amp;token, bool start)</td></tr>

</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="386cdfcef4b1438a920ef21d58021172"></a><!-- doxytag: member="ParsedLineWriter::tokenWrite" ref="386cdfcef4b1438a920ef21d58021172" args="(Writer *markupWriter, Writer *textWriter, Hashtable&lt; String * &gt; *docLinkHash, String *line, LineRegion *lineRegions)" --><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">static void ParsedLineWriter::tokenWrite           </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="mdname" nowrap> <em>markupWriter</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap><a class="el" href="classWriter.html">Writer</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>textWriter</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap><a class="el" href="classHashtable.html">Hashtable</a>&lt; <a class="el" href="classString.html">String</a> * &gt; *&nbsp;</td>
          <td class="mdname" nowrap> <em>docLinkHash</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap><a class="el" href="classString.html">String</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>line</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap><a class="el" href="classLineRegion.html">LineRegion</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>lineRegions</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [inline, static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Writes given line of text using list of passed line regions. 
<p>
Formats output with class of each token, enclosed in &lt;span class='regionName'&gt;...&lt;/span&gt; <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>markupWriter</em>&nbsp;</td><td><a class="el" href="classWriter.html">Writer</a>, used for markup output </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>textWriter</em>&nbsp;</td><td><a class="el" href="classWriter.html">Writer</a>, used for text output </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>line</em>&nbsp;</td><td>Line of text </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>lineRegions</em>&nbsp;</td><td>Linked list of <a class="el" href="classLineRegion.html">LineRegion</a> structures. Only region references are used there. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="dc3cca041af535c89b09a2345b47b4e6"></a><!-- doxytag: member="ParsedLineWriter::markupWrite" ref="dc3cca041af535c89b09a2345b47b4e6" args="(Writer *markupWriter, Writer *textWriter, Hashtable&lt; String * &gt; *docLinkHash, String *line, LineRegion *lineRegions)" --><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">static void ParsedLineWriter::markupWrite           </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="mdname" nowrap> <em>markupWriter</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap><a class="el" href="classWriter.html">Writer</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>textWriter</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap><a class="el" href="classHashtable.html">Hashtable</a>&lt; <a class="el" href="classString.html">String</a> * &gt; *&nbsp;</td>
          <td class="mdname" nowrap> <em>docLinkHash</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap><a class="el" href="classString.html">String</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>line</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap><a class="el" href="classLineRegion.html">LineRegion</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>lineRegions</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [inline, static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Write specified line of text using list of LineRegion's. 
<p>
This method uses text fields of <a class="el" href="classLineRegion.html">LineRegion</a> class to enwrap each line region. It uses two Writers - <code>markupWriter</code> and <code>textWriter</code>. <code>markupWriter</code> is used to write markup elements of <a class="el" href="classLineRegion.html">LineRegion</a>, and <code>textWriter</code> is used to write line content. <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>markupWriter</em>&nbsp;</td><td><a class="el" href="classWriter.html">Writer</a>, used for markup output </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>textWriter</em>&nbsp;</td><td><a class="el" href="classWriter.html">Writer</a>, used for text output </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>line</em>&nbsp;</td><td>Line of text </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>lineRegions</em>&nbsp;</td><td>Linked list of <a class="el" href="classLineRegion.html">LineRegion</a> structures </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="71d81dd456ab540cf8451756e16ab2bd"></a><!-- doxytag: member="ParsedLineWriter::htmlRGBWrite" ref="71d81dd456ab540cf8451756e16ab2bd" args="(Writer *markupWriter, Writer *textWriter, Hashtable&lt; String * &gt; *docLinkHash, String *line, LineRegion *lineRegions)" --><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">static void ParsedLineWriter::htmlRGBWrite           </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="mdname" nowrap> <em>markupWriter</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap><a class="el" href="classWriter.html">Writer</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>textWriter</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap><a class="el" href="classHashtable.html">Hashtable</a>&lt; <a class="el" href="classString.html">String</a> * &gt; *&nbsp;</td>
          <td class="mdname" nowrap> <em>docLinkHash</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap><a class="el" href="classString.html">String</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>line</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap><a class="el" href="classLineRegion.html">LineRegion</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>lineRegions</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [inline, static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Write specified line of text using list of LineRegion's. 
<p>
This method uses integer fields of <a class="el" href="classLineRegion.html">LineRegion</a> class to enwrap each line region with generated HTML markup. Each region is <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>markupWriter</em>&nbsp;</td><td><a class="el" href="classWriter.html">Writer</a>, used for markup output </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>textWriter</em>&nbsp;</td><td><a class="el" href="classWriter.html">Writer</a>, used for text output </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>line</em>&nbsp;</td><td>Line of text </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>lineRegions</em>&nbsp;</td><td>Linked list of <a class="el" href="classLineRegion.html">LineRegion</a> structures </td></tr>
  </table>
</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:13 2006 by doxygen 1.4.6.
</small><center>
    </BODY>
  </HTML>