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
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.CommandProcessor:
==========================================================================================================================================
|phoenix_title| **wx.CommandProcessor**
==========================================================================================================================================
:ref:`wx.CommandProcessor` is a class that maintains a history of Commands, with undo/redo functionality built-in.
Derive a new class from this if you want different behaviour.
.. seealso:: :ref:`CommandProcessor Overview <commandprocessor overview>`, :ref:`wx.Command`
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>CommandProcessor</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.CommandProcessor_inheritance.png" alt="Inheritance diagram of CommandProcessor" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.CommandProcessor.html" title="wx.CommandProcessor" alt="" coords="5,83,176,112"/> <area shape="rect" id="node2" href="wx.Object.html" title="wx.Object" alt="" coords="49,5,131,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.CommandProcessor.__init__` Constructor.
:meth:`~wx.CommandProcessor.CanRedo` Returns ``True`` if the currently-active command can be redone, ``False`` otherwise.
:meth:`~wx.CommandProcessor.CanUndo` Returns ``True`` if the currently-active command can be undone, ``False`` otherwise.
:meth:`~wx.CommandProcessor.ClearCommands` Deletes all commands in the list and sets the current command pointer to ``None``.
:meth:`~wx.CommandProcessor.GetCommands` Returns the list of commands.
:meth:`~wx.CommandProcessor.GetCurrentCommand` Returns the current command.
:meth:`~wx.CommandProcessor.GetEditMenu` Returns the edit menu associated with the command processor.
:meth:`~wx.CommandProcessor.GetMaxCommands` Returns the maximum number of commands that the command processor stores.
:meth:`~wx.CommandProcessor.GetRedoAccelerator` Returns the string that will be appended to the Redo menu item.
:meth:`~wx.CommandProcessor.GetRedoMenuLabel` Returns the string that will be shown for the redo menu item.
:meth:`~wx.CommandProcessor.GetUndoAccelerator` Returns the string that will be appended to the Undo menu item.
:meth:`~wx.CommandProcessor.GetUndoMenuLabel` Returns the string that will be shown for the undo menu item.
:meth:`~wx.CommandProcessor.Initialize` Initializes the command processor, setting the current command to the last in the list (if any), and updating the edit menu (if one has been specified).
:meth:`~wx.CommandProcessor.IsDirty` Returns a boolean value that indicates if changes have been made since the last save operation.
:meth:`~wx.CommandProcessor.MarkAsSaved` You must call this method whenever the project is saved if you plan to use :meth:`~CommandProcessor.IsDirty` .
:meth:`~wx.CommandProcessor.Redo` Executes (redoes) the current command (the command that has just been undone if any).
:meth:`~wx.CommandProcessor.SetEditMenu` Tells the command processor to update the Undo and Redo items on this menu as appropriate.
:meth:`~wx.CommandProcessor.SetMenuStrings` Sets the menu labels according to the currently set menu and the current command state.
:meth:`~wx.CommandProcessor.SetRedoAccelerator` Sets the string that will be appended to the Redo menu item.
:meth:`~wx.CommandProcessor.SetUndoAccelerator` Sets the string that will be appended to the Undo menu item.
:meth:`~wx.CommandProcessor.Store` Just store the command without executing it.
:meth:`~wx.CommandProcessor.Submit` Submits a new command to the command processor.
:meth:`~wx.CommandProcessor.Undo` Undoes the last command executed.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.CommandProcessor.Commands` See :meth:`~wx.CommandProcessor.GetCommands`
:attr:`~wx.CommandProcessor.CurrentCommand` See :meth:`~wx.CommandProcessor.GetCurrentCommand`
:attr:`~wx.CommandProcessor.EditMenu` See :meth:`~wx.CommandProcessor.GetEditMenu` and :meth:`~wx.CommandProcessor.SetEditMenu`
:attr:`~wx.CommandProcessor.MaxCommands` See :meth:`~wx.CommandProcessor.GetMaxCommands`
:attr:`~wx.CommandProcessor.RedoAccelerator` See :meth:`~wx.CommandProcessor.GetRedoAccelerator` and :meth:`~wx.CommandProcessor.SetRedoAccelerator`
:attr:`~wx.CommandProcessor.RedoMenuLabel` See :meth:`~wx.CommandProcessor.GetRedoMenuLabel`
:attr:`~wx.CommandProcessor.UndoAccelerator` See :meth:`~wx.CommandProcessor.GetUndoAccelerator` and :meth:`~wx.CommandProcessor.SetUndoAccelerator`
:attr:`~wx.CommandProcessor.UndoMenuLabel` See :meth:`~wx.CommandProcessor.GetUndoMenuLabel`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.CommandProcessor(Object)
**Possible constructors**::
CommandProcessor(maxCommands=-1)
CommandProcessor is a class that maintains a history of Commands,
with undo/redo functionality built-in.
.. method:: __init__(self, maxCommands=-1)
Constructor.
:param `maxCommands`: May be set to a positive integer to limit the number of commands stored to it, otherwise (and by default) the list of commands can grow arbitrarily.
:type `maxCommands`: int
.. method:: CanRedo(self)
Returns ``True`` if the currently-active command can be redone, ``False`` otherwise.
:rtype: `bool`
.. method:: CanUndo(self)
Returns ``True`` if the currently-active command can be undone, ``False`` otherwise.
:rtype: `bool`
.. method:: ClearCommands(self)
Deletes all commands in the list and sets the current command pointer to ``None``.
.. method:: GetCommands(self)
Returns the list of commands.
:rtype: :ref:`CommandList`
.. method:: GetCurrentCommand(self)
Returns the current command.
:rtype: :ref:`wx.Command`
.. method:: GetEditMenu(self)
Returns the edit menu associated with the command processor.
:rtype: :ref:`wx.Menu`
.. method:: GetMaxCommands(self)
Returns the maximum number of commands that the command processor stores.
:rtype: `int`
.. method:: GetRedoAccelerator(self)
Returns the string that will be appended to the Redo menu item.
:rtype: `string`
.. method:: GetRedoMenuLabel(self)
Returns the string that will be shown for the redo menu item.
:rtype: `string`
.. method:: GetUndoAccelerator(self)
Returns the string that will be appended to the Undo menu item.
:rtype: `string`
.. method:: GetUndoMenuLabel(self)
Returns the string that will be shown for the undo menu item.
:rtype: `string`
.. method:: Initialize(self)
Initializes the command processor, setting the current command to the last in the list (if any), and updating the edit menu (if one has been specified).
.. method:: IsDirty(self)
Returns a boolean value that indicates if changes have been made since the last save operation.
This only works if :meth:`MarkAsSaved` is called whenever the project is saved.
:rtype: `bool`
.. method:: MarkAsSaved(self)
You must call this method whenever the project is saved if you plan to use :meth:`IsDirty` .
.. method:: Redo(self)
Executes (redoes) the current command (the command that has just been undone if any).
:rtype: `bool`
.. method:: SetEditMenu(self, menu)
Tells the command processor to update the Undo and Redo items on this menu as appropriate.
Set this to ``None`` if the menu is about to be destroyed and command operations may still be performed, or the command processor may try to access an invalid pointer.
:param `menu`:
:type `menu`: wx.Menu
.. method:: SetMenuStrings(self)
Sets the menu labels according to the currently set menu and the current command state.
.. method:: SetRedoAccelerator(self, accel)
Sets the string that will be appended to the Redo menu item.
:param `accel`:
:type `accel`: string
.. method:: SetUndoAccelerator(self, accel)
Sets the string that will be appended to the Undo menu item.
:param `accel`:
:type `accel`: string
.. method:: Store(self, command)
Just store the command without executing it.
The command is stored in the history list, and the associated edit menu (if any) updated appropriately.
:param `command`:
:type `command`: wx.Command
.. method:: Submit(self, command, storeIt=True)
Submits a new command to the command processor.
The command processor calls :meth:`wx.Command.Do` to execute the command; if it succeeds, the command is stored in the history list, and the associated edit menu (if any) updated appropriately. If it fails, the command is deleted immediately. Once :meth:`Submit` has been called, the passed command should not be deleted directly by the application.
:param `command`: The command to submit
:type `command`: wx.Command
:param `storeIt`: Indicates whether the successful command should be stored in the history list.
:type `storeIt`: bool
:rtype: `bool`
.. method:: Undo(self)
Undoes the last command executed.
:rtype: `bool`
.. attribute:: Commands
See :meth:`~wx.CommandProcessor.GetCommands`
.. attribute:: CurrentCommand
See :meth:`~wx.CommandProcessor.GetCurrentCommand`
.. attribute:: EditMenu
See :meth:`~wx.CommandProcessor.GetEditMenu` and :meth:`~wx.CommandProcessor.SetEditMenu`
.. attribute:: MaxCommands
See :meth:`~wx.CommandProcessor.GetMaxCommands`
.. attribute:: RedoAccelerator
See :meth:`~wx.CommandProcessor.GetRedoAccelerator` and :meth:`~wx.CommandProcessor.SetRedoAccelerator`
.. attribute:: RedoMenuLabel
See :meth:`~wx.CommandProcessor.GetRedoMenuLabel`
.. attribute:: UndoAccelerator
See :meth:`~wx.CommandProcessor.GetUndoAccelerator` and :meth:`~wx.CommandProcessor.SetUndoAccelerator`
.. attribute:: UndoMenuLabel
See :meth:`~wx.CommandProcessor.GetUndoMenuLabel`
|
