summaryrefslogtreecommitdiffstats
path: root/doc/html/classQextScintillaMacro.html
blob: d0f4db8b4959764c2ef96cec0d71b27e1d5122a7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
<!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>