<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Colorer-take5 Library: LineSource 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>LineSource Class Reference<br>
<small>
[<a class="el" href="group__colorer.html">Colorer interfaces</a>]</small>
</h1><!-- doxytag: class="LineSource" --><p>Inheritance diagram for LineSource:
<p><center><img src="classLineSource.png" usemap="#LineSource_map" border="0" alt=""></center>
<map name="LineSource_map">
<area href="classFarEditor.html" alt="FarEditor" shape="rect" coords="0,56,95,80">
<area href="classTextLinesStore.html" alt="TextLinesStore" shape="rect" coords="105,56,200,80">
</map>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Interface for editor line information requests.
<p>
Basic data source interface, used in <a class="el" href="classTextParser.html">TextParser</a> processing. <dl compact><dt><b>Note:</b></dt><dd>Methods startJob and endJob are optional, and could be implemented or not depending on system archtecture. </dd></dl>
<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">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classLineSource.html#79ce8b923bde3548710278fcb1f8184f">startJob</a> (int lno)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Called by parser, when it starts text parsing. <a href="#79ce8b923bde3548710278fcb1f8184f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classLineSource.html#52c546b39d975077238627ba450ed332">endJob</a> (int lno)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Called by parser, when it has finished text parsing. <a href="#52c546b39d975077238627ba450ed332"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classString.html">String</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classLineSource.html#603ba3ef16f10819957297dbcffe8896">getLine</a> (int lno)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns line of text with specified number. <a href="#603ba3ef16f10819957297dbcffe8896"></a><br></td></tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="79ce8b923bde3548710278fcb1f8184f"></a><!-- doxytag: member="LineSource::startJob" ref="79ce8b923bde3548710278fcb1f8184f" args="(int lno)" --><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 LineSource::startJob </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname1" valign="top" nowrap> <em>lno</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Called by parser, when it starts text parsing.
<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>lno</em> </td><td>Line number, which will be used as initial position of all subsequend parsing. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="52c546b39d975077238627ba450ed332"></a><!-- doxytag: member="LineSource::endJob" ref="52c546b39d975077238627ba450ed332" args="(int lno)" --><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 LineSource::endJob </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname1" valign="top" nowrap> <em>lno</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Called by parser, when it has finished text parsing.
<p>
Could be used to cleanup objects, allocated by last <a class="el" href="classLineSource.html#603ba3ef16f10819957297dbcffe8896">getLine()</a> call. </td>
</tr>
</table>
<a class="anchor" name="603ba3ef16f10819957297dbcffe8896"></a><!-- doxytag: member="LineSource::getLine" ref="603ba3ef16f10819957297dbcffe8896" args="(int lno)=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 <a class="el" href="classString.html">String</a>* LineSource::getLine </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname1" valign="top" nowrap> <em>lno</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Returns line of text with specified number.
<p>
Returns <a class="el" href="classString.html">String</a> class pointer, which incapsulates information about line with number <code>lno</code>. <dl compact><dt><b>Note:</b></dt><dd>Returned pointer must be valid until next getLine method call. If requested line can't be returned, fe there is no line with the passed index, method must return null. </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>lno</em> </td><td>Requested line number </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Unicode string, enwrapped into <a class="el" href="classString.html">String</a> class. </dd></dl>
</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>
