diff options
Diffstat (limited to 'doc/en/classQextScintillaLexerProperties.html')
| -rw-r--r-- | doc/en/classQextScintillaLexerProperties.html | 450 |
1 files changed, 450 insertions, 0 deletions
diff --git a/doc/en/classQextScintillaLexerProperties.html b/doc/en/classQextScintillaLexerProperties.html new file mode 100644 index 0000000..94f274b --- /dev/null +++ b/doc/en/classQextScintillaLexerProperties.html @@ -0,0 +1,450 @@ +<!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>TQScintilla: QextScintillaLexerProperties 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 Page</span></a></li> + <li id="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="pages.html"><span>Related Pages</span></a></li> + </ul></div> +<div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul></div> +<h1>QextScintillaLexerProperties Class Reference</h1><!-- doxytag: class="QextScintillaLexerProperties" --><!-- doxytag: inherits="QextScintillaLexer" -->The <a class="el" href="classQextScintillaLexerProperties.html">QextScintillaLexerProperties</a> class encapsulates the Scintilla Properties lexer. +<a href="#_details">More...</a> +<p> +<code>#include <qextscintillalexerproperties.h></code> +<p> +Inherits <a class="el" href="classQextScintillaLexer.html">QextScintillaLexer</a>. +<p> +<a href="classQextScintillaLexerProperties-members.html">List of all members.</a><h2>Public Types</h2> +<ul> +<li><a class="el" href="classQextScintillaLexerProperties.html#ffbf836ee1c908e09f7b59bbea272275dc12c096ec8121aad3994377922d0b37">Default</a> = 0 +<li><a class="el" href="classQextScintillaLexerProperties.html#ffbf836ee1c908e09f7b59bbea272275ec0ef177625174b98e0d7984d7fc70fc">Comment</a> = 1 +<li><a class="el" href="classQextScintillaLexerProperties.html#ffbf836ee1c908e09f7b59bbea272275e54e379d346512d24c43222c626e2345">Section</a> = 2 +<li><a class="el" href="classQextScintillaLexerProperties.html#ffbf836ee1c908e09f7b59bbea272275736a3b70e16d94a60cda8ce4b39104d4">Assignment</a> = 3 +<li><a class="el" href="classQextScintillaLexerProperties.html#ffbf836ee1c908e09f7b59bbea272275af2af2c3cb1ba1ce6b011e10fbeecc6b">DefaultValue</a> = 4 +<li>enum { <br> + <a class="el" href="classQextScintillaLexerProperties.html#ffbf836ee1c908e09f7b59bbea272275dc12c096ec8121aad3994377922d0b37">Default</a> = 0, +<a class="el" href="classQextScintillaLexerProperties.html#ffbf836ee1c908e09f7b59bbea272275ec0ef177625174b98e0d7984d7fc70fc">Comment</a> = 1, +<a class="el" href="classQextScintillaLexerProperties.html#ffbf836ee1c908e09f7b59bbea272275e54e379d346512d24c43222c626e2345">Section</a> = 2, +<br> + <a class="el" href="classQextScintillaLexerProperties.html#ffbf836ee1c908e09f7b59bbea272275736a3b70e16d94a60cda8ce4b39104d4">Assignment</a> = 3, +<a class="el" href="classQextScintillaLexerProperties.html#ffbf836ee1c908e09f7b59bbea272275af2af2c3cb1ba1ce6b011e10fbeecc6b">DefaultValue</a> = 4 +<br> + } +</ul> +<h2>Public Slots</h2> +<ul> +<li>virtual void <a class="el" href="classQextScintillaLexerProperties.html#bc8c42d3facfceaa7c5eaeddf7e4285c">setFoldCompact</a> (bool fold) +</ul> +<h2>Public Member Functions</h2> +<ul> +<li><a class="el" href="classQextScintillaLexerProperties.html#be0f77d8beaf8dabe3d99db45f056d7b">QextScintillaLexerProperties</a> (TQObject *parent=0, const char *name=0) +<li>virtual <a class="el" href="classQextScintillaLexerProperties.html#aa826d270e365f358c84a027bee3d167">~QextScintillaLexerProperties</a> () +<li>const char * <a class="el" href="classQextScintillaLexerProperties.html#436334f1bed5891cfbf3f9efd45e1298">language</a> () const +<li>const char * <a class="el" href="classQextScintillaLexerProperties.html#de484f827e973c4a10ed8ffee30ee6a0">lexer</a> () const +<li><a class="anchor" name="a6a24c34536209cfa71381ed11850977"></a><!-- doxytag: member="QextScintillaLexerProperties::wordCharacters" ref="a6a24c34536209cfa71381ed11850977" args="() const " --> +const char * <b>wordCharacters</b> () const +<li>TQColor <a class="el" href="classQextScintillaLexerProperties.html#29f362422452175f80aba4a0a30e91d8">color</a> (int style) const +<li>bool <a class="el" href="classQextScintillaLexerProperties.html#b673e4f3569b9b5002a7e5fd75c72dae">eolFill</a> (int style) const +<li>TQFont <a class="el" href="classQextScintillaLexerProperties.html#7070a1985d0a6f3aec0e2e06e39a3eba">font</a> (int style) const +<li>TQString <a class="el" href="classQextScintillaLexerProperties.html#419785e6507ee675e2bc06c1fc455806">description</a> (int style) const +<li>TQColor <a class="el" href="classQextScintillaLexerProperties.html#3d6a97fbd72128254ce96c4f98e8f121">paper</a> (int style) const +<li>void <a class="el" href="classQextScintillaLexerProperties.html#abf5e5dfb111502bd3b96a8073924746">refreshProperties</a> () +<li>bool <a class="el" href="classQextScintillaLexerProperties.html#fad51b4b63aac4551f5bc5fe57b400c9">foldCompact</a> () const +</ul> +<h2>Protected Member Functions</h2> +<ul> +<li>bool <a class="el" href="classQextScintillaLexerProperties.html#eaa2f7a219cd9c2ca923b2595b268c35">readProperties</a> (TQSettings &qs, const TQString &prefix) +<li>bool <a class="el" href="classQextScintillaLexerProperties.html#cc1b8d0916329dab170624db1505b2a6">writeProperties</a> (TQSettings &qs, const TQString &prefix) const +</ul> +<hr><a name="_details"></a><h2>Detailed Description</h2> +The <a class="el" href="classQextScintillaLexerProperties.html">QextScintillaLexerProperties</a> class encapsulates the Scintilla Properties lexer. +<p> +<hr><h2>Member Enumeration Documentation</h2> +<a class="anchor" name="ffbf836ee1c908e09f7b59bbea272275"></a><!-- doxytag: member="QextScintillaLexerProperties::@41" ref="ffbf836ee1c908e09f7b59bbea272275" 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 Properties 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="ffbf836ee1c908e09f7b59bbea272275dc12c096ec8121aad3994377922d0b37"></a><!-- doxytag: member="Default" ref="ffbf836ee1c908e09f7b59bbea272275dc12c096ec8121aad3994377922d0b37" args="" -->Default</em> </td><td> +The default. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="ffbf836ee1c908e09f7b59bbea272275ec0ef177625174b98e0d7984d7fc70fc"></a><!-- doxytag: member="Comment" ref="ffbf836ee1c908e09f7b59bbea272275ec0ef177625174b98e0d7984d7fc70fc" args="" -->Comment</em> </td><td> +A comment. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="ffbf836ee1c908e09f7b59bbea272275e54e379d346512d24c43222c626e2345"></a><!-- doxytag: member="Section" ref="ffbf836ee1c908e09f7b59bbea272275e54e379d346512d24c43222c626e2345" args="" -->Section</em> </td><td> +A section. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="ffbf836ee1c908e09f7b59bbea272275736a3b70e16d94a60cda8ce4b39104d4"></a><!-- doxytag: member="Assignment" ref="ffbf836ee1c908e09f7b59bbea272275736a3b70e16d94a60cda8ce4b39104d4" args="" -->Assignment</em> </td><td> +An assignment operator. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="ffbf836ee1c908e09f7b59bbea272275af2af2c3cb1ba1ce6b011e10fbeecc6b"></a><!-- doxytag: member="DefaultValue" ref="ffbf836ee1c908e09f7b59bbea272275af2af2c3cb1ba1ce6b011e10fbeecc6b" args="" -->DefaultValue</em> </td><td> +A default value. </td></tr> +</table> +</dl> + +</div> +</div><p> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="be0f77d8beaf8dabe3d99db45f056d7b"></a><!-- doxytag: member="QextScintillaLexerProperties::QextScintillaLexerProperties" ref="be0f77d8beaf8dabe3d99db45f056d7b" args="(TQObject *parent=0, const char *name=0)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QextScintillaLexerProperties::QextScintillaLexerProperties </td> + <td>(</td> + <td class="paramtype">TQObject * </td> + <td class="paramname"> <em>parent</em> = <code>0</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"> <em>name</em> = <code>0</code></td><td> </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="classQextScintillaLexerProperties.html">QextScintillaLexerProperties</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="aa826d270e365f358c84a027bee3d167"></a><!-- doxytag: member="QextScintillaLexerProperties::~QextScintillaLexerProperties" ref="aa826d270e365f358c84a027bee3d167" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual QextScintillaLexerProperties::~QextScintillaLexerProperties </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td width="100%"><code> [virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Destroys the <a class="el" href="classQextScintillaLexerProperties.html">QextScintillaLexerProperties</a> instance. +<p> + +</div> +</div><p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="436334f1bed5891cfbf3f9efd45e1298"></a><!-- doxytag: member="QextScintillaLexerProperties::language" ref="436334f1bed5891cfbf3f9efd45e1298" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const char* QextScintillaLexerProperties::language </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </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="de484f827e973c4a10ed8ffee30ee6a0"></a><!-- doxytag: member="QextScintillaLexerProperties::lexer" ref="de484f827e973c4a10ed8ffee30ee6a0" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const char* QextScintillaLexerProperties::lexer </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </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="29f362422452175f80aba4a0a30e91d8"></a><!-- doxytag: member="QextScintillaLexerProperties::color" ref="29f362422452175f80aba4a0a30e91d8" args="(int style) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">TQColor QextScintillaLexerProperties::color </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"> <em>style</em> </td> + <td> ) </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="classQextScintillaLexerProperties.html#3d6a97fbd72128254ce96c4f98e8f121">paper()</a> </dd></dl> + +<p> +Reimplemented from <a class="el" href="classQextScintillaLexer.html#d829bf54912a1909556a517c09857974">QextScintillaLexer</a>. +</div> +</div><p> +<a class="anchor" name="b673e4f3569b9b5002a7e5fd75c72dae"></a><!-- doxytag: member="QextScintillaLexerProperties::eolFill" ref="b673e4f3569b9b5002a7e5fd75c72dae" args="(int style) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool QextScintillaLexerProperties::eolFill </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"> <em>style</em> </td> + <td> ) </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="7070a1985d0a6f3aec0e2e06e39a3eba"></a><!-- doxytag: member="QextScintillaLexerProperties::font" ref="7070a1985d0a6f3aec0e2e06e39a3eba" args="(int style) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">TQFont QextScintillaLexerProperties::font </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"> <em>style</em> </td> + <td> ) </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="419785e6507ee675e2bc06c1fc455806"></a><!-- doxytag: member="QextScintillaLexerProperties::description" ref="419785e6507ee675e2bc06c1fc455806" args="(int style) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">TQString QextScintillaLexerProperties::description </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"> <em>style</em> </td> + <td> ) </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 TQString() 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="3d6a97fbd72128254ce96c4f98e8f121"></a><!-- doxytag: member="QextScintillaLexerProperties::paper" ref="3d6a97fbd72128254ce96c4f98e8f121" args="(int style) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">TQColor QextScintillaLexerProperties::paper </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"> <em>style</em> </td> + <td> ) </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="classQextScintillaLexerProperties.html#29f362422452175f80aba4a0a30e91d8">color()</a> </dd></dl> + +<p> +Reimplemented from <a class="el" href="classQextScintillaLexer.html#791c5d4bcab79828d394975344fae6db">QextScintillaLexer</a>. +</div> +</div><p> +<a class="anchor" name="abf5e5dfb111502bd3b96a8073924746"></a><!-- doxytag: member="QextScintillaLexerProperties::refreshProperties" ref="abf5e5dfb111502bd3b96a8073924746" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QextScintillaLexerProperties::refreshProperties </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td width="100%"><code> [virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Causes all properties to be refreshed by emitting the <a class="el" href="classQextScintillaLexer.html#f320f847889bb054befdb43d0739b5cf">propertyChanged()</a> signal as required. +<p> +Reimplemented from <a class="el" href="classQextScintillaLexer.html#8c606f8763ced32f56d4a72d089a50ef">QextScintillaLexer</a>. +</div> +</div><p> +<a class="anchor" name="fad51b4b63aac4551f5bc5fe57b400c9"></a><!-- doxytag: member="QextScintillaLexerProperties::foldCompact" ref="fad51b4b63aac4551f5bc5fe57b400c9" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool QextScintillaLexerProperties::foldCompact </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td width="100%"> const</td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns TRUE if trailing blank lines are included in a fold block.<p> +<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classQextScintillaLexerProperties.html#bc8c42d3facfceaa7c5eaeddf7e4285c">setFoldCompact()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="bc8c42d3facfceaa7c5eaeddf7e4285c"></a><!-- doxytag: member="QextScintillaLexerProperties::setFoldCompact" ref="bc8c42d3facfceaa7c5eaeddf7e4285c" args="(bool fold)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void QextScintillaLexerProperties::setFoldCompact </td> + <td>(</td> + <td class="paramtype">bool </td> + <td class="paramname"> <em>fold</em> </td> + <td> ) </td> + <td width="100%"><code> [virtual, slot]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +If <em>fold</em> is TRUE then trailing blank lines are included in a fold block. The default is TRUE.<p> +<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classQextScintillaLexerProperties.html#fad51b4b63aac4551f5bc5fe57b400c9">foldCompact()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="eaa2f7a219cd9c2ca923b2595b268c35"></a><!-- doxytag: member="QextScintillaLexerProperties::readProperties" ref="eaa2f7a219cd9c2ca923b2595b268c35" args="(TQSettings &qs, const TQString &prefix)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool QextScintillaLexerProperties::readProperties </td> + <td>(</td> + <td class="paramtype">TQSettings & </td> + <td class="paramname"> <em>qs</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const TQString & </td> + <td class="paramname"> <em>prefix</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td width="100%"><code> [protected, virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +The lexer's properties are read from the settings <em>qs</em>. <em>prefix</em> (which has a trailing '/') should be used as a prefix to the key of each setting. TRUE is returned if there is no error.<p> +<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classQextScintillaLexerProperties.html#cc1b8d0916329dab170624db1505b2a6">writeProperties()</a> </dd></dl> + +<p> +Reimplemented from <a class="el" href="classQextScintillaLexer.html#5c0c72a54932c47687584e2cde90574a">QextScintillaLexer</a>. +</div> +</div><p> +<a class="anchor" name="cc1b8d0916329dab170624db1505b2a6"></a><!-- doxytag: member="QextScintillaLexerProperties::writeProperties" ref="cc1b8d0916329dab170624db1505b2a6" args="(TQSettings &qs, const TQString &prefix) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool QextScintillaLexerProperties::writeProperties </td> + <td>(</td> + <td class="paramtype">TQSettings & </td> + <td class="paramname"> <em>qs</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const TQString & </td> + <td class="paramname"> <em>prefix</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td width="100%"> const<code> [protected, virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +The lexer's properties are written to the settings <em>qs</em>. <em>prefix</em> (which has a trailing '/') should be used as a prefix to the key of each setting. TRUE is returned if there is no error.<p> +<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classQextScintillaLexerProperties.html#eaa2f7a219cd9c2ca923b2595b268c35">readProperties()</a> </dd></dl> + +<p> +Reimplemented from <a class="el" href="classQextScintillaLexer.html#69d35dbbba2530a185de901e9fa12a18">QextScintillaLexer</a>. +</div> +</div><p> +<hr size="1"><address style="align: right;"><small>Generated on Thu Nov 30 09:32:31 2006 for TQScintilla by +<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> |