<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Colorer-take5 Library: Outliner 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>Outliner Class Reference<br>
<small>
[<a class="el" href="group__colorer__editor.html">Editor</a>]</small>
</h1><!-- doxytag: class="Outliner" --><!-- doxytag: inherits="RegionHandler,EditorListener" --><p>Inheritance diagram for Outliner:
<p><center><img src="classOutliner.png" usemap="#Outliner_map" border="0" alt=""></center>
<map name="Outliner_map">
<area href="classRegionHandler.html" alt="RegionHandler" shape="rect" coords="0,0,96,24">
<area href="classEditorListener.html" alt="EditorListener" shape="rect" coords="106,0,202,24">
</map>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Used to create, store and maintain list or tree of different special regions.
<p>
These can include functions, methods, fields, classes, errors and so on. Works as a filter on input editor stream.
<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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOutliner.html#5b925926644fc76a05d4ccdefa10cdb8">Outliner</a> (<a class="el" href="classBaseEditor.html">BaseEditor</a> *baseEditor, const <a class="el" href="classRegion.html">Region</a> *searchRegion)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates outliner object, that searches stream for the specified type of region. <a href="#5b925926644fc76a05d4ccdefa10cdb8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classOutlineItem.html">OutlineItem</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classOutliner.html#152fe85c712a7a3eff431a33bf70f64c">getItem</a> (int idx)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns reference to item with specified ordinal index in list of currently generated outline items. <a href="#152fe85c712a7a3eff431a33bf70f64c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="058b4a1cc0e3adde35b1d1840ba788fe"></a><!-- doxytag: member="Outliner::itemCount" ref="058b4a1cc0e3adde35b1d1840ba788fe" args="()" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classOutliner.html#058b4a1cc0e3adde35b1d1840ba788fe">itemCount</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Total number of currently available outline items. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="16d06cf086a40dd7c01c4e0ed8a5a972"></a><!-- doxytag: member="Outliner::startParsing" ref="16d06cf086a40dd7c01c4e0ed8a5a972" args="(int lno)" -->
void </td><td class="memItemRight" valign="bottom"><b>startParsing</b> (int lno)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d46c910d48520e57bbc881fb8e0602a0"></a><!-- doxytag: member="Outliner::endParsing" ref="d46c910d48520e57bbc881fb8e0602a0" args="(int lno)" -->
void </td><td class="memItemRight" valign="bottom"><b>endParsing</b> (int lno)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="174066d24fd54e3820333d41f11998c5"></a><!-- doxytag: member="Outliner::clearLine" ref="174066d24fd54e3820333d41f11998c5" args="(int lno, String *line)" -->
void </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="4315964b45f20701edc67ffa578aacf2"></a><!-- doxytag: member="Outliner::addRegion" ref="4315964b45f20701edc67ffa578aacf2" args="(int lno, String *line, int sx, int ex, const Region *region)" -->
void </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="dfb37eeecb8d8ba44b9f22e3cbbfb840"></a><!-- doxytag: member="Outliner::enterScheme" ref="dfb37eeecb8d8ba44b9f22e3cbbfb840" args="(int lno, String *line, int sx, int ex, const Region *region, const Scheme *scheme)" -->
void </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="f27885189a96c3b5a5cc94c023898ad7"></a><!-- doxytag: member="Outliner::leaveScheme" ref="f27885189a96c3b5a5cc94c023898ad7" args="(int lno, String *line, int sx, int ex, const Region *region, const Scheme *scheme)" -->
void </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 class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bbbd697e2373ecc1b85fdc9e0de46935"></a><!-- doxytag: member="Outliner::modifyEvent" ref="bbbd697e2373ecc1b85fdc9e0de46935" args="(int topLine)" -->
void </td><td class="memItemRight" valign="bottom"><b>modifyEvent</b> (int topLine)</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 int </td><td class="memItemRight" valign="bottom"><a class="el" href="classOutliner.html#b6d4bd5ac1dccd10e3a880830ef0bc93">manageTree</a> (<a class="el" href="classVector.html">Vector</a>< int > &treeStack, int newLevel)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Static service method to make easy tree reconstruction from created list of outline items. <a href="#b6d4bd5ac1dccd10e3a880830ef0bc93"></a><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="3c40e976ee0a33e013ebfefec5c50abd"></a><!-- doxytag: member="Outliner::isOutlined" ref="3c40e976ee0a33e013ebfefec5c50abd" args="(const Region *region)" -->
bool </td><td class="memItemRight" valign="bottom"><b>isOutlined</b> (const <a class="el" href="classRegion.html">Region</a> *region)</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="46a8859b68493b64944da7d34b068999"></a><!-- doxytag: member="Outliner::baseEditor" ref="46a8859b68493b64944da7d34b068999" args="" -->
<a class="el" href="classBaseEditor.html">BaseEditor</a> * </td><td class="memItemRight" valign="bottom"><b>baseEditor</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="39d7e1ae2754faa1ac9fa5db520675f4"></a><!-- doxytag: member="Outliner::searchRegion" ref="39d7e1ae2754faa1ac9fa5db520675f4" args="" -->
const <a class="el" href="classRegion.html">Region</a> * </td><td class="memItemRight" valign="bottom"><b>searchRegion</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e4788fd84cb4e584039b0b94c097759f"></a><!-- doxytag: member="Outliner::outline" ref="e4788fd84cb4e584039b0b94c097759f" args="" -->
<a class="el" href="classVector.html">Vector</a>< <a class="el" href="classOutlineItem.html">OutlineItem</a> * > </td><td class="memItemRight" valign="bottom"><b>outline</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5a7e9f545840566f6526680162dee7dd"></a><!-- doxytag: member="Outliner::lineIsEmpty" ref="5a7e9f545840566f6526680162dee7dd" args="" -->
bool </td><td class="memItemRight" valign="bottom"><b>lineIsEmpty</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d807576b4377301daaf533767123725b"></a><!-- doxytag: member="Outliner::curLevel" ref="d807576b4377301daaf533767123725b" args="" -->
int </td><td class="memItemRight" valign="bottom"><b>curLevel</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="58d9cb62d67af05a9b056d7f044a64c0"></a><!-- doxytag: member="Outliner::modifiedLine" ref="58d9cb62d67af05a9b056d7f044a64c0" args="" -->
int </td><td class="memItemRight" valign="bottom"><b>modifiedLine</b></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="5b925926644fc76a05d4ccdefa10cdb8"></a><!-- doxytag: member="Outliner::Outliner" ref="5b925926644fc76a05d4ccdefa10cdb8" args="(BaseEditor *baseEditor, const Region *searchRegion)" --><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">Outliner::Outliner </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classBaseEditor.html">BaseEditor</a> * </td>
<td class="mdname" nowrap> <em>baseEditor</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const <a class="el" href="classRegion.html">Region</a> * </td>
<td class="mdname" nowrap> <em>searchRegion</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Creates outliner object, that searches stream for the specified type of region.
<p>
<a class="el" href="classOutliner.html">Outliner</a> is deattached on its explicit destruction action.<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>baseEditor</em> </td><td>Editor to attach this <a class="el" href="classOutliner.html">Outliner</a> to. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>searchRegion</em> </td><td><a class="el" href="classRegion.html">Region</a> type to search in parser's stream </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="152fe85c712a7a3eff431a33bf70f64c"></a><!-- doxytag: member="Outliner::getItem" ref="152fe85c712a7a3eff431a33bf70f64c" args="(int idx)" --><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="classOutlineItem.html">OutlineItem</a> * Outliner::getItem </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname1" valign="top" nowrap> <em>idx</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Returns reference to item with specified ordinal index in list of currently generated outline items.
<p>
Note, that the returned pointer is vaild only between subsequent parser invocations. </td>
</tr>
</table>
<a class="anchor" name="b6d4bd5ac1dccd10e3a880830ef0bc93"></a><!-- doxytag: member="Outliner::manageTree" ref="b6d4bd5ac1dccd10e3a880830ef0bc93" args="(Vector< int > &treeStack, int newLevel)" --><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">int Outliner::manageTree </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classVector.html">Vector</a>< int > & </td>
<td class="mdname" nowrap> <em>treeStack</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>newLevel</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Static service method to make easy tree reconstruction from created list of outline items.
<p>
This list contains unpacked level indexed of item's enclosure in scheme. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>treeStack</em> </td><td>external <a class="el" href="classVector.html">Vector</a> of integer, storing temporary tree structure. Must not be changed externally. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>newLevel</em> </td><td>Unpacked level of item to be added into the tree. This index is converted into packed one and returned. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Packed index of item, which could be used to reconstruct tree of outlined items. </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>
