You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
tqscintilla/doc/html/classQextScintillaLexerBatc...

346 lines
18 KiB

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>QScintilla: QextScintillaLexerBatch Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.7 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li id="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul></div>
<h1>QextScintillaLexerBatch Class Reference</h1><!-- doxytag: class="QextScintillaLexerBatch" --><!-- doxytag: inherits="QextScintillaLexer" -->The <a class="el" href="classQextScintillaLexerBatch.html">QextScintillaLexerBatch</a> class encapsulates the Scintilla batch file lexer.
<a href="#_details">More...</a>
<p>
<code>#include &lt;qextscintillalexerbatch.h&gt;</code>
<p>
Inherits <a class="el" href="classQextScintillaLexer.html">QextScintillaLexer</a>.
<p>
<a href="classQextScintillaLexerBatch-members.html">List of all members.</a><h2>Public Types</h2>
<ul>
<li><a class="el" href="classQextScintillaLexerBatch.html#1c7593d25567abda34c5ae309e5e27e9ed475cdb093f6c8c6041afb504f5282d">Default</a> = 0
<li><a class="el" href="classQextScintillaLexerBatch.html#1c7593d25567abda34c5ae309e5e27e91330f125537d1c1ca8b345188e2fcea1">Comment</a> = 1
<li><a class="el" href="classQextScintillaLexerBatch.html#1c7593d25567abda34c5ae309e5e27e9e12625243e7ad8c79ad6ff80fcd1ff09">Keyword</a> = 2
<li><a class="el" href="classQextScintillaLexerBatch.html#1c7593d25567abda34c5ae309e5e27e9716e376de87998ce993aa478d4121cf6">Label</a> = 3
<li><a class="el" href="classQextScintillaLexerBatch.html#1c7593d25567abda34c5ae309e5e27e9d34e98afe7af83eb5a899ddce85af11a">HideCommandChar</a> = 4
<li><a class="el" href="classQextScintillaLexerBatch.html#1c7593d25567abda34c5ae309e5e27e9ebf5d8fb94cea583b143df6de8e3798f">ExternalCommand</a> = 5
<li><a class="el" href="classQextScintillaLexerBatch.html#1c7593d25567abda34c5ae309e5e27e98e3a304c4b0be68caffe787ae4ea7cf4">Variable</a> = 6
<li><a class="el" href="classQextScintillaLexerBatch.html#1c7593d25567abda34c5ae309e5e27e94251aa4bd4773717207d3cc95cf993d4">Operator</a> = 7
<li>enum { <br>
&nbsp;&nbsp;<a class="el" href="classQextScintillaLexerBatch.html#1c7593d25567abda34c5ae309e5e27e9ed475cdb093f6c8c6041afb504f5282d">Default</a> = 0,
<a class="el" href="classQextScintillaLexerBatch.html#1c7593d25567abda34c5ae309e5e27e91330f125537d1c1ca8b345188e2fcea1">Comment</a> = 1,
<a class="el" href="classQextScintillaLexerBatch.html#1c7593d25567abda34c5ae309e5e27e9e12625243e7ad8c79ad6ff80fcd1ff09">Keyword</a> = 2,
<br>
&nbsp;&nbsp;<a class="el" href="classQextScintillaLexerBatch.html#1c7593d25567abda34c5ae309e5e27e9716e376de87998ce993aa478d4121cf6">Label</a> = 3,
<a class="el" href="classQextScintillaLexerBatch.html#1c7593d25567abda34c5ae309e5e27e9d34e98afe7af83eb5a899ddce85af11a">HideCommandChar</a> = 4,
<a class="el" href="classQextScintillaLexerBatch.html#1c7593d25567abda34c5ae309e5e27e9ebf5d8fb94cea583b143df6de8e3798f">ExternalCommand</a> = 5,
<br>
&nbsp;&nbsp;<a class="el" href="classQextScintillaLexerBatch.html#1c7593d25567abda34c5ae309e5e27e98e3a304c4b0be68caffe787ae4ea7cf4">Variable</a> = 6,
<a class="el" href="classQextScintillaLexerBatch.html#1c7593d25567abda34c5ae309e5e27e94251aa4bd4773717207d3cc95cf993d4">Operator</a> = 7
<br>
}
</ul>
<h2>Public Member Functions</h2>
<ul>
<li><a class="el" href="classQextScintillaLexerBatch.html#a2ebe656b90ee7f42f681be2b3f4e39a">QextScintillaLexerBatch</a> (QObject *parent=0, const char *name=0)
<li>virtual <a class="el" href="classQextScintillaLexerBatch.html#07ec0d3cd82cdaec9dd201999a23b498">~QextScintillaLexerBatch</a> ()
<li>const char * <a class="el" href="classQextScintillaLexerBatch.html#ce8f2eca661457993c6b334c297dd1e9">language</a> () const
<li>const char * <a class="el" href="classQextScintillaLexerBatch.html#ad3275fdafc700e7e14cd9d8beb6c589">lexer</a> () const
<li><a class="anchor" name="564f39d898f412d1759f1c3ee3a6ff66"></a><!-- doxytag: member="QextScintillaLexerBatch::wordCharacters" ref="564f39d898f412d1759f1c3ee3a6ff66" args="() const " -->
const char * <b>wordCharacters</b> () const
<li>QColor <a class="el" href="classQextScintillaLexerBatch.html#8b016e35c2e59956a2df1904ffa1e007">color</a> (int style) const
<li>bool <a class="el" href="classQextScintillaLexerBatch.html#d94fd24c1f3d156456d5018e6a202b23">eolFill</a> (int style) const
<li>QFont <a class="el" href="classQextScintillaLexerBatch.html#d23670696aad82a64c8879aea1532b12">font</a> (int style) const
<li>const char * <a class="el" href="classQextScintillaLexerBatch.html#7b364c4a62ec33d88bf148e2a28212ef">keywords</a> (int set) const
<li>QString <a class="el" href="classQextScintillaLexerBatch.html#03dca4c7289305a22a745db4d4c5e76f">description</a> (int style) const
<li>QColor <a class="el" href="classQextScintillaLexerBatch.html#f383c2bfa30a7f5b7d3982949f910326">paper</a> (int style) const
</ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The <a class="el" href="classQextScintillaLexerBatch.html">QextScintillaLexerBatch</a> class encapsulates the Scintilla batch file lexer.
<p>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="1c7593d25567abda34c5ae309e5e27e9"></a><!-- doxytag: member="QextScintillaLexerBatch::@32" ref="1c7593d25567abda34c5ae309e5e27e9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">anonymous enum </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This enum defines the meanings of the different styles used by the batch file lexer. <dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="1c7593d25567abda34c5ae309e5e27e9ed475cdb093f6c8c6041afb504f5282d"></a><!-- doxytag: member="Default" ref="1c7593d25567abda34c5ae309e5e27e9ed475cdb093f6c8c6041afb504f5282d" args="" -->Default</em>&nbsp;</td><td>
The default. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="1c7593d25567abda34c5ae309e5e27e91330f125537d1c1ca8b345188e2fcea1"></a><!-- doxytag: member="Comment" ref="1c7593d25567abda34c5ae309e5e27e91330f125537d1c1ca8b345188e2fcea1" args="" -->Comment</em>&nbsp;</td><td>
A comment. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="1c7593d25567abda34c5ae309e5e27e9e12625243e7ad8c79ad6ff80fcd1ff09"></a><!-- doxytag: member="Keyword" ref="1c7593d25567abda34c5ae309e5e27e9e12625243e7ad8c79ad6ff80fcd1ff09" args="" -->Keyword</em>&nbsp;</td><td>
A keyword. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="1c7593d25567abda34c5ae309e5e27e9716e376de87998ce993aa478d4121cf6"></a><!-- doxytag: member="Label" ref="1c7593d25567abda34c5ae309e5e27e9716e376de87998ce993aa478d4121cf6" args="" -->Label</em>&nbsp;</td><td>
A label. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="1c7593d25567abda34c5ae309e5e27e9d34e98afe7af83eb5a899ddce85af11a"></a><!-- doxytag: member="HideCommandChar" ref="1c7593d25567abda34c5ae309e5e27e9d34e98afe7af83eb5a899ddce85af11a" args="" -->HideCommandChar</em>&nbsp;</td><td>
An hide command character. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="1c7593d25567abda34c5ae309e5e27e9ebf5d8fb94cea583b143df6de8e3798f"></a><!-- doxytag: member="ExternalCommand" ref="1c7593d25567abda34c5ae309e5e27e9ebf5d8fb94cea583b143df6de8e3798f" args="" -->ExternalCommand</em>&nbsp;</td><td>
An external command . </td></tr>
<tr><td valign="top"><em><a class="anchor" name="1c7593d25567abda34c5ae309e5e27e98e3a304c4b0be68caffe787ae4ea7cf4"></a><!-- doxytag: member="Variable" ref="1c7593d25567abda34c5ae309e5e27e98e3a304c4b0be68caffe787ae4ea7cf4" args="" -->Variable</em>&nbsp;</td><td>
A variable. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="1c7593d25567abda34c5ae309e5e27e94251aa4bd4773717207d3cc95cf993d4"></a><!-- doxytag: member="Operator" ref="1c7593d25567abda34c5ae309e5e27e94251aa4bd4773717207d3cc95cf993d4" args="" -->Operator</em>&nbsp;</td><td>
An operator. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="a2ebe656b90ee7f42f681be2b3f4e39a"></a><!-- doxytag: member="QextScintillaLexerBatch::QextScintillaLexerBatch" ref="a2ebe656b90ee7f42f681be2b3f4e39a" args="(QObject *parent=0, const char *name=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QextScintillaLexerBatch::QextScintillaLexerBatch </td>
<td>(</td>
<td class="paramtype">QObject *&nbsp;</td>
<td class="paramname"> <em>parent</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&nbsp;</td>
<td class="paramname"> <em>name</em> = <code>0</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Construct a <a class="el" href="classQextScintillaLexerBatch.html">QextScintillaLexerBatch</a> with parent <em>parent</em> and name <em>name</em>. <em>parent</em> is typically the <a class="el" href="classQextScintilla.html">QextScintilla</a> instance.
</div>
</div><p>
<a class="anchor" name="07ec0d3cd82cdaec9dd201999a23b498"></a><!-- doxytag: member="QextScintillaLexerBatch::~QextScintillaLexerBatch" ref="07ec0d3cd82cdaec9dd201999a23b498" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual QextScintillaLexerBatch::~QextScintillaLexerBatch </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destroys the <a class="el" href="classQextScintillaLexerBatch.html">QextScintillaLexerBatch</a> instance.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="ce8f2eca661457993c6b334c297dd1e9"></a><!-- doxytag: member="QextScintillaLexerBatch::language" ref="ce8f2eca661457993c6b334c297dd1e9" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* QextScintillaLexerBatch::language </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the name of the language.
<p>
<p>
Implements <a class="el" href="classQextScintillaLexer.html#59c17e312dff4a9aa90b5e4c2a382218">QextScintillaLexer</a>.
</div>
</div><p>
<a class="anchor" name="ad3275fdafc700e7e14cd9d8beb6c589"></a><!-- doxytag: member="QextScintillaLexerBatch::lexer" ref="ad3275fdafc700e7e14cd9d8beb6c589" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* QextScintillaLexerBatch::lexer </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the name of the lexer. Some lexers support a number of languages.
<p>
Implements <a class="el" href="classQextScintillaLexer.html#9d63d331f148e68e5cd1dd6b9c3ad7d3">QextScintillaLexer</a>.
</div>
</div><p>
<a class="anchor" name="8b016e35c2e59956a2df1904ffa1e007"></a><!-- doxytag: member="QextScintillaLexerBatch::color" ref="8b016e35c2e59956a2df1904ffa1e007" args="(int style) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QColor QextScintillaLexerBatch::color </td>
<td>(</td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>style</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the foreground colour of the text for style number <em>style</em>.<p>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classQextScintillaLexerBatch.html#f383c2bfa30a7f5b7d3982949f910326">paper()</a> </dd></dl>
<p>
Reimplemented from <a class="el" href="classQextScintillaLexer.html#d829bf54912a1909556a517c09857974">QextScintillaLexer</a>.
</div>
</div><p>
<a class="anchor" name="d94fd24c1f3d156456d5018e6a202b23"></a><!-- doxytag: member="QextScintillaLexerBatch::eolFill" ref="d94fd24c1f3d156456d5018e6a202b23" args="(int style) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool QextScintillaLexerBatch::eolFill </td>
<td>(</td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>style</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the end-of-line fill for style number <em>style</em>.
<p>
<p>
Reimplemented from <a class="el" href="classQextScintillaLexer.html#9e1f5d6b36346910e45c433e22ad05ff">QextScintillaLexer</a>.
</div>
</div><p>
<a class="anchor" name="d23670696aad82a64c8879aea1532b12"></a><!-- doxytag: member="QextScintillaLexerBatch::font" ref="d23670696aad82a64c8879aea1532b12" args="(int style) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QFont QextScintillaLexerBatch::font </td>
<td>(</td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>style</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the font for style number <em>style</em>.
<p>
<p>
Reimplemented from <a class="el" href="classQextScintillaLexer.html#237079987354f031e8982b60a00b14e0">QextScintillaLexer</a>.
</div>
</div><p>
<a class="anchor" name="7b364c4a62ec33d88bf148e2a28212ef"></a><!-- doxytag: member="QextScintillaLexerBatch::keywords" ref="7b364c4a62ec33d88bf148e2a28212ef" args="(int set) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* QextScintillaLexerBatch::keywords </td>
<td>(</td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>set</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the set of keywords for the keyword set <em>set</em> recognised by the lexer as a space separated string.
<p>
Reimplemented from <a class="el" href="classQextScintillaLexer.html#00cc06fe8bce85318fd08890f5f614e4">QextScintillaLexer</a>.
</div>
</div><p>
<a class="anchor" name="03dca4c7289305a22a745db4d4c5e76f"></a><!-- doxytag: member="QextScintillaLexerBatch::description" ref="03dca4c7289305a22a745db4d4c5e76f" args="(int style) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString QextScintillaLexerBatch::description </td>
<td>(</td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>style</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the descriptive name for style number <em>style</em>. If the style is invalid for this language then QString::null is returned. This is intended to be used in user preference dialogs.
<p>
Implements <a class="el" href="classQextScintillaLexer.html#ddcd7beaeee21a59e4f4f5dee8edf0d8">QextScintillaLexer</a>.
</div>
</div><p>
<a class="anchor" name="f383c2bfa30a7f5b7d3982949f910326"></a><!-- doxytag: member="QextScintillaLexerBatch::paper" ref="f383c2bfa30a7f5b7d3982949f910326" args="(int style) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QColor QextScintillaLexerBatch::paper </td>
<td>(</td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>style</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the background colour of the text for style number <em>style</em>.<p>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classQextScintillaLexerBatch.html#8b016e35c2e59956a2df1904ffa1e007">color()</a> </dd></dl>
<p>
Reimplemented from <a class="el" href="classQextScintillaLexer.html#791c5d4bcab79828d394975344fae6db">QextScintillaLexer</a>.
</div>
</div><p>
<hr size="1"><address style="align: right;"><small>Generated on Thu Nov 30 09:32:31 2006 for QScintilla by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
</body>
</html>