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/en/classQextScintillaMacro.html

268 lines
11 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>TQScintilla: QextScintillaMacro 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>QextScintillaMacro Class Reference</h1><!-- doxytag: class="QextScintillaMacro" -->The <a class="el" href="classQextScintillaMacro.html">QextScintillaMacro</a> class represents a sequence of recordable editor commands.
<a href="#_details">More...</a>
<p>
<code>#include &lt;qextscintillamacro.h&gt;</code>
<p>
<a href="classQextScintillaMacro-members.html">List of all members.</a><h2>Public Slots</h2>
<ul>
<li>virtual void <a class="el" href="classQextScintillaMacro.html#23408394a213fa7fcd5b7cab2a060c27">play</a> ()
<li>virtual void <a class="el" href="classQextScintillaMacro.html#439f6576433d4633693139192ae9bc98">startRecording</a> ()
<li>virtual void <a class="el" href="classQextScintillaMacro.html#97005cdb33759ffe2b82a616d82046f5">endRecording</a> ()
</ul>
<h2>Public Member Functions</h2>
<ul>
<li><a class="el" href="classQextScintillaMacro.html#05bf326d2ee9df1b319af8f243cab7f2">QextScintillaMacro</a> (<a class="el" href="classQextScintilla.html">QextScintilla</a> *parent, const char *name=0)
<li><a class="el" href="classQextScintillaMacro.html#f7a13a836fe98c2cdef8c0e767436b74">QextScintillaMacro</a> (const TQCString &amp;asc, <a class="el" href="classQextScintilla.html">QextScintilla</a> *parent, const char *name=0)
<li>virtual <a class="el" href="classQextScintillaMacro.html#d20a0db0b92b233a63f72e43c616ce3b">~QextScintillaMacro</a> ()
<li>void <a class="el" href="classQextScintillaMacro.html#e79848bbd1b6c87430e6401e71a9cf1b">clear</a> ()
<li>bool <a class="el" href="classQextScintillaMacro.html#22ba5818bbcc5562c5fd5a5332e8238f">load</a> (const TQCString &amp;asc)
<li>TQCString <a class="el" href="classQextScintillaMacro.html#dbdc69113895d3f07b0bdb1f3f075498">save</a> () const
</ul>
<h2>Classes</h2>
<ul>
<li>struct <b>Macro</b>
</ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The <a class="el" href="classQextScintillaMacro.html">QextScintillaMacro</a> class represents a sequence of recordable editor commands.
<p>
Methods are provided to convert convert a macro to and from a textual representation so that they can be easily written to and read from permanent storage.
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="05bf326d2ee9df1b319af8f243cab7f2"></a><!-- doxytag: member="QextScintillaMacro::QextScintillaMacro" ref="05bf326d2ee9df1b319af8f243cab7f2" args="(QextScintilla *parent, const char *name=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QextScintillaMacro::QextScintillaMacro </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classQextScintilla.html">QextScintilla</a> *&nbsp;</td>
<td class="paramname"> <em>parent</em>, </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="classQextScintillaMacro.html">QextScintillaMacro</a> with parent <em>parent</em> and name <em>name</em>.
</div>
</div><p>
<a class="anchor" name="f7a13a836fe98c2cdef8c0e767436b74"></a><!-- doxytag: member="QextScintillaMacro::QextScintillaMacro" ref="f7a13a836fe98c2cdef8c0e767436b74" args="(const TQCString &amp;asc, QextScintilla *parent, const char *name=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QextScintillaMacro::QextScintillaMacro </td>
<td>(</td>
<td class="paramtype">const TQCString &amp;&nbsp;</td>
<td class="paramname"> <em>asc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classQextScintilla.html">QextScintilla</a> *&nbsp;</td>
<td class="paramname"> <em>parent</em>, </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="classQextScintillaMacro.html">QextScintillaMacro</a> from the printable ASCII representation <em>asc</em>, with parent <em>parent</em> and name <em>name</em>.
</div>
</div><p>
<a class="anchor" name="d20a0db0b92b233a63f72e43c616ce3b"></a><!-- doxytag: member="QextScintillaMacro::~QextScintillaMacro" ref="d20a0db0b92b233a63f72e43c616ce3b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual QextScintillaMacro::~QextScintillaMacro </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>
Destroy the <a class="el" href="classQextScintillaMacro.html">QextScintillaMacro</a> instance.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="e79848bbd1b6c87430e6401e71a9cf1b"></a><!-- doxytag: member="QextScintillaMacro::clear" ref="e79848bbd1b6c87430e6401e71a9cf1b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void QextScintillaMacro::clear </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Clear the contents of the macro.
<p>
</div>
</div><p>
<a class="anchor" name="22ba5818bbcc5562c5fd5a5332e8238f"></a><!-- doxytag: member="QextScintillaMacro::load" ref="22ba5818bbcc5562c5fd5a5332e8238f" args="(const TQCString &amp;asc)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool QextScintillaMacro::load </td>
<td>(</td>
<td class="paramtype">const TQCString &amp;&nbsp;</td>
<td class="paramname"> <em>asc</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Load the macro from the printable ASCII representation <em>asc</em>. Returns TRUE if there was no error.<p>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classQextScintillaMacro.html#dbdc69113895d3f07b0bdb1f3f075498">save()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="dbdc69113895d3f07b0bdb1f3f075498"></a><!-- doxytag: member="QextScintillaMacro::save" ref="dbdc69113895d3f07b0bdb1f3f075498" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TQCString QextScintillaMacro::save </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return a printable ASCII representation of the macro. It is guaranteed that only printable ASCII characters are used and that double quote characters will not be used.<p>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classQextScintillaMacro.html#22ba5818bbcc5562c5fd5a5332e8238f">load()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="23408394a213fa7fcd5b7cab2a060c27"></a><!-- doxytag: member="QextScintillaMacro::play" ref="23408394a213fa7fcd5b7cab2a060c27" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void QextScintillaMacro::play </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [virtual, slot]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Play the macro.
<p>
</div>
</div><p>
<a class="anchor" name="439f6576433d4633693139192ae9bc98"></a><!-- doxytag: member="QextScintillaMacro::startRecording" ref="439f6576433d4633693139192ae9bc98" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void QextScintillaMacro::startRecording </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [virtual, slot]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Start recording user commands and add them to the macro.
<p>
</div>
</div><p>
<a class="anchor" name="97005cdb33759ffe2b82a616d82046f5"></a><!-- doxytag: member="QextScintillaMacro::endRecording" ref="97005cdb33759ffe2b82a616d82046f5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void QextScintillaMacro::endRecording </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [virtual, slot]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Stop recording user commands.
<p>
</div>
</div><p>
<hr size="1"><address style="align: right;"><small>Generated on Thu Nov 30 09:32:31 2006 for TQScintilla 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>