diff options
Diffstat (limited to 'doc/html/classQextScintillaAPIs.html')
| -rw-r--r-- | doc/html/classQextScintillaAPIs.html | 151 |
1 files changed, 151 insertions, 0 deletions
diff --git a/doc/html/classQextScintillaAPIs.html b/doc/html/classQextScintillaAPIs.html new file mode 100644 index 0000000..9efdffc --- /dev/null +++ b/doc/html/classQextScintillaAPIs.html @@ -0,0 +1,151 @@ +<!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: QextScintillaAPIs 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>QextScintillaAPIs Class Reference</h1><!-- doxytag: class="QextScintillaAPIs" -->The <a class="el" href="classQextScintillaAPIs.html">QextScintillaAPIs</a> class represents the textual API information used in call tips and for auto-completion. +<a href="#_details">More...</a> +<p> +<code>#include <qextscintillaapis.h></code> +<p> +<a href="classQextScintillaAPIs-members.html">List of all members.</a><h2>Public Member Functions</h2> +<ul> +<li><a class="el" href="classQextScintillaAPIs.html#37e89c8f886f627bfffe8c7497c687b4">QextScintillaAPIs</a> () +<li><a class="el" href="classQextScintillaAPIs.html#25c4b5eec176538900c3fb0028e47a80">~QextScintillaAPIs</a> () +<li>void <a class="el" href="classQextScintillaAPIs.html#b443486e48c91ae4878a21d30b242d73">add</a> (const QString &entry) +<li>bool <a class="el" href="classQextScintillaAPIs.html#5d424a6c31b3f91739977a99103c3415">load</a> (const QString &fname) +<li>void <a class="el" href="classQextScintillaAPIs.html#f316a9a0e9d1bde57916c09fbd362918">clear</a> () +</ul> +<hr><a name="_details"></a><h2>Detailed Description</h2> +The <a class="el" href="classQextScintillaAPIs.html">QextScintillaAPIs</a> class represents the textual API information used in call tips and for auto-completion. +<p> +API information is read from one or more files. Each API function is described by a single line of text comprising the function's name, followed by the function's optional comma separated parameters enclosed in parenthesis, and finally followed by optional explanatory text.<p> +A function name may be followed by a `?' and a number. The number is used by auto-completion to display a registered QPixmap with the function name.<p> +All function names are used by auto-completion, but only those that include function parameters are used in call tips. +<p> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="37e89c8f886f627bfffe8c7497c687b4"></a><!-- doxytag: member="QextScintillaAPIs::QextScintillaAPIs" ref="37e89c8f886f627bfffe8c7497c687b4" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QextScintillaAPIs::QextScintillaAPIs </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td width="100%"></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Constructs a <a class="el" href="classQextScintillaAPIs.html">QextScintillaAPIs</a> instance. +<p> + +</div> +</div><p> +<a class="anchor" name="25c4b5eec176538900c3fb0028e47a80"></a><!-- doxytag: member="QextScintillaAPIs::~QextScintillaAPIs" ref="25c4b5eec176538900c3fb0028e47a80" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QextScintillaAPIs::~QextScintillaAPIs </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td width="100%"></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Destroys the <a class="el" href="classQextScintillaAPIs.html">QextScintillaAPIs</a> instance. +<p> + +</div> +</div><p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="b443486e48c91ae4878a21d30b242d73"></a><!-- doxytag: member="QextScintillaAPIs::add" ref="b443486e48c91ae4878a21d30b242d73" args="(const QString &entry)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QextScintillaAPIs::add </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>entry</em> </td> + <td> ) </td> + <td width="100%"></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Add the single API entry <em>entry</em> to the current set. +<p> + +</div> +</div><p> +<a class="anchor" name="5d424a6c31b3f91739977a99103c3415"></a><!-- doxytag: member="QextScintillaAPIs::load" ref="5d424a6c31b3f91739977a99103c3415" args="(const QString &fname)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool QextScintillaAPIs::load </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>fname</em> </td> + <td> ) </td> + <td width="100%"></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Load the API information from the file named <em>fname</em>, adding it to the current set. Returns TRUE if successful, otherwise FALSE. +</div> +</div><p> +<a class="anchor" name="f316a9a0e9d1bde57916c09fbd362918"></a><!-- doxytag: member="QextScintillaAPIs::clear" ref="f316a9a0e9d1bde57916c09fbd362918" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QextScintillaAPIs::clear </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td width="100%"></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Deletes all API information. +<p> + +</div> +</div><p> +<hr size="1"><address style="align: right;"><small>Generated on Thu Nov 30 09:32:31 2006 for QScintilla 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> |