<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Colorer-take5 Library: FarEditor 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>FarEditor Class Reference<br>
<small>
[<a class="el" href="group__far__plugin.html">FAR Manager plugin</a>]</small>
</h1><!-- doxytag: class="FarEditor" --><!-- doxytag: inherits="LineSource" --><p>Inheritance diagram for FarEditor:
<p><center><img src="classFarEditor.png" usemap="#FarEditor_map" border="0" alt=""></center>
<map name="FarEditor_map">
<area href="classLineSource.html" alt="LineSource" shape="rect" coords="0,0,77,24">
</map>
<hr><a name="_details"></a><h2>Detailed Description</h2>
FAR Editor internal plugin structures.
<p>
Implements text parsing and different editor extended functions.
<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="b87378e408fda38ef80efff039f9714e"></a><!-- doxytag: member="FarEditor::FarEditor" ref="b87378e408fda38ef80efff039f9714e" args="(PluginStartupInfo *info, ParserFactory *pf)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classFarEditor.html#b87378e408fda38ef80efff039f9714e">FarEditor</a> (PluginStartupInfo *info, <a class="el" href="classParserFactory.html">ParserFactory</a> *pf)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates FAR editor instance. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e1b97a9dc8b23aca0136ee5bca4102d5"></a><!-- doxytag: member="FarEditor::~FarEditor" ref="e1b97a9dc8b23aca0136ee5bca4102d5" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classFarEditor.html#e1b97a9dc8b23aca0136ee5bca4102d5">~FarEditor</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Drops this editor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4dc24b0723fcd6d94d3162ba116645c7"></a><!-- doxytag: member="FarEditor::endJob" ref="4dc24b0723fcd6d94d3162ba116645c7" args="(int lno)" -->
void </td><td class="memItemRight" valign="bottom"><b>endJob</b> (int lno)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="668ac4fa3ce989695672ef1132061b24"></a><!-- doxytag: member="FarEditor::getLine" ref="668ac4fa3ce989695672ef1132061b24" args="(int lno)" -->
<a class="el" href="classString.html">String</a> * </td><td class="memItemRight" valign="bottom"><b>getLine</b> (int lno)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="49a39573ac47e03ff8b523c738b84904"></a><!-- doxytag: member="FarEditor::setFileType" ref="49a39573ac47e03ff8b523c738b84904" args="(FileType *ftype)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFarEditor.html#49a39573ac47e03ff8b523c738b84904">setFileType</a> (<a class="el" href="classFileType.html">FileType</a> *ftype)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Changes current assigned file type. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2cf1b8a24936e7f0c7c45c4dc90551a2"></a><!-- doxytag: member="FarEditor::getFileType" ref="2cf1b8a24936e7f0c7c45c4dc90551a2" args="()" -->
<a class="el" href="classFileType.html">FileType</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classFarEditor.html#2cf1b8a24936e7f0c7c45c4dc90551a2">getFileType</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns currently selected file type. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="59058251a71d4b4fae3c0fb99a66649e"></a><!-- doxytag: member="FarEditor::chooseFileType" ref="59058251a71d4b4fae3c0fb99a66649e" args="(String *fname)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFarEditor.html#59058251a71d4b4fae3c0fb99a66649e">chooseFileType</a> (<a class="el" href="classString.html">String</a> *fname)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Selects file type with it's extension and first lines. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFarEditor.html#7650ad4d155b9d3496a9148f1274a7f6">setRegionMapper</a> (<a class="el" href="classRegionMapper.html">RegionMapper</a> *rs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Installs specified <a class="el" href="classRegionMapper.html">RegionMapper</a> implementation. <a href="#7650ad4d155b9d3496a9148f1274a7f6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFarEditor.html#fe9a457fb5f45a10280a3fa727daeac7">setDrawCross</a> (bool drawCross)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Change editor properties. <a href="#fe9a457fb5f45a10280a3fa727daeac7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f3476a6382edd709e27052049fceeed4"></a><!-- doxytag: member="FarEditor::setDrawPairs" ref="f3476a6382edd709e27052049fceeed4" args="(bool drawPairs)" -->
void </td><td class="memItemRight" valign="bottom"><b>setDrawPairs</b> (bool drawPairs)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f48659273162ece4fc1efdd6f1da78e2"></a><!-- doxytag: member="FarEditor::setDrawSyntax" ref="f48659273162ece4fc1efdd6f1da78e2" args="(bool drawSyntax)" -->
void </td><td class="memItemRight" valign="bottom"><b>setDrawSyntax</b> (bool drawSyntax)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="120563cbb351ee86da0bc7f855df0328"></a><!-- doxytag: member="FarEditor::setOutlineStyle" ref="120563cbb351ee86da0bc7f855df0328" args="(bool oldStyle)" -->
void </td><td class="memItemRight" valign="bottom"><b>setOutlineStyle</b> (bool oldStyle)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4af8c3f2552fc2dfe52cd89f52a84298"></a><!-- doxytag: member="FarEditor::setMaxTime" ref="4af8c3f2552fc2dfe52cd89f52a84298" args="(int maxTime)" -->
void </td><td class="memItemRight" valign="bottom"><b>setMaxTime</b> (int maxTime)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2c27a5345dbca0b6485482d3e991a34a"></a><!-- doxytag: member="FarEditor::matchPair" ref="2c27a5345dbca0b6485482d3e991a34a" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFarEditor.html#2c27a5345dbca0b6485482d3e991a34a">matchPair</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Editor action: pair matching. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ece8e3f2e6d9cadf07334d4fd01e8ce9"></a><!-- doxytag: member="FarEditor::selectPair" ref="ece8e3f2e6d9cadf07334d4fd01e8ce9" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFarEditor.html#ece8e3f2e6d9cadf07334d4fd01e8ce9">selectPair</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Editor action: pair selection. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="56d7198e49185f25e5ab52fb85b877b4"></a><!-- doxytag: member="FarEditor::selectBlock" ref="56d7198e49185f25e5ab52fb85b877b4" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFarEditor.html#56d7198e49185f25e5ab52fb85b877b4">selectBlock</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Editor action: pair selection with current block. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="45bef1ef3e532fd697e5456d73154b39"></a><!-- doxytag: member="FarEditor::selectRegion" ref="45bef1ef3e532fd697e5456d73154b39" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFarEditor.html#45bef1ef3e532fd697e5456d73154b39">selectRegion</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Editor action: Selection of current region under cursor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="173a8c02a4cabf4e5c5ce3355488af3c"></a><!-- doxytag: member="FarEditor::listFunctions" ref="173a8c02a4cabf4e5c5ce3355488af3c" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFarEditor.html#173a8c02a4cabf4e5c5ce3355488af3c">listFunctions</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Editor action: Lists fuctional region. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4efe33a6f63c89cfbcc5870b658392e8"></a><!-- doxytag: member="FarEditor::listErrors" ref="4efe33a6f63c89cfbcc5870b658392e8" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFarEditor.html#4efe33a6f63c89cfbcc5870b658392e8">listErrors</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Editor action: Lists syntax errors in text. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="de8724350a66155ce4a9aece59709509"></a><!-- doxytag: member="FarEditor::locateFunction" ref="de8724350a66155ce4a9aece59709509" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFarEditor.html#de8724350a66155ce4a9aece59709509">locateFunction</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Locates a function under cursor and tries to jump to it using outliner information. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="eaffd317dc3da84bc340451f52072b74"></a><!-- doxytag: member="FarEditor::updateHighlighting" ref="eaffd317dc3da84bc340451f52072b74" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFarEditor.html#eaffd317dc3da84bc340451f52072b74">updateHighlighting</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Invalidates current syntax highlighting. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6514d0876dfb3630a848f56903613a44"></a><!-- doxytag: member="FarEditor::selectEncoding" ref="6514d0876dfb3630a848f56903613a44" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFarEditor.html#6514d0876dfb3630a848f56903613a44">selectEncoding</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Shows menu to select editor encoding. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classFarEditor.html#7b82d88368190230b82936c8ec8ace13">editorEvent</a> (int event, void *param)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle passed FAR editor event. <a href="#7b82d88368190230b82936c8ec8ace13"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2861760b71fa2e50ad9627927fadada6"></a><!-- doxytag: member="FarEditor::editorInput" ref="2861760b71fa2e50ad9627927fadada6" args="(const INPUT_RECORD *ir)" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classFarEditor.html#2861760b71fa2e50ad9627927fadada6">editorInput</a> (const INPUT_RECORD *ir)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Dispatch editor input event. <br></td></tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="7650ad4d155b9d3496a9148f1274a7f6"></a><!-- doxytag: member="FarEditor::setRegionMapper" ref="7650ad4d155b9d3496a9148f1274a7f6" args="(RegionMapper *rs)" --><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 FarEditor::setRegionMapper </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classRegionMapper.html">RegionMapper</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>rs</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>
Installs specified <a class="el" href="classRegionMapper.html">RegionMapper</a> implementation.
<p>
This class serves to request mapping of regions into real colors. </td>
</tr>
</table>
<a class="anchor" name="fe9a457fb5f45a10280a3fa727daeac7"></a><!-- doxytag: member="FarEditor::setDrawCross" ref="fe9a457fb5f45a10280a3fa727daeac7" args="(bool drawCross)" --><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 FarEditor::setDrawCross </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> <em>drawCross</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>
Change editor properties.
<p>
These overwrites default HRC settings </td>
</tr>
</table>
<a class="anchor" name="7b82d88368190230b82936c8ec8ace13"></a><!-- doxytag: member="FarEditor::editorEvent" ref="7b82d88368190230b82936c8ec8ace13" args="(int event, void *param)" --><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 FarEditor::editorEvent </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname" nowrap> <em>event</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>void * </td>
<td class="mdname" nowrap> <em>param</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>
Handle passed FAR editor event.
<p>
pair brackets </td>
</tr>
</table>
<br><br>
<center><small>
Colorer-take5 Library. Copyright © 1999-2006 Igor Russkih.<br>
Generated at Fri Nov 24 17:13:12 2006 by doxygen 1.4.6.
</small><center>
</BODY>
</HTML>
