]>
Commit | Line | Data |
---|---|---|
23324ae1 | 1 | ///////////////////////////////////////////////////////////////////////////// |
7afd2b58 JS |
2 | // Name: wx/richtext/richtextctrl.h |
3 | // Purpose: A rich edit control | |
4 | // Author: Julian Smart | |
5 | // Modified by: | |
6 | // Created: 2005-09-30 | |
23324ae1 | 7 | // RCS-ID: $Id$ |
7afd2b58 | 8 | // Copyright: (c) Julian Smart |
526954c5 | 9 | // Licence: wxWindows licence |
23324ae1 FM |
10 | ///////////////////////////////////////////////////////////////////////////// |
11 | ||
7afd2b58 JS |
12 | /* |
13 | * Styles and flags | |
14 | */ | |
15 | ||
23324ae1 | 16 | /** |
7afd2b58 JS |
17 | Styles |
18 | */ | |
7c913512 | 19 | |
7afd2b58 JS |
20 | #define wxRE_READONLY 0x0010 |
21 | #define wxRE_MULTILINE 0x0020 | |
22 | #define wxRE_CENTRE_CARET 0x8000 | |
23 | #define wxRE_CENTER_CARET wxRE_CENTRE_CARET | |
7c913512 | 24 | |
7afd2b58 JS |
25 | /** |
26 | Flags | |
27 | */ | |
9e7ad1ca | 28 | |
7afd2b58 JS |
29 | #define wxRICHTEXT_SHIFT_DOWN 0x01 |
30 | #define wxRICHTEXT_CTRL_DOWN 0x02 | |
31 | #define wxRICHTEXT_ALT_DOWN 0x04 | |
32 | ||
33 | /** | |
34 | Extra flags | |
35 | */ | |
36 | ||
37 | // Don't draw guide lines around boxes and tables | |
38 | #define wxRICHTEXT_EX_NO_GUIDELINES 0x00000100 | |
39 | ||
40 | ||
41 | /* | |
42 | Defaults | |
23324ae1 | 43 | */ |
7afd2b58 JS |
44 | |
45 | #define wxRICHTEXT_DEFAULT_OVERALL_SIZE wxSize(-1, -1) | |
46 | #define wxRICHTEXT_DEFAULT_IMAGE_SIZE wxSize(80, 80) | |
47 | #define wxRICHTEXT_DEFAULT_SPACING 3 | |
48 | #define wxRICHTEXT_DEFAULT_MARGIN 3 | |
49 | #define wxRICHTEXT_DEFAULT_UNFOCUSSED_BACKGROUND wxColour(175, 175, 175) | |
50 | #define wxRICHTEXT_DEFAULT_FOCUSSED_BACKGROUND wxColour(140, 140, 140) | |
51 | #define wxRICHTEXT_DEFAULT_UNSELECTED_BACKGROUND wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE) | |
52 | #define wxRICHTEXT_DEFAULT_TYPE_COLOUR wxColour(0, 0, 200) | |
53 | #define wxRICHTEXT_DEFAULT_FOCUS_RECT_COLOUR wxColour(100, 80, 80) | |
54 | #define wxRICHTEXT_DEFAULT_CARET_WIDTH 2 | |
55 | // Minimum buffer size before delayed layout kicks in | |
56 | #define wxRICHTEXT_DEFAULT_DELAYED_LAYOUT_THRESHOLD 20000 | |
57 | // Milliseconds before layout occurs after resize | |
58 | #define wxRICHTEXT_DEFAULT_LAYOUT_INTERVAL 50 | |
59 | ||
60 | /* Identifiers | |
61 | */ | |
62 | #define wxID_RICHTEXT_PROPERTIES1 (wxID_HIGHEST + 1) | |
63 | #define wxID_RICHTEXT_PROPERTIES2 (wxID_HIGHEST + 2) | |
64 | #define wxID_RICHTEXT_PROPERTIES3 (wxID_HIGHEST + 3) | |
65 | ||
66 | /* | |
67 | Normal selection occurs initially and as user drags within one container. | |
68 | Common ancestor selection occurs when the user starts dragging across containers | |
69 | that have a common ancestor, for example the cells in a table. | |
70 | */ | |
71 | ||
72 | enum wxRichTextCtrlSelectionState | |
23324ae1 | 73 | { |
7afd2b58 JS |
74 | wxRichTextCtrlSelectionState_Normal, |
75 | wxRichTextCtrlSelectionState_CommonAncestor | |
76 | }; | |
77 | ||
78 | /** | |
79 | @class wxRichTextContextMenuPropertiesInfo | |
80 | ||
81 | wxRichTextContextMenuPropertiesInfo keeps track of objects that appear in the context menu, | |
82 | whose properties are available to be edited. | |
83 | */ | |
738b7b98 | 84 | |
7afd2b58 JS |
85 | class WXDLLIMPEXP_RICHTEXT wxRichTextContextMenuPropertiesInfo |
86 | { | |
87 | public: | |
738b7b98 BP |
88 | /** |
89 | Constructor. | |
738b7b98 | 90 | */ |
7afd2b58 JS |
91 | wxRichTextContextMenuPropertiesInfo() { Init(); } |
92 | ||
93 | // Operations | |
23324ae1 | 94 | |
23324ae1 | 95 | /** |
7afd2b58 | 96 | Initialisation. |
23324ae1 | 97 | */ |
7afd2b58 | 98 | void Init() {} |
23324ae1 FM |
99 | |
100 | /** | |
7afd2b58 | 101 | Adds an item. |
23324ae1 | 102 | */ |
7afd2b58 | 103 | bool AddItem(const wxString& label, wxRichTextObject* obj); |
23324ae1 FM |
104 | |
105 | /** | |
7afd2b58 | 106 | Returns the number of menu items that were added. |
23324ae1 | 107 | */ |
7afd2b58 | 108 | int AddMenuItems(wxMenu* menu, int startCmd = wxID_RICHTEXT_PROPERTIES1) const; |
23324ae1 FM |
109 | |
110 | /** | |
7afd2b58 JS |
111 | Adds appropriate menu items for the current container and clicked on object |
112 | (and container's parent, if appropriate). | |
23324ae1 | 113 | */ |
303f0be7 | 114 | int AddItems(wxRichTextCtrl* ctrl, wxRichTextObject* container, wxRichTextObject* obj); |
23324ae1 FM |
115 | |
116 | /** | |
7afd2b58 | 117 | Clears the items. |
23324ae1 | 118 | */ |
7afd2b58 JS |
119 | void Clear() { m_objects.Clear(); m_labels.Clear(); } |
120 | ||
121 | // Accessors | |
23324ae1 FM |
122 | |
123 | /** | |
7afd2b58 | 124 | Returns the nth label. |
23324ae1 | 125 | */ |
7afd2b58 | 126 | wxString GetLabel(int n) const { return m_labels[n]; } |
23324ae1 FM |
127 | |
128 | /** | |
7afd2b58 | 129 | Returns the nth object. |
23324ae1 | 130 | */ |
7afd2b58 | 131 | wxRichTextObject* GetObject(int n) const { return m_objects[n]; } |
23324ae1 FM |
132 | |
133 | /** | |
7afd2b58 | 134 | Returns the array of objects. |
23324ae1 | 135 | */ |
7afd2b58 | 136 | wxRichTextObjectPtrArray& GetObjects() { return m_objects; } |
23324ae1 FM |
137 | |
138 | /** | |
7afd2b58 | 139 | Returns the array of objects. |
23324ae1 | 140 | */ |
7afd2b58 | 141 | const wxRichTextObjectPtrArray& GetObjects() const { return m_objects; } |
23324ae1 FM |
142 | |
143 | /** | |
7afd2b58 | 144 | Returns the array of labels. |
23324ae1 | 145 | */ |
7afd2b58 | 146 | wxArrayString& GetLabels() { return m_labels; } |
23324ae1 FM |
147 | |
148 | /** | |
7afd2b58 | 149 | Returns the array of labels. |
23324ae1 | 150 | */ |
7afd2b58 | 151 | const wxArrayString& GetLabels() const { return m_labels; } |
23324ae1 FM |
152 | |
153 | /** | |
7afd2b58 | 154 | Returns the number of items. |
23324ae1 | 155 | */ |
7afd2b58 | 156 | int GetCount() const { return m_objects.GetCount(); } |
23324ae1 | 157 | |
7afd2b58 JS |
158 | wxRichTextObjectPtrArray m_objects; |
159 | wxArrayString m_labels; | |
160 | }; | |
e54c96f1 | 161 | |
23324ae1 FM |
162 | /** |
163 | @class wxRichTextCtrl | |
7c913512 | 164 | |
23324ae1 FM |
165 | wxRichTextCtrl provides a generic, ground-up implementation of a text control |
166 | capable of showing multiple styles and images. | |
7c913512 | 167 | |
23324ae1 | 168 | wxRichTextCtrl sends notification events: see wxRichTextEvent. |
9e7ad1ca | 169 | |
3a194bda SL |
170 | It also sends the standard wxTextCtrl events @c wxEVT_COMMAND_TEXT_ENTER and |
171 | @c wxEVT_COMMAND_TEXT_UPDATED, and wxTextUrlEvent when URL content is clicked. | |
7c913512 | 172 | |
738b7b98 | 173 | For more information, see the @ref overview_richtextctrl. |
7c913512 | 174 | |
e9f10004 JS |
175 | @beginStyleTable |
176 | @style{wxRE_CENTRE_CARET} | |
177 | The control will try to keep the caret line centred vertically while editing. | |
178 | wxRE_CENTER_CARET is a synonym for this style. | |
179 | @style{wxRE_MULTILINE} | |
180 | The control will be multiline (mandatory). | |
181 | @style{wxRE_READONLY} | |
182 | The control will not be editable. | |
183 | @endStyleTable | |
184 | ||
23324ae1 | 185 | @library{wxrichtext} |
21b447dc | 186 | @category{richtext} |
36d0c795 | 187 | @appearance{richtextctrl.png} |
7afd2b58 JS |
188 | |
189 | */ | |
190 | ||
191 | class WXDLLIMPEXP_RICHTEXT wxRichTextCtrl : public wxControl, | |
192 | public wxTextCtrlIface, | |
193 | public wxScrollHelper | |
23324ae1 | 194 | { |
7afd2b58 JS |
195 | DECLARE_CLASS( wxRichTextCtrl ) |
196 | DECLARE_EVENT_TABLE() | |
197 | ||
23324ae1 | 198 | public: |
7afd2b58 JS |
199 | // Constructors |
200 | ||
23324ae1 | 201 | /** |
7afd2b58 | 202 | Default constructor. |
23324ae1 | 203 | */ |
7afd2b58 | 204 | wxRichTextCtrl( ); |
738b7b98 BP |
205 | |
206 | /** | |
207 | Constructor, creating and showing a rich text control. | |
208 | ||
209 | @param parent | |
210 | Parent window. Must not be @NULL. | |
211 | @param id | |
212 | Window identifier. The value @c wxID_ANY indicates a default value. | |
213 | @param value | |
214 | Default string. | |
215 | @param pos | |
216 | Window position. | |
217 | @param size | |
218 | Window size. | |
219 | @param style | |
220 | Window style. | |
221 | @param validator | |
222 | Window validator. | |
223 | @param name | |
224 | Window name. | |
225 | ||
226 | @see Create(), wxValidator | |
227 | */ | |
7afd2b58 JS |
228 | wxRichTextCtrl( wxWindow* parent, wxWindowID id = -1, const wxString& value = wxEmptyString, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, |
229 | long style = wxRE_MULTILINE, const wxValidator& validator = wxDefaultValidator, const wxString& name = wxTextCtrlNameStr); | |
23324ae1 FM |
230 | |
231 | /** | |
232 | Destructor. | |
233 | */ | |
7afd2b58 JS |
234 | virtual ~wxRichTextCtrl( ); |
235 | ||
236 | // Operations | |
23324ae1 FM |
237 | |
238 | /** | |
7afd2b58 | 239 | Creates the underlying window. |
23324ae1 | 240 | */ |
7afd2b58 JS |
241 | bool Create( wxWindow* parent, wxWindowID id = -1, const wxString& value = wxEmptyString, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, |
242 | long style = wxRE_MULTILINE, const wxValidator& validator = wxDefaultValidator, const wxString& name = wxTextCtrlNameStr ); | |
23324ae1 FM |
243 | |
244 | /** | |
7afd2b58 | 245 | Initialises the members of the control. |
23324ae1 | 246 | */ |
7afd2b58 JS |
247 | void Init(); |
248 | ||
249 | // Accessors | |
23324ae1 FM |
250 | |
251 | /** | |
7afd2b58 JS |
252 | Gets the text for the given range. |
253 | The end point of range is specified as the last character position of | |
254 | the span of text, plus one. | |
23324ae1 | 255 | */ |
7afd2b58 | 256 | virtual wxString GetRange(long from, long to) const; |
23324ae1 FM |
257 | |
258 | /** | |
7afd2b58 | 259 | Returns the length of the specified line in characters. |
23324ae1 | 260 | */ |
7afd2b58 | 261 | virtual int GetLineLength(long lineNo) const ; |
23324ae1 FM |
262 | |
263 | /** | |
7afd2b58 | 264 | Returns the text for the given line. |
23324ae1 | 265 | */ |
7afd2b58 | 266 | virtual wxString GetLineText(long lineNo) const ; |
23324ae1 FM |
267 | |
268 | /** | |
7afd2b58 | 269 | Returns the number of lines in the buffer. |
23324ae1 | 270 | */ |
7afd2b58 | 271 | virtual int GetNumberOfLines() const ; |
23324ae1 FM |
272 | |
273 | /** | |
7afd2b58 | 274 | Returns @true if the buffer has been modified. |
23324ae1 | 275 | */ |
7afd2b58 | 276 | virtual bool IsModified() const ; |
23324ae1 FM |
277 | |
278 | /** | |
7afd2b58 | 279 | Returns @true if the control is editable. |
23324ae1 | 280 | */ |
7afd2b58 | 281 | virtual bool IsEditable() const ; |
23324ae1 FM |
282 | |
283 | /** | |
7afd2b58 JS |
284 | Returns @true if the control is single-line. |
285 | Currently wxRichTextCtrl does not support single-line editing. | |
23324ae1 | 286 | */ |
7afd2b58 | 287 | bool IsSingleLine() const { return !HasFlag(wxRE_MULTILINE); } |
23324ae1 FM |
288 | |
289 | /** | |
7afd2b58 | 290 | Returns @true if the control is multiline. |
23324ae1 | 291 | */ |
7afd2b58 | 292 | bool IsMultiLine() const { return !IsSingleLine(); } |
23324ae1 | 293 | |
7afd2b58 | 294 | //@{ |
23324ae1 | 295 | /** |
7afd2b58 JS |
296 | Returns the range of the current selection. |
297 | The end point of range is specified as the last character position of the span | |
298 | of text, plus one. | |
299 | If the return values @a from and @a to are the same, there is no selection. | |
23324ae1 | 300 | */ |
7afd2b58 JS |
301 | virtual void GetSelection(long* from, long* to) const; |
302 | const wxRichTextSelection& GetSelection() const { return m_selection; } | |
303 | wxRichTextSelection& GetSelection() { return m_selection; } | |
304 | //@} | |
23324ae1 FM |
305 | |
306 | /** | |
7afd2b58 | 307 | Returns the text within the current selection range, if any. |
23324ae1 | 308 | */ |
7afd2b58 | 309 | virtual wxString GetStringSelection() const; |
23324ae1 FM |
310 | |
311 | /** | |
7afd2b58 | 312 | Gets the current filename associated with the control. |
23324ae1 | 313 | */ |
7afd2b58 | 314 | wxString GetFilename() const { return m_filename; } |
23324ae1 FM |
315 | |
316 | /** | |
7afd2b58 | 317 | Sets the current filename. |
23324ae1 | 318 | */ |
7afd2b58 | 319 | void SetFilename(const wxString& filename) { m_filename = filename; } |
23324ae1 FM |
320 | |
321 | /** | |
7afd2b58 JS |
322 | Sets the size of the buffer beyond which layout is delayed during resizing. |
323 | This optimizes sizing for large buffers. The default is 20000. | |
23324ae1 | 324 | */ |
7afd2b58 | 325 | void SetDelayedLayoutThreshold(long threshold) { m_delayedLayoutThreshold = threshold; } |
23324ae1 FM |
326 | |
327 | /** | |
7afd2b58 JS |
328 | Gets the size of the buffer beyond which layout is delayed during resizing. |
329 | This optimizes sizing for large buffers. The default is 20000. | |
23324ae1 | 330 | */ |
7afd2b58 | 331 | long GetDelayedLayoutThreshold() const { return m_delayedLayoutThreshold; } |
23324ae1 FM |
332 | |
333 | /** | |
23324ae1 | 334 | */ |
7afd2b58 | 335 | bool GetFullLayoutRequired() const { return m_fullLayoutRequired; } |
23324ae1 FM |
336 | |
337 | /** | |
23324ae1 | 338 | */ |
7afd2b58 | 339 | void SetFullLayoutRequired(bool b) { m_fullLayoutRequired = b; } |
23324ae1 FM |
340 | |
341 | /** | |
23324ae1 | 342 | */ |
7afd2b58 | 343 | wxLongLong GetFullLayoutTime() const { return m_fullLayoutTime; } |
23324ae1 FM |
344 | |
345 | /** | |
23324ae1 | 346 | */ |
7afd2b58 | 347 | void SetFullLayoutTime(wxLongLong t) { m_fullLayoutTime = t; } |
23324ae1 FM |
348 | |
349 | /** | |
23324ae1 | 350 | */ |
7afd2b58 | 351 | long GetFullLayoutSavedPosition() const { return m_fullLayoutSavedPosition; } |
23324ae1 FM |
352 | |
353 | /** | |
23324ae1 | 354 | */ |
7afd2b58 | 355 | void SetFullLayoutSavedPosition(long p) { m_fullLayoutSavedPosition = p; } |
23324ae1 | 356 | |
7afd2b58 | 357 | // Force any pending layout due to large buffer |
23324ae1 | 358 | /** |
23324ae1 | 359 | */ |
7afd2b58 | 360 | void ForceDelayedLayout(); |
23324ae1 FM |
361 | |
362 | /** | |
7afd2b58 | 363 | Sets the text (normal) cursor. |
23324ae1 | 364 | */ |
7afd2b58 | 365 | void SetTextCursor(const wxCursor& cursor ) { m_textCursor = cursor; } |
23324ae1 FM |
366 | |
367 | /** | |
7afd2b58 | 368 | Returns the text (normal) cursor. |
23324ae1 | 369 | */ |
7afd2b58 | 370 | wxCursor GetTextCursor() const { return m_textCursor; } |
23324ae1 FM |
371 | |
372 | /** | |
7afd2b58 | 373 | Sets the cursor to be used over URLs. |
23324ae1 | 374 | */ |
7afd2b58 | 375 | void SetURLCursor(const wxCursor& cursor ) { m_urlCursor = cursor; } |
23324ae1 FM |
376 | |
377 | /** | |
7afd2b58 | 378 | Returns the cursor to be used over URLs. |
23324ae1 | 379 | */ |
7afd2b58 | 380 | wxCursor GetURLCursor() const { return m_urlCursor; } |
23324ae1 FM |
381 | |
382 | /** | |
7afd2b58 JS |
383 | Returns @true if we are showing the caret position at the start of a line |
384 | instead of at the end of the previous one. | |
23324ae1 | 385 | */ |
7afd2b58 | 386 | bool GetCaretAtLineStart() const { return m_caretAtLineStart; } |
23324ae1 FM |
387 | |
388 | /** | |
7afd2b58 JS |
389 | Sets a flag to remember that we are showing the caret position at the start of a line |
390 | instead of at the end of the previous one. | |
23324ae1 | 391 | */ |
7afd2b58 | 392 | void SetCaretAtLineStart(bool atStart) { m_caretAtLineStart = atStart; } |
23324ae1 FM |
393 | |
394 | /** | |
0c0e063e | 395 | Returns @true if we are extending a selection. |
23324ae1 | 396 | */ |
7afd2b58 | 397 | bool GetDragging() const { return m_dragging; } |
23324ae1 FM |
398 | |
399 | /** | |
0c0e063e | 400 | Sets a flag to remember if we are extending a selection. |
23324ae1 | 401 | */ |
7afd2b58 | 402 | void SetDragging(bool dragging) { m_dragging = dragging; } |
23324ae1 FM |
403 | |
404 | /** | |
0c0e063e | 405 | Are we trying to start Drag'n'Drop? |
23324ae1 | 406 | */ |
0c0e063e | 407 | bool GetPreDrag() const { return m_preDrag; } |
23324ae1 FM |
408 | |
409 | /** | |
0c0e063e | 410 | Set if we're trying to start Drag'n'Drop |
23324ae1 | 411 | */ |
0c0e063e JS |
412 | void SetPreDrag(bool pd) { m_preDrag = pd; } |
413 | ||
414 | /** | |
415 | Get the possible Drag'n'Drop start point | |
416 | */ | |
417 | const wxPoint GetDragStartPoint() const { return m_dragStartPoint; } | |
418 | ||
419 | /** | |
420 | Set the possible Drag'n'Drop start point | |
421 | */ | |
422 | void SetDragStartPoint(wxPoint sp) { m_dragStartPoint = sp; } | |
423 | ||
424 | /** | |
425 | Get the possible Drag'n'Drop start time | |
426 | */ | |
427 | const wxDateTime GetDragStartTime() const { return m_dragStartTime; } | |
428 | ||
429 | /** | |
430 | Set the possible Drag'n'Drop start time | |
431 | */ | |
432 | void SetDragStartTime(wxDateTime st) { m_dragStartTime = st; } | |
23324ae1 | 433 | |
7afd2b58 JS |
434 | #if wxRICHTEXT_BUFFERED_PAINTING |
435 | //@{ | |
23324ae1 | 436 | /** |
7afd2b58 | 437 | Returns the buffer bitmap if using buffered painting. |
23324ae1 | 438 | */ |
7afd2b58 JS |
439 | const wxBitmap& GetBufferBitmap() const { return m_bufferBitmap; } |
440 | wxBitmap& GetBufferBitmap() { return m_bufferBitmap; } | |
441 | //@} | |
442 | #endif | |
23324ae1 FM |
443 | |
444 | /** | |
7afd2b58 | 445 | Returns the current context menu. |
23324ae1 | 446 | */ |
7afd2b58 | 447 | wxMenu* GetContextMenu() const { return m_contextMenu; } |
23324ae1 FM |
448 | |
449 | /** | |
7afd2b58 | 450 | Sets the current context menu. |
23324ae1 | 451 | */ |
7afd2b58 | 452 | void SetContextMenu(wxMenu* menu); |
23324ae1 FM |
453 | |
454 | /** | |
7afd2b58 JS |
455 | Returns an anchor so we know how to extend the selection. |
456 | It's a caret position since it's between two characters. | |
23324ae1 | 457 | */ |
7afd2b58 | 458 | long GetSelectionAnchor() const { return m_selectionAnchor; } |
23324ae1 | 459 | |
23324ae1 | 460 | /** |
7afd2b58 JS |
461 | Sets an anchor so we know how to extend the selection. |
462 | It's a caret position since it's between two characters. | |
23324ae1 | 463 | */ |
7afd2b58 | 464 | void SetSelectionAnchor(long anchor) { m_selectionAnchor = anchor; } |
23324ae1 FM |
465 | |
466 | /** | |
7afd2b58 | 467 | Returns the anchor object if selecting multiple containers. |
23324ae1 | 468 | */ |
7afd2b58 | 469 | wxRichTextObject* GetSelectionAnchorObject() const { return m_selectionAnchorObject; } |
23324ae1 FM |
470 | |
471 | /** | |
7afd2b58 | 472 | Sets the anchor object if selecting multiple containers. |
23324ae1 | 473 | */ |
7afd2b58 | 474 | void SetSelectionAnchorObject(wxRichTextObject* anchor) { m_selectionAnchorObject = anchor; } |
23324ae1 | 475 | |
7afd2b58 | 476 | //@{ |
23324ae1 | 477 | /** |
7afd2b58 JS |
478 | Returns an object that stores information about context menu property item(s), |
479 | in order to communicate between the context menu event handler and the code | |
480 | that responds to it. The wxRichTextContextMenuPropertiesInfo stores one | |
481 | item for each object that could respond to a property-editing event. If | |
482 | objects are nested, several might be editable. | |
23324ae1 | 483 | */ |
7afd2b58 JS |
484 | wxRichTextContextMenuPropertiesInfo& GetContextMenuPropertiesInfo() { return m_contextMenuPropertiesInfo; } |
485 | const wxRichTextContextMenuPropertiesInfo& GetContextMenuPropertiesInfo() const { return m_contextMenuPropertiesInfo; } | |
486 | //@} | |
23324ae1 FM |
487 | |
488 | /** | |
7afd2b58 JS |
489 | Returns the wxRichTextObject object that currently has the editing focus. |
490 | If there are no composite objects, this will be the top-level buffer. | |
23324ae1 | 491 | */ |
7afd2b58 | 492 | wxRichTextParagraphLayoutBox* GetFocusObject() const { return m_focusObject; } |
23324ae1 | 493 | |
0c0e063e JS |
494 | /** |
495 | Setter for m_focusObject. | |
496 | */ | |
497 | void StoreFocusObject(wxRichTextParagraphLayoutBox* obj); | |
498 | ||
23324ae1 | 499 | /** |
7afd2b58 | 500 | Sets the wxRichTextObject object that currently has the editing focus. |
0c0e063e JS |
501 | @param setCaretPosition |
502 | Optionally set the caret position. | |
23324ae1 | 503 | */ |
7afd2b58 | 504 | bool SetFocusObject(wxRichTextParagraphLayoutBox* obj, bool setCaretPosition = true); |
371ae8b5 | 505 | |
7afd2b58 | 506 | // Operations |
23324ae1 FM |
507 | |
508 | /** | |
7afd2b58 | 509 | Invalidates the whole buffer to trigger painting later. |
23324ae1 | 510 | */ |
7afd2b58 | 511 | void Invalidate() { GetBuffer().Invalidate(wxRICHTEXT_ALL); } |
23324ae1 FM |
512 | |
513 | /** | |
7afd2b58 | 514 | Clears the buffer content, leaving a single empty paragraph. Cannot be undone. |
23324ae1 | 515 | */ |
7afd2b58 | 516 | virtual void Clear(); |
23324ae1 | 517 | |
23324ae1 | 518 | /** |
7afd2b58 JS |
519 | Replaces the content in the specified range with the string specified by |
520 | @a value. | |
23324ae1 | 521 | */ |
7afd2b58 | 522 | virtual void Replace(long from, long to, const wxString& value); |
23324ae1 FM |
523 | |
524 | /** | |
7afd2b58 | 525 | Removes the content in the specified range. |
23324ae1 | 526 | */ |
7afd2b58 | 527 | virtual void Remove(long from, long to); |
23324ae1 | 528 | |
7afd2b58 | 529 | #ifdef DOXYGEN |
23324ae1 | 530 | /** |
7afd2b58 | 531 | Loads content into the control's buffer using the given type. |
23324ae1 | 532 | |
7afd2b58 JS |
533 | If the specified type is wxRICHTEXT_TYPE_ANY, the type is deduced from |
534 | the filename extension. | |
23324ae1 | 535 | |
7afd2b58 | 536 | This function looks for a suitable wxRichTextFileHandler object. |
23324ae1 | 537 | */ |
7afd2b58 JS |
538 | bool LoadFile(const wxString& file, |
539 | int type = wxRICHTEXT_TYPE_ANY); | |
540 | #endif | |
23324ae1 FM |
541 | |
542 | /** | |
7afd2b58 | 543 | Helper function for LoadFile(). Loads content into the control's buffer using the given type. |
23324ae1 | 544 | |
7afd2b58 JS |
545 | If the specified type is wxRICHTEXT_TYPE_ANY, the type is deduced from |
546 | the filename extension. | |
23324ae1 | 547 | |
7afd2b58 | 548 | This function looks for a suitable wxRichTextFileHandler object. |
23324ae1 | 549 | */ |
7afd2b58 | 550 | virtual bool DoLoadFile(const wxString& file, int fileType); |
23324ae1 | 551 | |
7afd2b58 | 552 | #ifdef DOXYGEN |
23324ae1 | 553 | /** |
7afd2b58 | 554 | Saves the buffer content using the given type. |
23324ae1 | 555 | |
7afd2b58 JS |
556 | If the specified type is wxRICHTEXT_TYPE_ANY, the type is deduced from |
557 | the filename extension. | |
23324ae1 | 558 | |
7afd2b58 | 559 | This function looks for a suitable wxRichTextFileHandler object. |
23324ae1 | 560 | */ |
7afd2b58 JS |
561 | bool SaveFile(const wxString& file = wxEmptyString, |
562 | int type = wxRICHTEXT_TYPE_ANY); | |
563 | #endif | |
23324ae1 FM |
564 | |
565 | /** | |
7afd2b58 | 566 | Helper function for SaveFile(). Saves the buffer content using the given type. |
23324ae1 | 567 | |
7afd2b58 JS |
568 | If the specified type is wxRICHTEXT_TYPE_ANY, the type is deduced from |
569 | the filename extension. | |
23324ae1 | 570 | |
7afd2b58 | 571 | This function looks for a suitable wxRichTextFileHandler object. |
23324ae1 | 572 | */ |
7afd2b58 JS |
573 | virtual bool DoSaveFile(const wxString& file = wxEmptyString, |
574 | int fileType = wxRICHTEXT_TYPE_ANY); | |
23324ae1 FM |
575 | |
576 | /** | |
7afd2b58 | 577 | Sets flags that change the behaviour of loading or saving. |
23324ae1 | 578 | |
7afd2b58 JS |
579 | See the documentation for each handler class to see what flags are |
580 | relevant for each handler. | |
23324ae1 | 581 | */ |
7afd2b58 | 582 | void SetHandlerFlags(int flags) { GetBuffer().SetHandlerFlags(flags); } |
23324ae1 FM |
583 | |
584 | /** | |
7afd2b58 JS |
585 | Returns flags that change the behaviour of loading or saving. |
586 | See the documentation for each handler class to see what flags are | |
587 | relevant for each handler. | |
23324ae1 | 588 | */ |
7afd2b58 | 589 | int GetHandlerFlags() const { return GetBuffer().GetHandlerFlags(); } |
23324ae1 FM |
590 | |
591 | /** | |
7afd2b58 | 592 | Marks the buffer as modified. |
23324ae1 | 593 | */ |
7afd2b58 | 594 | virtual void MarkDirty(); |
23324ae1 FM |
595 | |
596 | /** | |
7afd2b58 JS |
597 | Sets the buffer's modified status to @false, and clears the buffer's command |
598 | history. | |
23324ae1 | 599 | */ |
7afd2b58 | 600 | virtual void DiscardEdits(); |
23324ae1 FM |
601 | |
602 | /** | |
7afd2b58 JS |
603 | Sets the maximum number of characters that may be entered in a single line |
604 | text control. For compatibility only; currently does nothing. | |
23324ae1 | 605 | */ |
7afd2b58 | 606 | virtual void SetMaxLength(unsigned long WXUNUSED(len)) { } |
23324ae1 FM |
607 | |
608 | /** | |
7afd2b58 | 609 | Writes text at the current position. |
23324ae1 | 610 | */ |
7afd2b58 | 611 | virtual void WriteText(const wxString& text); |
23324ae1 FM |
612 | |
613 | /** | |
7afd2b58 | 614 | Sets the insertion point to the end of the buffer and writes the text. |
23324ae1 | 615 | */ |
7afd2b58 | 616 | virtual void AppendText(const wxString& text); |
23324ae1 | 617 | |
7afd2b58 | 618 | //@{ |
23324ae1 | 619 | /** |
7afd2b58 JS |
620 | Gets the attributes at the given position. |
621 | This function gets the combined style - that is, the style you see on the | |
622 | screen as a result of combining base style, paragraph style and character | |
623 | style attributes. | |
624 | ||
625 | To get the character or paragraph style alone, use GetUncombinedStyle(). | |
626 | ||
627 | @beginWxPerlOnly | |
628 | In wxPerl this method is implemented as GetStyle(@a position) | |
629 | returning a 2-element list (ok, attr). | |
630 | @endWxPerlOnly | |
23324ae1 | 631 | */ |
7afd2b58 JS |
632 | virtual bool GetStyle(long position, wxTextAttr& style); |
633 | virtual bool GetStyle(long position, wxRichTextAttr& style); | |
634 | virtual bool GetStyle(long position, wxRichTextAttr& style, wxRichTextParagraphLayoutBox* container); | |
635 | //@} | |
23324ae1 | 636 | |
7afd2b58 | 637 | //@{ |
23324ae1 | 638 | /** |
7afd2b58 JS |
639 | Sets the attributes for the given range. |
640 | The end point of range is specified as the last character position of the span | |
641 | of text, plus one. | |
642 | ||
643 | So, for example, to set the style for a character at position 5, use the range | |
644 | (5,6). | |
23324ae1 | 645 | */ |
7afd2b58 JS |
646 | virtual bool SetStyle(long start, long end, const wxTextAttr& style); |
647 | virtual bool SetStyle(long start, long end, const wxRichTextAttr& style); | |
648 | virtual bool SetStyle(const wxRichTextRange& range, const wxTextAttr& style); | |
649 | virtual bool SetStyle(const wxRichTextRange& range, const wxRichTextAttr& style); | |
650 | //@} | |
23324ae1 FM |
651 | |
652 | /** | |
7afd2b58 | 653 | Sets the attributes for a single object |
23324ae1 | 654 | */ |
7afd2b58 | 655 | virtual void SetStyle(wxRichTextObject *obj, const wxRichTextAttr& textAttr); |
23324ae1 FM |
656 | |
657 | //@{ | |
658 | /** | |
7afd2b58 JS |
659 | Gets the attributes common to the specified range. |
660 | Attributes that differ in value within the range will not be included | |
661 | in @a style flags. | |
662 | ||
663 | @beginWxPerlOnly | |
664 | In wxPerl this method is implemented as GetStyleForRange(@a position) | |
665 | returning a 2-element list (ok, attr). | |
666 | @endWxPerlOnly | |
23324ae1 | 667 | */ |
7afd2b58 JS |
668 | virtual bool GetStyleForRange(const wxRichTextRange& range, wxTextAttr& style); |
669 | virtual bool GetStyleForRange(const wxRichTextRange& range, wxRichTextAttr& style); | |
670 | virtual bool GetStyleForRange(const wxRichTextRange& range, wxRichTextAttr& style, wxRichTextParagraphLayoutBox* container); | |
23324ae1 FM |
671 | //@} |
672 | ||
673 | /** | |
7afd2b58 JS |
674 | Sets the attributes for the given range, passing flags to determine how the |
675 | attributes are set. | |
676 | ||
677 | The end point of range is specified as the last character position of the span | |
678 | of text, plus one. So, for example, to set the style for a character at | |
679 | position 5, use the range (5,6). | |
680 | ||
681 | @a flags may contain a bit list of the following values: | |
682 | - wxRICHTEXT_SETSTYLE_NONE: no style flag. | |
683 | - wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this operation should be | |
684 | undoable. | |
685 | - wxRICHTEXT_SETSTYLE_OPTIMIZE: specifies that the style should not be applied | |
686 | if the combined style at this point is already the style in question. | |
687 | - wxRICHTEXT_SETSTYLE_PARAGRAPHS_ONLY: specifies that the style should only be | |
688 | applied to paragraphs, and not the content. | |
689 | This allows content styling to be preserved independently from that | |
690 | of e.g. a named paragraph style. | |
691 | - wxRICHTEXT_SETSTYLE_CHARACTERS_ONLY: specifies that the style should only be | |
692 | applied to characters, and not the paragraph. | |
693 | This allows content styling to be preserved independently from that | |
694 | of e.g. a named paragraph style. | |
695 | - wxRICHTEXT_SETSTYLE_RESET: resets (clears) the existing style before applying | |
696 | the new style. | |
697 | - wxRICHTEXT_SETSTYLE_REMOVE: removes the specified style. Only the style flags | |
698 | are used in this operation. | |
23324ae1 | 699 | */ |
7afd2b58 | 700 | virtual bool SetStyleEx(const wxRichTextRange& range, const wxRichTextAttr& style, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO); |
23324ae1 | 701 | |
7afd2b58 | 702 | //@{ |
23324ae1 | 703 | /** |
7afd2b58 JS |
704 | Gets the attributes at the given position. |
705 | This function gets the @e uncombined style - that is, the attributes associated | |
706 | with the paragraph or character content, and not necessarily the combined | |
707 | attributes you see on the screen. | |
708 | To get the combined attributes, use GetStyle(). | |
709 | ||
710 | If you specify (any) paragraph attribute in @e style's flags, this function | |
711 | will fetch the paragraph attributes. | |
712 | Otherwise, it will return the character attributes. | |
371ae8b5 MB |
713 | |
714 | @beginWxPerlOnly | |
7afd2b58 JS |
715 | In wxPerl this method is implemented as GetUncombinedStyle(@a position) |
716 | returning a 2-element list (ok, attr). | |
371ae8b5 | 717 | @endWxPerlOnly |
23324ae1 | 718 | */ |
7afd2b58 JS |
719 | virtual bool GetUncombinedStyle(long position, wxRichTextAttr& style); |
720 | virtual bool GetUncombinedStyle(long position, wxRichTextAttr& style, wxRichTextParagraphLayoutBox* container); | |
721 | //@} | |
23324ae1 | 722 | |
7afd2b58 | 723 | //@{ |
23324ae1 | 724 | /** |
7afd2b58 JS |
725 | Sets the current default style, which can be used to change how subsequently |
726 | inserted text is displayed. | |
23324ae1 | 727 | */ |
7afd2b58 JS |
728 | virtual bool SetDefaultStyle(const wxTextAttr& style); |
729 | virtual bool SetDefaultStyle(const wxRichTextAttr& style); | |
730 | //@} | |
23324ae1 FM |
731 | |
732 | /** | |
733 | Returns the current default style, which can be used to change how subsequently | |
9e7ad1ca | 734 | inserted text is displayed. |
23324ae1 | 735 | */ |
7afd2b58 | 736 | virtual const wxRichTextAttr& GetDefaultStyleEx() const; |
23324ae1 | 737 | |
7afd2b58 | 738 | //virtual const wxTextAttr& GetDefaultStyle() const; |
23324ae1 | 739 | |
7afd2b58 | 740 | //@{ |
23324ae1 | 741 | /** |
7afd2b58 JS |
742 | Sets the list attributes for the given range, passing flags to determine how |
743 | the attributes are set. | |
23324ae1 | 744 | |
7afd2b58 JS |
745 | Either the style definition or the name of the style definition (in the current |
746 | sheet) can be passed. | |
747 | @a flags is a bit list of the following: | |
748 | - wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable. | |
749 | - wxRICHTEXT_SETSTYLE_RENUMBER: specifies that numbering should start from | |
750 | @a startFrom, otherwise existing attributes are used. | |
751 | - wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL: specifies that @a listLevel should be used | |
752 | as the level for all paragraphs, otherwise the current indentation will be used. | |
23324ae1 | 753 | |
7afd2b58 | 754 | @see NumberList(), PromoteList(), ClearListStyle(). |
23324ae1 | 755 | */ |
7afd2b58 JS |
756 | virtual bool SetListStyle(const wxRichTextRange& range, wxRichTextListStyleDefinition* def, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom = 1, int specifiedLevel = -1); |
757 | virtual bool SetListStyle(const wxRichTextRange& range, const wxString& defName, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom = 1, int specifiedLevel = -1); | |
758 | //@} | |
23324ae1 FM |
759 | |
760 | /** | |
7afd2b58 JS |
761 | Clears the list style from the given range, clearing list-related attributes |
762 | and applying any named paragraph style associated with each paragraph. | |
23324ae1 | 763 | |
7afd2b58 JS |
764 | @a flags is a bit list of the following: |
765 | - wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable. | |
23324ae1 | 766 | |
7afd2b58 | 767 | @see SetListStyle(), PromoteList(), NumberList(). |
23324ae1 | 768 | */ |
7afd2b58 | 769 | virtual bool ClearListStyle(const wxRichTextRange& range, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO); |
23324ae1 | 770 | |
7afd2b58 | 771 | //@{ |
23324ae1 | 772 | /** |
7afd2b58 JS |
773 | Numbers the paragraphs in the given range. |
774 | Pass flags to determine how the attributes are set. | |
23324ae1 | 775 | |
7afd2b58 JS |
776 | Either the style definition or the name of the style definition (in the current |
777 | sheet) can be passed. | |
23324ae1 | 778 | |
7afd2b58 JS |
779 | @a flags is a bit list of the following: |
780 | - wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable. | |
781 | - wxRICHTEXT_SETSTYLE_RENUMBER: specifies that numbering should start from | |
782 | @a startFrom, otherwise existing attributes are used. | |
783 | - wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL: specifies that @a listLevel should be used | |
784 | as the level for all paragraphs, otherwise the current indentation will be used. | |
785 | ||
786 | @see SetListStyle(), PromoteList(), ClearListStyle(). | |
23324ae1 | 787 | */ |
7afd2b58 JS |
788 | virtual bool NumberList(const wxRichTextRange& range, wxRichTextListStyleDefinition* def = NULL, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom = 1, int specifiedLevel = -1); |
789 | virtual bool NumberList(const wxRichTextRange& range, const wxString& defName, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom = 1, int specifiedLevel = -1); | |
790 | //@} | |
23324ae1 | 791 | |
7afd2b58 | 792 | //@{ |
23324ae1 | 793 | /** |
7afd2b58 JS |
794 | Promotes or demotes the paragraphs in the given range. |
795 | A positive @a promoteBy produces a smaller indent, and a negative number | |
796 | produces a larger indent. Pass flags to determine how the attributes are set. | |
797 | Either the style definition or the name of the style definition (in the current | |
798 | sheet) can be passed. | |
799 | ||
800 | @a flags is a bit list of the following: | |
801 | - wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable. | |
802 | - wxRICHTEXT_SETSTYLE_RENUMBER: specifies that numbering should start from | |
803 | @a startFrom, otherwise existing attributes are used. | |
804 | - wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL: specifies that @a listLevel should be used | |
805 | as the level for all paragraphs, otherwise the current indentation will be used. | |
806 | ||
807 | @see SetListStyle(), @see SetListStyle(), ClearListStyle(). | |
23324ae1 | 808 | */ |
7afd2b58 JS |
809 | virtual bool PromoteList(int promoteBy, const wxRichTextRange& range, wxRichTextListStyleDefinition* def = NULL, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int specifiedLevel = -1); |
810 | virtual bool PromoteList(int promoteBy, const wxRichTextRange& range, const wxString& defName, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int specifiedLevel = -1); | |
811 | //@} | |
23324ae1 | 812 | |
590a0f8b JS |
813 | /** |
814 | Sets the properties for the given range, passing flags to determine how the | |
815 | attributes are set. You can merge properties or replace them. | |
816 | ||
817 | The end point of range is specified as the last character position of the span | |
818 | of text, plus one. So, for example, to set the properties for a character at | |
819 | position 5, use the range (5,6). | |
820 | ||
821 | @a flags may contain a bit list of the following values: | |
822 | - wxRICHTEXT_SETSPROPERTIES_NONE: no flag. | |
823 | - wxRICHTEXT_SETPROPERTIES_WITH_UNDO: specifies that this operation should be | |
824 | undoable. | |
825 | - wxRICHTEXT_SETPROPERTIES_PARAGRAPHS_ONLY: specifies that the properties should only be | |
826 | applied to paragraphs, and not the content. | |
827 | - wxRICHTEXT_SETPROPERTIES_CHARACTERS_ONLY: specifies that the properties should only be | |
828 | applied to characters, and not the paragraph. | |
829 | - wxRICHTEXT_SETPROPERTIES_RESET: resets (clears) the existing properties before applying | |
830 | the new properties. | |
831 | - wxRICHTEXT_SETPROPERTIES_REMOVE: removes the specified properties. | |
832 | */ | |
833 | virtual bool SetProperties(const wxRichTextRange& range, const wxRichTextProperties& properties, int flags = wxRICHTEXT_SETPROPERTIES_WITH_UNDO); | |
834 | ||
23324ae1 | 835 | /** |
7afd2b58 | 836 | Deletes the content within the given range. |
23324ae1 | 837 | */ |
7afd2b58 | 838 | virtual bool Delete(const wxRichTextRange& range); |
23324ae1 FM |
839 | |
840 | /** | |
7afd2b58 | 841 | Translates from column and line number to position. |
23324ae1 | 842 | */ |
7afd2b58 | 843 | virtual long XYToPosition(long x, long y) const; |
23324ae1 FM |
844 | |
845 | /** | |
7afd2b58 | 846 | Converts a text position to zero-based column and line numbers. |
23324ae1 | 847 | */ |
7afd2b58 | 848 | virtual bool PositionToXY(long pos, long *x, long *y) const; |
23324ae1 FM |
849 | |
850 | /** | |
7afd2b58 | 851 | Scrolls the buffer so that the given position is in view. |
23324ae1 | 852 | */ |
7afd2b58 | 853 | virtual void ShowPosition(long pos); |
23324ae1 | 854 | |
7afd2b58 | 855 | //@{ |
23324ae1 | 856 | /** |
7afd2b58 JS |
857 | Finds the character at the given position in pixels. |
858 | @a pt is in device coords (not adjusted for the client area origin nor for | |
859 | scrolling). | |
860 | */ | |
861 | virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt, long *pos) const; | |
862 | virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt, | |
863 | wxTextCoord *col, | |
864 | wxTextCoord *row) const; | |
0c0e063e JS |
865 | |
866 | /** | |
867 | Finds the container at the given point, which is assumed to be in client coordinates. | |
868 | */ | |
869 | wxRichTextParagraphLayoutBox* FindContainerAtPoint(const wxPoint pt, long& position, int& hit, wxRichTextObject* hitObj, int flags = 0); | |
7afd2b58 | 870 | //@} |
9e7ad1ca | 871 | |
7afd2b58 | 872 | // Clipboard operations |
371ae8b5 | 873 | |
7afd2b58 JS |
874 | /** |
875 | Copies the selected content (if any) to the clipboard. | |
23324ae1 | 876 | */ |
7afd2b58 | 877 | virtual void Copy(); |
23324ae1 FM |
878 | |
879 | /** | |
7afd2b58 JS |
880 | Copies the selected content (if any) to the clipboard and deletes the selection. |
881 | This is undoable. | |
23324ae1 | 882 | */ |
7afd2b58 | 883 | virtual void Cut(); |
23324ae1 FM |
884 | |
885 | /** | |
7afd2b58 | 886 | Pastes content from the clipboard to the buffer. |
23324ae1 | 887 | */ |
7afd2b58 | 888 | virtual void Paste(); |
23324ae1 FM |
889 | |
890 | /** | |
7afd2b58 | 891 | Deletes the content in the selection, if any. This is undoable. |
23324ae1 | 892 | */ |
7afd2b58 | 893 | virtual void DeleteSelection(); |
23324ae1 FM |
894 | |
895 | /** | |
7afd2b58 | 896 | Returns @true if selected content can be copied to the clipboard. |
23324ae1 | 897 | */ |
7afd2b58 | 898 | virtual bool CanCopy() const; |
23324ae1 FM |
899 | |
900 | /** | |
7afd2b58 | 901 | Returns @true if selected content can be copied to the clipboard and deleted. |
23324ae1 | 902 | */ |
7afd2b58 | 903 | virtual bool CanCut() const; |
23324ae1 FM |
904 | |
905 | /** | |
7afd2b58 JS |
906 | Returns @true if the clipboard content can be pasted to the buffer. |
907 | */ | |
908 | virtual bool CanPaste() const; | |
9e7ad1ca | 909 | |
7afd2b58 JS |
910 | /** |
911 | Returns @true if selected content can be deleted. | |
23324ae1 | 912 | */ |
7afd2b58 | 913 | virtual bool CanDeleteSelection() const; |
23324ae1 FM |
914 | |
915 | /** | |
7afd2b58 | 916 | Undoes the command at the top of the command history, if there is one. |
23324ae1 | 917 | */ |
7afd2b58 | 918 | virtual void Undo(); |
23324ae1 FM |
919 | |
920 | /** | |
7afd2b58 | 921 | Redoes the current command. |
23324ae1 | 922 | */ |
7afd2b58 | 923 | virtual void Redo(); |
23324ae1 | 924 | |
23324ae1 | 925 | /** |
7afd2b58 | 926 | Returns @true if there is a command in the command history that can be undone. |
23324ae1 | 927 | */ |
7afd2b58 | 928 | virtual bool CanUndo() const; |
23324ae1 FM |
929 | |
930 | /** | |
7afd2b58 | 931 | Returns @true if there is a command in the command history that can be redone. |
23324ae1 | 932 | */ |
7afd2b58 | 933 | virtual bool CanRedo() const; |
23324ae1 | 934 | |
23324ae1 | 935 | /** |
7afd2b58 JS |
936 | Sets the insertion point and causes the current editing style to be taken from |
937 | the new position (unlike wxRichTextCtrl::SetCaretPosition). | |
938 | */ | |
939 | virtual void SetInsertionPoint(long pos); | |
9e7ad1ca | 940 | |
7afd2b58 JS |
941 | /** |
942 | Sets the insertion point to the end of the text control. | |
943 | */ | |
944 | virtual void SetInsertionPointEnd(); | |
9e7ad1ca | 945 | |
7afd2b58 JS |
946 | /** |
947 | Returns the current insertion point. | |
23324ae1 | 948 | */ |
7afd2b58 | 949 | virtual long GetInsertionPoint() const; |
23324ae1 FM |
950 | |
951 | /** | |
7afd2b58 | 952 | Returns the last position in the buffer. |
23324ae1 | 953 | */ |
7afd2b58 | 954 | virtual wxTextPos GetLastPosition() const; |
23324ae1 | 955 | |
7afd2b58 | 956 | //@{ |
23324ae1 | 957 | /** |
7afd2b58 JS |
958 | Sets the selection to the given range. |
959 | The end point of range is specified as the last character position of the span | |
960 | of text, plus one. | |
961 | ||
962 | So, for example, to set the selection for a character at position 5, use the | |
963 | range (5,6). | |
23324ae1 | 964 | */ |
7afd2b58 JS |
965 | virtual void SetSelection(long from, long to); |
966 | void SetSelection(const wxRichTextSelection& sel) { m_selection = sel; } | |
967 | //@} | |
968 | ||
23324ae1 FM |
969 | |
970 | /** | |
7afd2b58 | 971 | Selects all the text in the buffer. |
23324ae1 | 972 | */ |
7afd2b58 | 973 | virtual void SelectAll(); |
23324ae1 FM |
974 | |
975 | /** | |
7afd2b58 | 976 | Makes the control editable, or not. |
23324ae1 | 977 | */ |
7afd2b58 | 978 | virtual void SetEditable(bool editable); |
23324ae1 FM |
979 | |
980 | /** | |
7afd2b58 JS |
981 | Returns @true if there is a selection and the object containing the selection |
982 | was the same as the current focus object. | |
23324ae1 | 983 | */ |
7afd2b58 | 984 | virtual bool HasSelection() const; |
23324ae1 FM |
985 | |
986 | /** | |
7afd2b58 JS |
987 | Returns @true if there was a selection, whether or not the current focus object |
988 | is the same as the selection's container object. | |
23324ae1 | 989 | */ |
7afd2b58 | 990 | virtual bool HasUnfocusedSelection() const; |
23324ae1 | 991 | |
7afd2b58 | 992 | //@{ |
23324ae1 | 993 | /** |
7afd2b58 JS |
994 | Write a bitmap or image at the current insertion point. |
995 | Supply an optional type to use for internal and file storage of the raw data. | |
23324ae1 | 996 | */ |
7afd2b58 JS |
997 | virtual bool WriteImage(const wxImage& image, wxBitmapType bitmapType = wxBITMAP_TYPE_PNG, |
998 | const wxRichTextAttr& textAttr = wxRichTextAttr()); | |
999 | ||
1000 | virtual bool WriteImage(const wxBitmap& bitmap, wxBitmapType bitmapType = wxBITMAP_TYPE_PNG, | |
1001 | const wxRichTextAttr& textAttr = wxRichTextAttr()); | |
1002 | //@} | |
23324ae1 FM |
1003 | |
1004 | /** | |
7afd2b58 | 1005 | Loads an image from a file and writes it at the current insertion point. |
23324ae1 | 1006 | */ |
7afd2b58 JS |
1007 | virtual bool WriteImage(const wxString& filename, wxBitmapType bitmapType, |
1008 | const wxRichTextAttr& textAttr = wxRichTextAttr()); | |
23324ae1 FM |
1009 | |
1010 | /** | |
7afd2b58 | 1011 | Writes an image block at the current insertion point. |
23324ae1 | 1012 | */ |
7afd2b58 JS |
1013 | virtual bool WriteImage(const wxRichTextImageBlock& imageBlock, |
1014 | const wxRichTextAttr& textAttr = wxRichTextAttr()); | |
23324ae1 FM |
1015 | |
1016 | /** | |
7afd2b58 JS |
1017 | Write a text box at the current insertion point, returning the text box. |
1018 | You can then call SetFocusObject() to set the focus to the new object. | |
23324ae1 | 1019 | */ |
7afd2b58 | 1020 | virtual wxRichTextBox* WriteTextBox(const wxRichTextAttr& textAttr = wxRichTextAttr()); |
23324ae1 FM |
1021 | |
1022 | /** | |
7afd2b58 JS |
1023 | Write a table at the current insertion point, returning the table. |
1024 | You can then call SetFocusObject() to set the focus to the new object. | |
23324ae1 | 1025 | */ |
7afd2b58 | 1026 | virtual wxRichTextTable* WriteTable(int rows, int cols, const wxRichTextAttr& tableAttr = wxRichTextAttr(), const wxRichTextAttr& cellAttr = wxRichTextAttr()); |
23324ae1 FM |
1027 | |
1028 | /** | |
7afd2b58 | 1029 | Inserts a new paragraph at the current insertion point. @see LineBreak(). |
23324ae1 | 1030 | */ |
7afd2b58 | 1031 | virtual bool Newline(); |
23324ae1 FM |
1032 | |
1033 | /** | |
9e7ad1ca FM |
1034 | Inserts a line break at the current insertion point. |
1035 | ||
1036 | A line break forces wrapping within a paragraph, and can be introduced by | |
1037 | using this function, by appending the wxChar value @b wxRichTextLineBreakChar | |
1038 | to text content, or by typing Shift-Return. | |
23324ae1 | 1039 | */ |
adaaa686 | 1040 | virtual bool LineBreak(); |
23324ae1 FM |
1041 | |
1042 | /** | |
7afd2b58 | 1043 | Sets the basic (overall) style. |
9e7ad1ca | 1044 | |
7afd2b58 JS |
1045 | This is the style of the whole buffer before further styles are applied, |
1046 | unlike the default style, which only affects the style currently being | |
1047 | applied (for example, setting the default style to bold will cause | |
1048 | subsequently inserted text to be bold). | |
23324ae1 | 1049 | */ |
7afd2b58 | 1050 | virtual void SetBasicStyle(const wxRichTextAttr& style) { GetBuffer().SetBasicStyle(style); } |
23324ae1 FM |
1051 | |
1052 | /** | |
7afd2b58 JS |
1053 | Gets the basic (overall) style. |
1054 | ||
1055 | This is the style of the whole buffer before further styles are applied, | |
1056 | unlike the default style, which only affects the style currently being | |
1057 | applied (for example, setting the default style to bold will cause | |
1058 | subsequently inserted text to be bold). | |
23324ae1 | 1059 | */ |
7afd2b58 | 1060 | virtual const wxRichTextAttr& GetBasicStyle() const { return GetBuffer().GetBasicStyle(); } |
23324ae1 FM |
1061 | |
1062 | /** | |
7afd2b58 | 1063 | Begins applying a style. |
23324ae1 | 1064 | */ |
7afd2b58 | 1065 | virtual bool BeginStyle(const wxRichTextAttr& style) { return GetBuffer().BeginStyle(style); } |
23324ae1 FM |
1066 | |
1067 | /** | |
7afd2b58 | 1068 | Ends the current style. |
23324ae1 | 1069 | */ |
7afd2b58 | 1070 | virtual bool EndStyle() { return GetBuffer().EndStyle(); } |
23324ae1 FM |
1071 | |
1072 | /** | |
7afd2b58 | 1073 | Ends application of all styles in the current style stack. |
23324ae1 | 1074 | */ |
7afd2b58 | 1075 | virtual bool EndAllStyles() { return GetBuffer().EndAllStyles(); } |
23324ae1 FM |
1076 | |
1077 | /** | |
7afd2b58 | 1078 | Begins using bold. |
23324ae1 | 1079 | */ |
7afd2b58 | 1080 | bool BeginBold() { return GetBuffer().BeginBold(); } |
23324ae1 FM |
1081 | |
1082 | /** | |
7afd2b58 | 1083 | Ends using bold. |
23324ae1 | 1084 | */ |
7afd2b58 | 1085 | bool EndBold() { return GetBuffer().EndBold(); } |
23324ae1 FM |
1086 | |
1087 | /** | |
7afd2b58 | 1088 | Begins using italic. |
23324ae1 | 1089 | */ |
7afd2b58 | 1090 | bool BeginItalic() { return GetBuffer().BeginItalic(); } |
23324ae1 FM |
1091 | |
1092 | /** | |
7afd2b58 | 1093 | Ends using italic. |
23324ae1 | 1094 | */ |
7afd2b58 | 1095 | bool EndItalic() { return GetBuffer().EndItalic(); } |
23324ae1 FM |
1096 | |
1097 | /** | |
7afd2b58 | 1098 | Begins using underlining. |
23324ae1 | 1099 | */ |
7afd2b58 | 1100 | bool BeginUnderline() { return GetBuffer().BeginUnderline(); } |
23324ae1 FM |
1101 | |
1102 | /** | |
7afd2b58 | 1103 | End applying underlining. |
23324ae1 | 1104 | */ |
7afd2b58 | 1105 | bool EndUnderline() { return GetBuffer().EndUnderline(); } |
23324ae1 FM |
1106 | |
1107 | /** | |
7afd2b58 | 1108 | Begins using the given point size. |
23324ae1 | 1109 | */ |
7afd2b58 | 1110 | bool BeginFontSize(int pointSize) { return GetBuffer().BeginFontSize(pointSize); } |
23324ae1 FM |
1111 | |
1112 | /** | |
7afd2b58 | 1113 | Ends using a point size. |
23324ae1 | 1114 | */ |
7afd2b58 | 1115 | bool EndFontSize() { return GetBuffer().EndFontSize(); } |
23324ae1 FM |
1116 | |
1117 | /** | |
7afd2b58 | 1118 | Begins using this font. |
23324ae1 | 1119 | */ |
7afd2b58 | 1120 | bool BeginFont(const wxFont& font) { return GetBuffer().BeginFont(font); } |
23324ae1 FM |
1121 | |
1122 | /** | |
7afd2b58 | 1123 | Ends using a font. |
23324ae1 | 1124 | */ |
7afd2b58 | 1125 | bool EndFont() { return GetBuffer().EndFont(); } |
23324ae1 FM |
1126 | |
1127 | /** | |
7afd2b58 | 1128 | Begins using this colour. |
23324ae1 | 1129 | */ |
7afd2b58 | 1130 | bool BeginTextColour(const wxColour& colour) { return GetBuffer().BeginTextColour(colour); } |
23324ae1 | 1131 | |
23324ae1 | 1132 | /** |
7afd2b58 JS |
1133 | Ends applying a text colour. |
1134 | */ | |
1135 | bool EndTextColour() { return GetBuffer().EndTextColour(); } | |
9e7ad1ca | 1136 | |
7afd2b58 JS |
1137 | /** |
1138 | Begins using alignment. | |
1139 | For alignment values, see wxTextAttr. | |
1140 | */ | |
1141 | bool BeginAlignment(wxTextAttrAlignment alignment) { return GetBuffer().BeginAlignment(alignment); } | |
9e7ad1ca | 1142 | |
7afd2b58 JS |
1143 | /** |
1144 | Ends alignment. | |
1145 | */ | |
1146 | bool EndAlignment() { return GetBuffer().EndAlignment(); } | |
9e7ad1ca | 1147 | |
7afd2b58 JS |
1148 | /** |
1149 | Begins applying a left indent and subindent in tenths of a millimetre. | |
1150 | The subindent is an offset from the left edge of the paragraph, and is | |
1151 | used for all but the first line in a paragraph. A positive value will | |
1152 | cause the first line to appear to the left of the subsequent lines, and | |
1153 | a negative value will cause the first line to be indented to the right | |
1154 | of the subsequent lines. | |
1155 | ||
1156 | wxRichTextBuffer uses indentation to render a bulleted item. The | |
1157 | content of the paragraph, including the first line, starts at the | |
1158 | @a leftIndent plus the @a leftSubIndent. | |
1159 | ||
1160 | @param leftIndent | |
1161 | The distance between the margin and the bullet. | |
1162 | @param leftSubIndent | |
1163 | The distance between the left edge of the bullet and the left edge | |
1164 | of the actual paragraph. | |
23324ae1 | 1165 | */ |
7afd2b58 | 1166 | bool BeginLeftIndent(int leftIndent, int leftSubIndent = 0) { return GetBuffer().BeginLeftIndent(leftIndent, leftSubIndent); } |
23324ae1 FM |
1167 | |
1168 | /** | |
7afd2b58 | 1169 | Ends left indent. |
23324ae1 | 1170 | */ |
7afd2b58 | 1171 | bool EndLeftIndent() { return GetBuffer().EndLeftIndent(); } |
23324ae1 FM |
1172 | |
1173 | /** | |
7afd2b58 | 1174 | Begins a right indent, specified in tenths of a millimetre. |
23324ae1 | 1175 | */ |
7afd2b58 | 1176 | bool BeginRightIndent(int rightIndent) { return GetBuffer().BeginRightIndent(rightIndent); } |
23324ae1 FM |
1177 | |
1178 | /** | |
7afd2b58 | 1179 | Ends right indent. |
23324ae1 | 1180 | */ |
7afd2b58 | 1181 | bool EndRightIndent() { return GetBuffer().EndRightIndent(); } |
23324ae1 FM |
1182 | |
1183 | /** | |
7afd2b58 JS |
1184 | Begins paragraph spacing; pass the before-paragraph and after-paragraph spacing |
1185 | in tenths of a millimetre. | |
23324ae1 | 1186 | */ |
7afd2b58 | 1187 | bool BeginParagraphSpacing(int before, int after) { return GetBuffer().BeginParagraphSpacing(before, after); } |
23324ae1 FM |
1188 | |
1189 | /** | |
7afd2b58 | 1190 | Ends paragraph spacing. |
23324ae1 | 1191 | */ |
7afd2b58 | 1192 | bool EndParagraphSpacing() { return GetBuffer().EndParagraphSpacing(); } |
23324ae1 FM |
1193 | |
1194 | /** | |
7afd2b58 JS |
1195 | Begins appling line spacing. @e spacing is a multiple, where 10 means |
1196 | single-spacing, 15 means 1.5 spacing, and 20 means double spacing. | |
1197 | ||
1198 | The ::wxTextAttrLineSpacing constants are defined for convenience. | |
23324ae1 | 1199 | */ |
7afd2b58 | 1200 | bool BeginLineSpacing(int lineSpacing) { return GetBuffer().BeginLineSpacing(lineSpacing); } |
23324ae1 FM |
1201 | |
1202 | /** | |
7afd2b58 | 1203 | Ends line spacing. |
23324ae1 | 1204 | */ |
7afd2b58 | 1205 | bool EndLineSpacing() { return GetBuffer().EndLineSpacing(); } |
23324ae1 FM |
1206 | |
1207 | /** | |
7afd2b58 JS |
1208 | Begins a numbered bullet. |
1209 | ||
1210 | This call will be needed for each item in the list, and the | |
1211 | application should take care of incrementing the numbering. | |
1212 | ||
1213 | @a bulletNumber is a number, usually starting with 1. | |
1214 | @a leftIndent and @a leftSubIndent are values in tenths of a millimetre. | |
1215 | @a bulletStyle is a bitlist of the ::wxTextAttrBulletStyle values. | |
1216 | ||
1217 | wxRichTextBuffer uses indentation to render a bulleted item. | |
1218 | The left indent is the distance between the margin and the bullet. | |
1219 | The content of the paragraph, including the first line, starts | |
1220 | at leftMargin + leftSubIndent. | |
1221 | So the distance between the left edge of the bullet and the | |
1222 | left of the actual paragraph is leftSubIndent. | |
23324ae1 | 1223 | */ |
7afd2b58 JS |
1224 | bool BeginNumberedBullet(int bulletNumber, int leftIndent, int leftSubIndent, int bulletStyle = wxTEXT_ATTR_BULLET_STYLE_ARABIC|wxTEXT_ATTR_BULLET_STYLE_PERIOD) |
1225 | { return GetBuffer().BeginNumberedBullet(bulletNumber, leftIndent, leftSubIndent, bulletStyle); } | |
23324ae1 FM |
1226 | |
1227 | /** | |
7afd2b58 | 1228 | Ends application of a numbered bullet. |
23324ae1 | 1229 | */ |
7afd2b58 | 1230 | bool EndNumberedBullet() { return GetBuffer().EndNumberedBullet(); } |
23324ae1 FM |
1231 | |
1232 | /** | |
7afd2b58 JS |
1233 | Begins applying a symbol bullet, using a character from the current font. |
1234 | See BeginNumberedBullet() for an explanation of how indentation is used | |
1235 | to render the bulleted paragraph. | |
23324ae1 | 1236 | */ |
7afd2b58 JS |
1237 | bool BeginSymbolBullet(const wxString& symbol, int leftIndent, int leftSubIndent, int bulletStyle = wxTEXT_ATTR_BULLET_STYLE_SYMBOL) |
1238 | { return GetBuffer().BeginSymbolBullet(symbol, leftIndent, leftSubIndent, bulletStyle); } | |
23324ae1 FM |
1239 | |
1240 | /** | |
7afd2b58 | 1241 | Ends applying a symbol bullet. |
23324ae1 | 1242 | */ |
7afd2b58 | 1243 | bool EndSymbolBullet() { return GetBuffer().EndSymbolBullet(); } |
23324ae1 FM |
1244 | |
1245 | /** | |
7afd2b58 | 1246 | Begins applying a symbol bullet. |
23324ae1 | 1247 | */ |
7afd2b58 JS |
1248 | bool BeginStandardBullet(const wxString& bulletName, int leftIndent, int leftSubIndent, int bulletStyle = wxTEXT_ATTR_BULLET_STYLE_STANDARD) |
1249 | { return GetBuffer().BeginStandardBullet(bulletName, leftIndent, leftSubIndent, bulletStyle); } | |
23324ae1 FM |
1250 | |
1251 | /** | |
7afd2b58 | 1252 | Begins applying a standard bullet. |
23324ae1 | 1253 | */ |
7afd2b58 | 1254 | bool EndStandardBullet() { return GetBuffer().EndStandardBullet(); } |
23324ae1 FM |
1255 | |
1256 | /** | |
7afd2b58 | 1257 | Begins using the named character style. |
23324ae1 | 1258 | */ |
7afd2b58 | 1259 | bool BeginCharacterStyle(const wxString& characterStyle) { return GetBuffer().BeginCharacterStyle(characterStyle); } |
23324ae1 FM |
1260 | |
1261 | /** | |
7afd2b58 | 1262 | Ends application of a named character style. |
23324ae1 | 1263 | */ |
7afd2b58 | 1264 | bool EndCharacterStyle() { return GetBuffer().EndCharacterStyle(); } |
23324ae1 FM |
1265 | |
1266 | /** | |
7afd2b58 | 1267 | Begins applying the named paragraph style. |
23324ae1 | 1268 | */ |
7afd2b58 | 1269 | bool BeginParagraphStyle(const wxString& paragraphStyle) { return GetBuffer().BeginParagraphStyle(paragraphStyle); } |
23324ae1 FM |
1270 | |
1271 | /** | |
7afd2b58 | 1272 | Ends application of a named paragraph style. |
23324ae1 | 1273 | */ |
7afd2b58 | 1274 | bool EndParagraphStyle() { return GetBuffer().EndParagraphStyle(); } |
23324ae1 FM |
1275 | |
1276 | /** | |
7afd2b58 JS |
1277 | Begins using a specified list style. |
1278 | Optionally, you can also pass a level and a number. | |
23324ae1 | 1279 | */ |
7afd2b58 | 1280 | bool BeginListStyle(const wxString& listStyle, int level = 1, int number = 1) { return GetBuffer().BeginListStyle(listStyle, level, number); } |
23324ae1 FM |
1281 | |
1282 | /** | |
7afd2b58 | 1283 | Ends using a specified list style. |
23324ae1 | 1284 | */ |
7afd2b58 | 1285 | bool EndListStyle() { return GetBuffer().EndListStyle(); } |
23324ae1 | 1286 | |
826c4761 | 1287 | /** |
7afd2b58 | 1288 | Begins applying wxTEXT_ATTR_URL to the content. |
826c4761 | 1289 | |
7afd2b58 JS |
1290 | Pass a URL and optionally, a character style to apply, since it is common |
1291 | to mark a URL with a familiar style such as blue text with underlining. | |
826c4761 | 1292 | */ |
7afd2b58 | 1293 | bool BeginURL(const wxString& url, const wxString& characterStyle = wxEmptyString) { return GetBuffer().BeginURL(url, characterStyle); } |
826c4761 | 1294 | |
23324ae1 | 1295 | /** |
7afd2b58 | 1296 | Ends applying a URL. |
23324ae1 | 1297 | */ |
7afd2b58 | 1298 | bool EndURL() { return GetBuffer().EndURL(); } |
23324ae1 FM |
1299 | |
1300 | /** | |
7afd2b58 | 1301 | Sets the default style to the style under the cursor. |
23324ae1 | 1302 | */ |
7afd2b58 | 1303 | bool SetDefaultStyleToCursorStyle(); |
23324ae1 FM |
1304 | |
1305 | /** | |
7afd2b58 | 1306 | Cancels any selection. |
23324ae1 | 1307 | */ |
7afd2b58 | 1308 | virtual void SelectNone(); |
23324ae1 | 1309 | |
23324ae1 | 1310 | /** |
7afd2b58 | 1311 | Selects the word at the given character position. |
23324ae1 | 1312 | */ |
7afd2b58 | 1313 | virtual bool SelectWord(long position); |
23324ae1 FM |
1314 | |
1315 | /** | |
7afd2b58 JS |
1316 | Returns the selection range in character positions. -1, -1 means no selection. |
1317 | ||
1318 | The range is in API convention, i.e. a single character selection is denoted | |
1319 | by (n, n+1) | |
23324ae1 | 1320 | */ |
7afd2b58 | 1321 | wxRichTextRange GetSelectionRange() const; |
23324ae1 FM |
1322 | |
1323 | /** | |
7afd2b58 JS |
1324 | Sets the selection to the given range. |
1325 | The end point of range is specified as the last character position of the span | |
1326 | of text, plus one. | |
1327 | ||
1328 | So, for example, to set the selection for a character at position 5, use the | |
1329 | range (5,6). | |
23324ae1 | 1330 | */ |
7afd2b58 | 1331 | void SetSelectionRange(const wxRichTextRange& range); |
23324ae1 FM |
1332 | |
1333 | /** | |
7afd2b58 JS |
1334 | Returns the selection range in character positions. -2, -2 means no selection |
1335 | -1, -1 means select everything. | |
1336 | The range is in internal format, i.e. a single character selection is denoted | |
1337 | by (n, n) | |
23324ae1 | 1338 | */ |
7afd2b58 | 1339 | wxRichTextRange GetInternalSelectionRange() const { return m_selection.GetRange(); } |
23324ae1 FM |
1340 | |
1341 | /** | |
7afd2b58 JS |
1342 | Sets the selection range in character positions. -2, -2 means no selection |
1343 | -1, -1 means select everything. | |
1344 | The range is in internal format, i.e. a single character selection is denoted | |
1345 | by (n, n) | |
23324ae1 | 1346 | */ |
7afd2b58 | 1347 | void SetInternalSelectionRange(const wxRichTextRange& range) { m_selection.Set(range, GetFocusObject()); } |
23324ae1 FM |
1348 | |
1349 | /** | |
7afd2b58 | 1350 | Adds a new paragraph of text to the end of the buffer. |
23324ae1 | 1351 | */ |
7afd2b58 | 1352 | virtual wxRichTextRange AddParagraph(const wxString& text); |
23324ae1 FM |
1353 | |
1354 | /** | |
7afd2b58 | 1355 | Adds an image to the control's buffer. |
23324ae1 | 1356 | */ |
7afd2b58 | 1357 | virtual wxRichTextRange AddImage(const wxImage& image); |
23324ae1 FM |
1358 | |
1359 | /** | |
7afd2b58 JS |
1360 | Lays out the buffer, which must be done before certain operations, such as |
1361 | setting the caret position. | |
1362 | This function should not normally be required by the application. | |
23324ae1 | 1363 | */ |
7afd2b58 | 1364 | virtual bool LayoutContent(bool onlyVisibleRect = false); |
23324ae1 FM |
1365 | |
1366 | /** | |
7afd2b58 | 1367 | Move the caret to the given character position. |
9e7ad1ca | 1368 | |
7afd2b58 JS |
1369 | Please note that this does not update the current editing style |
1370 | from the new position; to do that, call wxRichTextCtrl::SetInsertionPoint instead. | |
23324ae1 | 1371 | */ |
7afd2b58 | 1372 | virtual bool MoveCaret(long pos, bool showAtLineStart = false, wxRichTextParagraphLayoutBox* container = NULL); |
23324ae1 FM |
1373 | |
1374 | /** | |
7afd2b58 | 1375 | Moves right. |
23324ae1 | 1376 | */ |
7afd2b58 | 1377 | virtual bool MoveRight(int noPositions = 1, int flags = 0); |
23324ae1 FM |
1378 | |
1379 | /** | |
7afd2b58 JS |
1380 | Moves left. |
1381 | */ | |
1382 | virtual bool MoveLeft(int noPositions = 1, int flags = 0); | |
346c54a4 | 1383 | |
7afd2b58 JS |
1384 | /** |
1385 | Moves to the start of the paragraph. | |
23324ae1 | 1386 | */ |
7afd2b58 | 1387 | virtual bool MoveUp(int noLines = 1, int flags = 0); |
23324ae1 FM |
1388 | |
1389 | /** | |
7afd2b58 | 1390 | Moves the caret down. |
23324ae1 | 1391 | */ |
7afd2b58 | 1392 | virtual bool MoveDown(int noLines = 1, int flags = 0); |
23324ae1 FM |
1393 | |
1394 | /** | |
7afd2b58 | 1395 | Moves to the end of the line. |
23324ae1 | 1396 | */ |
7afd2b58 | 1397 | virtual bool MoveToLineEnd(int flags = 0); |
23324ae1 FM |
1398 | |
1399 | /** | |
7afd2b58 | 1400 | Moves to the start of the line. |
23324ae1 | 1401 | */ |
7afd2b58 | 1402 | virtual bool MoveToLineStart(int flags = 0); |
23324ae1 FM |
1403 | |
1404 | /** | |
7afd2b58 | 1405 | Moves to the end of the paragraph. |
23324ae1 | 1406 | */ |
7afd2b58 | 1407 | virtual bool MoveToParagraphEnd(int flags = 0); |
23324ae1 FM |
1408 | |
1409 | /** | |
7afd2b58 | 1410 | Moves to the start of the paragraph. |
23324ae1 | 1411 | */ |
7afd2b58 | 1412 | virtual bool MoveToParagraphStart(int flags = 0); |
23324ae1 FM |
1413 | |
1414 | /** | |
7afd2b58 | 1415 | Moves to the start of the buffer. |
23324ae1 | 1416 | */ |
7afd2b58 | 1417 | virtual bool MoveHome(int flags = 0); |
23324ae1 FM |
1418 | |
1419 | /** | |
7afd2b58 JS |
1420 | Moves to the end of the buffer. |
1421 | */ | |
1422 | virtual bool MoveEnd(int flags = 0); | |
9e7ad1ca | 1423 | |
7afd2b58 JS |
1424 | /** |
1425 | Moves one or more pages up. | |
23324ae1 | 1426 | */ |
7afd2b58 | 1427 | virtual bool PageUp(int noPages = 1, int flags = 0); |
23324ae1 FM |
1428 | |
1429 | /** | |
7afd2b58 | 1430 | Moves one or more pages down. |
23324ae1 | 1431 | */ |
7afd2b58 | 1432 | virtual bool PageDown(int noPages = 1, int flags = 0); |
23324ae1 FM |
1433 | |
1434 | /** | |
7afd2b58 | 1435 | Moves a number of words to the left. |
23324ae1 | 1436 | */ |
7afd2b58 | 1437 | virtual bool WordLeft(int noPages = 1, int flags = 0); |
23324ae1 | 1438 | |
23324ae1 | 1439 | /** |
7afd2b58 JS |
1440 | Move a nuber of words to the right. |
1441 | */ | |
1442 | virtual bool WordRight(int noPages = 1, int flags = 0); | |
9e7ad1ca | 1443 | |
7afd2b58 JS |
1444 | //@{ |
1445 | /** | |
1446 | Returns the buffer associated with the control. | |
23324ae1 | 1447 | */ |
7afd2b58 JS |
1448 | wxRichTextBuffer& GetBuffer() { return m_buffer; } |
1449 | const wxRichTextBuffer& GetBuffer() const { return m_buffer; } | |
23324ae1 FM |
1450 | //@} |
1451 | ||
1452 | /** | |
7afd2b58 JS |
1453 | Starts batching undo history for commands. |
1454 | */ | |
1455 | virtual bool BeginBatchUndo(const wxString& cmdName) { return m_buffer.BeginBatchUndo(cmdName); } | |
9e7ad1ca | 1456 | |
7afd2b58 JS |
1457 | /** |
1458 | Ends batching undo command history. | |
23324ae1 | 1459 | */ |
7afd2b58 | 1460 | virtual bool EndBatchUndo() { return m_buffer.EndBatchUndo(); } |
23324ae1 FM |
1461 | |
1462 | /** | |
7afd2b58 JS |
1463 | Returns @true if undo commands are being batched. |
1464 | */ | |
1465 | virtual bool BatchingUndo() const { return m_buffer.BatchingUndo(); } | |
9e7ad1ca | 1466 | |
7afd2b58 JS |
1467 | /** |
1468 | Starts suppressing undo history for commands. | |
23324ae1 | 1469 | */ |
7afd2b58 | 1470 | virtual bool BeginSuppressUndo() { return m_buffer.BeginSuppressUndo(); } |
23324ae1 | 1471 | |
23324ae1 | 1472 | /** |
7afd2b58 JS |
1473 | Ends suppressing undo command history. |
1474 | */ | |
1475 | virtual bool EndSuppressUndo() { return m_buffer.EndSuppressUndo(); } | |
9e7ad1ca | 1476 | |
7afd2b58 JS |
1477 | /** |
1478 | Returns @true if undo history suppression is on. | |
23324ae1 | 1479 | */ |
7afd2b58 | 1480 | virtual bool SuppressingUndo() const { return m_buffer.SuppressingUndo(); } |
23324ae1 | 1481 | |
23324ae1 | 1482 | /** |
7afd2b58 JS |
1483 | Test if this whole range has character attributes of the specified kind. |
1484 | If any of the attributes are different within the range, the test fails. | |
9e7ad1ca | 1485 | |
7afd2b58 JS |
1486 | You can use this to implement, for example, bold button updating. |
1487 | @a style must have flags indicating which attributes are of interest. | |
1488 | */ | |
1489 | virtual bool HasCharacterAttributes(const wxRichTextRange& range, const wxRichTextAttr& style) const | |
1490 | { | |
1491 | return GetBuffer().HasCharacterAttributes(range.ToInternal(), style); | |
1492 | } | |
9e7ad1ca | 1493 | |
7afd2b58 JS |
1494 | /** |
1495 | Test if this whole range has paragraph attributes of the specified kind. | |
1496 | If any of the attributes are different within the range, the test fails. | |
1497 | You can use this to implement, for example, centering button updating. | |
1498 | @a style must have flags indicating which attributes are of interest. | |
1499 | */ | |
1500 | virtual bool HasParagraphAttributes(const wxRichTextRange& range, const wxRichTextAttr& style) const | |
1501 | { | |
1502 | return GetBuffer().HasParagraphAttributes(range.ToInternal(), style); | |
1503 | } | |
1504 | ||
1505 | /** | |
4f51b983 | 1506 | Returns @true if all of the selection, or the content at the caret position, is bold. |
7afd2b58 JS |
1507 | */ |
1508 | virtual bool IsSelectionBold(); | |
1509 | ||
1510 | /** | |
4f51b983 | 1511 | Returns @true if all of the selection, or the content at the caret position, is italic. |
7afd2b58 JS |
1512 | */ |
1513 | virtual bool IsSelectionItalics(); | |
1514 | ||
1515 | /** | |
4f51b983 | 1516 | Returns @true if all of the selection, or the content at the caret position, is underlined. |
7afd2b58 JS |
1517 | */ |
1518 | virtual bool IsSelectionUnderlined(); | |
1519 | ||
75936ec6 | 1520 | /** |
4f51b983 | 1521 | Returns @true if all of the selection, or the content at the current caret position, has the supplied wxTextAttrEffects flag(s). |
75936ec6 JS |
1522 | */ |
1523 | virtual bool DoesSelectionHaveTextEffectFlag(int flag); | |
1524 | ||
7afd2b58 JS |
1525 | /** |
1526 | Returns @true if all of the selection is aligned according to the specified flag. | |
1527 | */ | |
1528 | virtual bool IsSelectionAligned(wxTextAttrAlignment alignment); | |
1529 | ||
1530 | /** | |
4f51b983 | 1531 | Apples bold to the selection or the default style (undoable). |
7afd2b58 JS |
1532 | */ |
1533 | virtual bool ApplyBoldToSelection(); | |
1534 | ||
1535 | /** | |
4f51b983 | 1536 | Applies italic to the selection or the default style (undoable). |
7afd2b58 JS |
1537 | */ |
1538 | virtual bool ApplyItalicToSelection(); | |
1539 | ||
1540 | /** | |
4f51b983 | 1541 | Applies underline to the selection or the default style (undoable). |
7afd2b58 JS |
1542 | */ |
1543 | virtual bool ApplyUnderlineToSelection(); | |
1544 | ||
75936ec6 JS |
1545 | /** |
1546 | Applies one or more wxTextAttrEffects flags to the selection (undoable). | |
4f51b983 | 1547 | If there is no selection, it is applied to the default style. |
75936ec6 JS |
1548 | */ |
1549 | virtual bool ApplyTextEffectToSelection(int flags); | |
1550 | ||
7afd2b58 | 1551 | /** |
4f51b983 | 1552 | Applies the given alignment to the selection or the default style (undoable). |
7afd2b58 JS |
1553 | For alignment values, see wxTextAttr. |
1554 | */ | |
1555 | virtual bool ApplyAlignmentToSelection(wxTextAttrAlignment alignment); | |
1556 | ||
1557 | /** | |
1558 | Applies the style sheet to the buffer, matching paragraph styles in the sheet | |
1559 | against named styles in the buffer. | |
1560 | ||
1561 | This might be useful if the styles have changed. | |
1562 | If @a sheet is @NULL, the sheet set with SetStyleSheet() is used. | |
1563 | Currently this applies paragraph styles only. | |
23324ae1 | 1564 | */ |
7afd2b58 | 1565 | virtual bool ApplyStyle(wxRichTextStyleDefinition* def); |
23324ae1 FM |
1566 | |
1567 | /** | |
9e7ad1ca FM |
1568 | Sets the style sheet associated with the control. |
1569 | A style sheet allows named character and paragraph styles to be applied. | |
23324ae1 | 1570 | */ |
7afd2b58 | 1571 | void SetStyleSheet(wxRichTextStyleSheet* styleSheet) { GetBuffer().SetStyleSheet(styleSheet); } |
23324ae1 FM |
1572 | |
1573 | /** | |
7afd2b58 JS |
1574 | Returns the style sheet associated with the control, if any. |
1575 | A style sheet allows named character and paragraph styles to be applied. | |
23324ae1 | 1576 | */ |
7afd2b58 | 1577 | wxRichTextStyleSheet* GetStyleSheet() const { return GetBuffer().GetStyleSheet(); } |
23324ae1 FM |
1578 | |
1579 | /** | |
7afd2b58 | 1580 | Push the style sheet to top of stack. |
23324ae1 | 1581 | */ |
7afd2b58 | 1582 | bool PushStyleSheet(wxRichTextStyleSheet* styleSheet) { return GetBuffer().PushStyleSheet(styleSheet); } |
23324ae1 FM |
1583 | |
1584 | /** | |
7afd2b58 | 1585 | Pops the style sheet from top of stack. |
23324ae1 | 1586 | */ |
7afd2b58 | 1587 | wxRichTextStyleSheet* PopStyleSheet() { return GetBuffer().PopStyleSheet(); } |
23324ae1 FM |
1588 | |
1589 | /** | |
7afd2b58 | 1590 | Applies the style sheet to the buffer, for example if the styles have changed. |
23324ae1 | 1591 | */ |
7afd2b58 JS |
1592 | bool ApplyStyleSheet(wxRichTextStyleSheet* styleSheet = NULL); |
1593 | ||
9b794421 JS |
1594 | /** |
1595 | Shows the given context menu, optionally adding appropriate property-editing commands for the current position in the object hierarchy. | |
1596 | */ | |
1597 | virtual bool ShowContextMenu(wxMenu* menu, const wxPoint& pt, bool addPropertyCommands); | |
1598 | ||
1599 | /** | |
1600 | Prepares the context menu, optionally adding appropriate property-editing commands. | |
1601 | Returns the number of property commands added. | |
1602 | */ | |
1603 | virtual int PrepareContextMenu(wxMenu* menu, const wxPoint& pt, bool addPropertyCommands); | |
1604 | ||
303f0be7 JS |
1605 | /** |
1606 | Returns @true if we can edit the object's properties via a GUI. | |
1607 | */ | |
590a0f8b | 1608 | virtual bool CanEditProperties(wxRichTextObject* obj) const; |
303f0be7 JS |
1609 | |
1610 | /** | |
1611 | Edits the object's properties via a GUI. | |
1612 | */ | |
590a0f8b JS |
1613 | virtual bool EditProperties(wxRichTextObject* obj, wxWindow* parent); |
1614 | ||
1615 | /** | |
1616 | Gets the object's properties menu label. | |
1617 | */ | |
1618 | virtual wxString GetPropertiesMenuLabel(wxRichTextObject* obj); | |
303f0be7 | 1619 | |
cc2aecde JS |
1620 | /** |
1621 | Prepares the content just before insertion (or after buffer reset). Called by the same function in wxRichTextBuffer. | |
1622 | Currently is only called if undo mode is on. | |
1623 | */ | |
1624 | virtual void PrepareContent(wxRichTextParagraphLayoutBox& WXUNUSED(container)) {} | |
1625 | ||
1626 | /** | |
1627 | Can we delete this range? | |
1628 | Sends an event to the control. | |
1629 | */ | |
1630 | virtual bool CanDeleteRange(wxRichTextParagraphLayoutBox& container, const wxRichTextRange& range) const; | |
1631 | ||
1632 | /** | |
1633 | Can we insert content at this position? | |
1634 | Sends an event to the control. | |
1635 | */ | |
1636 | virtual bool CanInsertContent(wxRichTextParagraphLayoutBox& container, long pos) const; | |
1637 | ||
12f5219f JS |
1638 | /** |
1639 | Enable or disable the vertical scrollbar. | |
1640 | */ | |
1641 | virtual void EnableVerticalScrollbar(bool enable); | |
1642 | ||
1643 | /** | |
1644 | Returns @true if the vertical scrollbar is enabled. | |
1645 | */ | |
1646 | virtual bool GetVerticalScrollbarEnabled() const; | |
1647 | ||
7afd2b58 | 1648 | // Command handlers |
23324ae1 FM |
1649 | |
1650 | /** | |
7afd2b58 | 1651 | Sends the event to the control. |
23324ae1 | 1652 | */ |
7afd2b58 | 1653 | void Command(wxCommandEvent& event); |
23324ae1 FM |
1654 | |
1655 | /** | |
7afd2b58 | 1656 | Loads the first dropped file. |
23324ae1 | 1657 | */ |
7afd2b58 JS |
1658 | void OnDropFiles(wxDropFilesEvent& event); |
1659 | ||
1660 | void OnCaptureLost(wxMouseCaptureLostEvent& event); | |
1661 | void OnSysColourChanged(wxSysColourChangedEvent& event); | |
23324ae1 FM |
1662 | |
1663 | /** | |
7afd2b58 | 1664 | Standard handler for the wxID_CUT command. |
23324ae1 | 1665 | */ |
7afd2b58 | 1666 | void OnCut(wxCommandEvent& event); |
23324ae1 FM |
1667 | |
1668 | /** | |
7afd2b58 | 1669 | Standard handler for the wxID_COPY command. |
23324ae1 | 1670 | */ |
7afd2b58 | 1671 | void OnCopy(wxCommandEvent& event); |
23324ae1 | 1672 | |
23324ae1 | 1673 | /** |
7afd2b58 | 1674 | Standard handler for the wxID_PASTE command. |
23324ae1 | 1675 | */ |
7afd2b58 | 1676 | void OnPaste(wxCommandEvent& event); |
9e7ad1ca FM |
1677 | |
1678 | /** | |
7afd2b58 | 1679 | Standard handler for the wxID_UNDO command. |
9e7ad1ca | 1680 | */ |
7afd2b58 | 1681 | void OnUndo(wxCommandEvent& event); |
9e7ad1ca | 1682 | |
9e7ad1ca | 1683 | /** |
7afd2b58 | 1684 | Standard handler for the wxID_REDO command. |
9e7ad1ca | 1685 | */ |
7afd2b58 | 1686 | void OnRedo(wxCommandEvent& event); |
23324ae1 FM |
1687 | |
1688 | /** | |
7afd2b58 | 1689 | Standard handler for the wxID_SELECTALL command. |
23324ae1 | 1690 | */ |
7afd2b58 | 1691 | void OnSelectAll(wxCommandEvent& event); |
23324ae1 FM |
1692 | |
1693 | /** | |
7afd2b58 | 1694 | Standard handler for property commands. |
23324ae1 | 1695 | */ |
7afd2b58 | 1696 | void OnProperties(wxCommandEvent& event); |
5e6e278d | 1697 | |
7afd2b58 JS |
1698 | /** |
1699 | Standard handler for the wxID_CLEAR command. | |
1700 | */ | |
1701 | void OnClear(wxCommandEvent& event); | |
5e6e278d FM |
1702 | |
1703 | /** | |
7afd2b58 JS |
1704 | Standard update handler for the wxID_CUT command. |
1705 | */ | |
1706 | void OnUpdateCut(wxUpdateUIEvent& event); | |
1707 | ||
1708 | /** | |
1709 | Standard update handler for the wxID_COPY command. | |
1710 | */ | |
1711 | void OnUpdateCopy(wxUpdateUIEvent& event); | |
1712 | ||
1713 | /** | |
1714 | Standard update handler for the wxID_PASTE command. | |
1715 | */ | |
1716 | void OnUpdatePaste(wxUpdateUIEvent& event); | |
1717 | ||
1718 | /** | |
1719 | Standard update handler for the wxID_UNDO command. | |
1720 | */ | |
1721 | void OnUpdateUndo(wxUpdateUIEvent& event); | |
1722 | ||
1723 | /** | |
1724 | Standard update handler for the wxID_REDO command. | |
1725 | */ | |
1726 | void OnUpdateRedo(wxUpdateUIEvent& event); | |
1727 | ||
1728 | /** | |
1729 | Standard update handler for the wxID_SELECTALL command. | |
1730 | */ | |
1731 | void OnUpdateSelectAll(wxUpdateUIEvent& event); | |
1732 | ||
1733 | /** | |
1734 | Standard update handler for property commands. | |
1735 | */ | |
1736 | ||
1737 | void OnUpdateProperties(wxUpdateUIEvent& event); | |
1738 | ||
1739 | /** | |
1740 | Standard update handler for the wxID_CLEAR command. | |
1741 | */ | |
1742 | void OnUpdateClear(wxUpdateUIEvent& event); | |
1743 | ||
1744 | /** | |
1745 | Shows a standard context menu with undo, redo, cut, copy, paste, clear, and | |
1746 | select all commands. | |
1747 | */ | |
1748 | void OnContextMenu(wxContextMenuEvent& event); | |
1749 | ||
1750 | // Event handlers | |
1751 | ||
1752 | // Painting | |
1753 | void OnPaint(wxPaintEvent& event); | |
1754 | void OnEraseBackground(wxEraseEvent& event); | |
1755 | ||
1756 | // Left-click | |
1757 | void OnLeftClick(wxMouseEvent& event); | |
1758 | ||
1759 | // Left-up | |
1760 | void OnLeftUp(wxMouseEvent& event); | |
1761 | ||
1762 | // Motion | |
1763 | void OnMoveMouse(wxMouseEvent& event); | |
1764 | ||
1765 | // Left-double-click | |
1766 | void OnLeftDClick(wxMouseEvent& event); | |
1767 | ||
1768 | // Middle-click | |
1769 | void OnMiddleClick(wxMouseEvent& event); | |
1770 | ||
1771 | // Right-click | |
1772 | void OnRightClick(wxMouseEvent& event); | |
1773 | ||
1774 | // Key press | |
1775 | void OnChar(wxKeyEvent& event); | |
1776 | ||
1777 | // Sizing | |
1778 | void OnSize(wxSizeEvent& event); | |
1779 | ||
1780 | // Setting/losing focus | |
1781 | void OnSetFocus(wxFocusEvent& event); | |
1782 | void OnKillFocus(wxFocusEvent& event); | |
1783 | ||
1784 | // Idle-time processing | |
1785 | void OnIdle(wxIdleEvent& event); | |
1786 | ||
1787 | // Scrolling | |
1788 | void OnScroll(wxScrollWinEvent& event); | |
1789 | ||
1790 | /** | |
1791 | Sets the font, and also the basic and default attributes | |
1792 | (see wxRichTextCtrl::SetDefaultStyle). | |
5e6e278d | 1793 | */ |
7afd2b58 JS |
1794 | virtual bool SetFont(const wxFont& font); |
1795 | ||
1796 | /** | |
1797 | A helper function setting up scrollbars, for example after a resize. | |
1798 | */ | |
1799 | virtual void SetupScrollbars(bool atTop = false); | |
1800 | ||
1801 | /** | |
1802 | Helper function implementing keyboard navigation. | |
1803 | */ | |
1804 | virtual bool KeyboardNavigate(int keyCode, int flags); | |
5e6e278d FM |
1805 | |
1806 | /** | |
7afd2b58 | 1807 | Paints the background. |
5e6e278d | 1808 | */ |
7afd2b58 JS |
1809 | virtual void PaintBackground(wxDC& dc); |
1810 | ||
1811 | /** | |
1812 | Other user defined painting after everything else (i.e. all text) is painted. | |
1813 | ||
1814 | @since 2.9.1 | |
1815 | */ | |
1816 | virtual void PaintAboveContent(wxDC& WXUNUSED(dc)) {} | |
1817 | ||
1818 | #if wxRICHTEXT_BUFFERED_PAINTING | |
1819 | /** | |
1820 | Recreates the buffer bitmap if necessary. | |
1821 | */ | |
1822 | virtual bool RecreateBuffer(const wxSize& size = wxDefaultSize); | |
1823 | #endif | |
1824 | ||
1825 | // Write text | |
1826 | virtual void DoWriteText(const wxString& value, int flags = 0); | |
1827 | ||
1828 | // Should we inherit colours? | |
1829 | virtual bool ShouldInheritColours() const { return false; } | |
1830 | ||
1831 | /** | |
1832 | Internal function to position the visible caret according to the current caret | |
1833 | position. | |
1834 | */ | |
1835 | virtual void PositionCaret(wxRichTextParagraphLayoutBox* container = NULL); | |
1836 | ||
1837 | /** | |
1838 | Helper function for extending the selection, returning @true if the selection | |
1839 | was changed. Selections are in caret positions. | |
1840 | */ | |
1841 | virtual bool ExtendSelection(long oldPosition, long newPosition, int flags); | |
1842 | ||
1843 | /** | |
1844 | Scrolls @a position into view. This function takes a caret position. | |
1845 | */ | |
1846 | virtual bool ScrollIntoView(long position, int keyCode); | |
1847 | ||
1848 | /** | |
1849 | Refreshes the area affected by a selection change. | |
1850 | */ | |
1851 | bool RefreshForSelectionChange(const wxRichTextSelection& oldSelection, const wxRichTextSelection& newSelection); | |
1852 | ||
1853 | /** | |
1854 | Sets the caret position. | |
1855 | ||
1856 | The caret position is the character position just before the caret. | |
1857 | A value of -1 means the caret is at the start of the buffer. | |
1858 | Please note that this does not update the current editing style | |
1859 | from the new position or cause the actual caret to be refreshed; to do that, | |
1860 | call wxRichTextCtrl::SetInsertionPoint instead. | |
1861 | */ | |
1862 | void SetCaretPosition(long position, bool showAtLineStart = false) ; | |
1863 | ||
1864 | /** | |
1865 | Returns the current caret position. | |
1866 | */ | |
1867 | long GetCaretPosition() const { return m_caretPosition; } | |
1868 | ||
1869 | /** | |
1870 | The adjusted caret position is the character position adjusted to take | |
1871 | into account whether we're at the start of a paragraph, in which case | |
1872 | style information should be taken from the next position, not current one. | |
1873 | */ | |
1874 | long GetAdjustedCaretPosition(long caretPos) const; | |
1875 | ||
1876 | /** | |
1877 | Move the caret one visual step forward: this may mean setting a flag | |
1878 | and keeping the same position if we're going from the end of one line | |
1879 | to the start of the next, which may be the exact same caret position. | |
1880 | */ | |
1881 | void MoveCaretForward(long oldPosition) ; | |
1882 | ||
1883 | /** | |
1884 | Move the caret one visual step forward: this may mean setting a flag | |
1885 | and keeping the same position if we're going from the end of one line | |
1886 | to the start of the next, which may be the exact same caret position. | |
1887 | */ | |
1888 | void MoveCaretBack(long oldPosition) ; | |
1889 | ||
1890 | /** | |
1891 | Returns the caret height and position for the given character position. | |
1892 | If container is null, the current focus object will be used. | |
1893 | ||
1894 | @beginWxPerlOnly | |
1895 | In wxPerl this method is implemented as | |
1896 | GetCaretPositionForIndex(@a position) returning a | |
1897 | 2-element list (ok, rect). | |
1898 | @endWxPerlOnly | |
1899 | */ | |
1900 | bool GetCaretPositionForIndex(long position, wxRect& rect, wxRichTextParagraphLayoutBox* container = NULL); | |
1901 | ||
1902 | /** | |
1903 | Internal helper function returning the line for the visible caret position. | |
1904 | If the caret is shown at the very end of the line, it means the next character | |
1905 | is actually on the following line. | |
1906 | So this function gets the line we're expecting to find if this is the case. | |
1907 | */ | |
1908 | wxRichTextLine* GetVisibleLineForCaretPosition(long caretPosition) const; | |
1909 | ||
1910 | /** | |
1911 | Gets the command processor associated with the control's buffer. | |
1912 | */ | |
1913 | wxCommandProcessor* GetCommandProcessor() const { return GetBuffer().GetCommandProcessor(); } | |
1914 | ||
1915 | /** | |
1916 | Deletes content if there is a selection, e.g. when pressing a key. | |
1917 | Returns the new caret position in @e newPos, or leaves it if there | |
1918 | was no action. This is undoable. | |
1919 | ||
1920 | @beginWxPerlOnly | |
1921 | In wxPerl this method takes no arguments and returns a 2-element | |
1922 | list (ok, newPos). | |
1923 | @endWxPerlOnly | |
1924 | */ | |
1925 | bool DeleteSelectedContent(long* newPos= NULL); | |
1926 | ||
1927 | /** | |
1928 | Transforms logical (unscrolled) position to physical window position. | |
1929 | */ | |
1930 | wxPoint GetPhysicalPoint(const wxPoint& ptLogical) const; | |
1931 | ||
1932 | /** | |
1933 | Transforms physical window position to logical (unscrolled) position. | |
1934 | */ | |
1935 | wxPoint GetLogicalPoint(const wxPoint& ptPhysical) const; | |
1936 | ||
1937 | /** | |
1938 | Helper function for finding the caret position for the next word. | |
1939 | Direction is 1 (forward) or -1 (backwards). | |
1940 | */ | |
1941 | virtual long FindNextWordPosition(int direction = 1) const; | |
1942 | ||
1943 | /** | |
1944 | Returns @true if the given position is visible on the screen. | |
1945 | */ | |
1946 | bool IsPositionVisible(long pos) const; | |
1947 | ||
1948 | /** | |
1949 | Returns the first visible position in the current view. | |
1950 | */ | |
1951 | long GetFirstVisiblePosition() const; | |
1952 | ||
1953 | /** | |
1954 | Returns the caret position since the default formatting was changed. As | |
1955 | soon as this position changes, we no longer reflect the default style | |
1956 | in the UI. A value of -2 means that we should only reflect the style of the | |
1957 | content under the caret. | |
1958 | */ | |
1959 | long GetCaretPositionForDefaultStyle() const { return m_caretPositionForDefaultStyle; } | |
1960 | ||
1961 | /** | |
1962 | Set the caret position for the default style that the user is selecting. | |
1963 | */ | |
1964 | void SetCaretPositionForDefaultStyle(long pos) { m_caretPositionForDefaultStyle = pos; } | |
1965 | ||
1966 | /** | |
1967 | Returns @true if the user has recently set the default style without moving | |
1968 | the caret, and therefore the UI needs to reflect the default style and not | |
1969 | the style at the caret. | |
1970 | ||
1971 | Below is an example of code that uses this function to determine whether the UI | |
1972 | should show that the current style is bold. | |
1973 | ||
1974 | @see SetAndShowDefaultStyle(). | |
1975 | */ | |
1976 | bool IsDefaultStyleShowing() const { return m_caretPositionForDefaultStyle != -2; } | |
1977 | ||
1978 | /** | |
1979 | Sets @a attr as the default style and tells the control that the UI should | |
1980 | reflect this attribute until the user moves the caret. | |
1981 | ||
1982 | @see IsDefaultStyleShowing(). | |
1983 | */ | |
1984 | void SetAndShowDefaultStyle(const wxRichTextAttr& attr) | |
1985 | { | |
1986 | SetDefaultStyle(attr); | |
1987 | SetCaretPositionForDefaultStyle(GetCaretPosition()); | |
1988 | } | |
1989 | ||
1990 | /** | |
1991 | Returns the first visible point in the window. | |
1992 | */ | |
1993 | wxPoint GetFirstVisiblePoint() const; | |
1994 | ||
1995 | #ifdef DOXYGEN | |
1996 | /** | |
1997 | Returns the content of the entire control as a string. | |
1998 | */ | |
1999 | virtual wxString GetValue() const; | |
2000 | ||
2001 | /** | |
2002 | Replaces existing content with the given text. | |
2003 | */ | |
2004 | virtual void SetValue(const wxString& value); | |
2005 | ||
2006 | /** | |
2007 | Call this function to prevent refresh and allow fast updates, and then Thaw() to | |
2008 | refresh the control. | |
2009 | */ | |
2010 | void Freeze(); | |
2011 | ||
2012 | /** | |
2013 | Call this function to end a Freeze and refresh the display. | |
2014 | */ | |
2015 | void Thaw(); | |
2016 | ||
2017 | /** | |
2018 | Returns @true if Freeze has been called without a Thaw. | |
2019 | */ | |
2020 | bool IsFrozen() const; | |
2021 | ||
2022 | #endif | |
2023 | ||
2024 | // Implementation | |
2025 | ||
2026 | /** | |
2027 | Sets up the caret for the given position and container, after a mouse click. | |
2028 | */ | |
2029 | bool SetCaretPositionAfterClick(wxRichTextParagraphLayoutBox* container, long position, int hitTestFlags, bool extendSelection = false); | |
2030 | ||
2031 | /** | |
2032 | Find the caret position for the combination of hit-test flags and character position. | |
2033 | Returns the caret position and also an indication of where to place the caret (caretLineStart) | |
2034 | since this is ambiguous (same position used for end of line and start of next). | |
2035 | */ | |
2036 | long FindCaretPositionForCharacterPosition(long position, int hitTestFlags, wxRichTextParagraphLayoutBox* container, | |
2037 | bool& caretLineStart); | |
2038 | ||
590a0f8b JS |
2039 | /** |
2040 | Processes mouse movement in order to change the cursor | |
2041 | */ | |
2042 | virtual bool ProcessMouseMovement(wxRichTextParagraphLayoutBox* container, wxRichTextObject* obj, long position, const wxPoint& pos); | |
2043 | ||
7afd2b58 JS |
2044 | /** |
2045 | Font names take a long time to retrieve, so cache them (on demand). | |
2046 | */ | |
2047 | static const wxArrayString& GetAvailableFontNames(); | |
2048 | ||
2049 | /** | |
2050 | Clears the cache of available font names. | |
2051 | */ | |
2052 | static void ClearAvailableFontNames(); | |
2053 | ||
2054 | WX_FORWARD_TO_SCROLL_HELPER() | |
2055 | ||
2056 | // implement wxTextEntry methods | |
2057 | virtual wxString DoGetValue() const; | |
2058 | ||
2059 | protected: | |
2060 | // implement the wxTextEntry pure virtual method | |
2061 | virtual wxWindow *GetEditableWindow() { return this; } | |
2062 | ||
2063 | // margins functions | |
2064 | virtual bool DoSetMargins(const wxPoint& pt); | |
2065 | virtual wxPoint DoGetMargins() const; | |
2066 | ||
2067 | // FIXME: this does not work, it allows this code to compile but will fail | |
2068 | // during run-time | |
2069 | #ifndef __WXUNIVERSAL__ | |
2070 | #ifdef __WXMSW__ | |
2071 | virtual WXHWND GetEditHWND() const { return GetHWND(); } | |
2072 | #endif | |
2073 | #ifdef __WXMOTIF__ | |
2074 | virtual WXWidget GetTextWidget() const { return NULL; } | |
2075 | #endif | |
2076 | #ifdef __WXGTK20__ | |
2077 | virtual GtkEditable *GetEditable() const { return NULL; } | |
2078 | virtual GtkEntry *GetEntry() const { return NULL; } | |
2079 | #endif | |
2080 | #endif // !__WXUNIVERSAL__ | |
2081 | ||
2082 | // Overrides | |
2083 | protected: | |
2084 | ||
2085 | /** | |
2086 | Currently this simply returns @c wxSize(10, 10). | |
2087 | */ | |
2088 | virtual wxSize DoGetBestSize() const ; | |
2089 | ||
2090 | virtual void DoSetValue(const wxString& value, int flags = 0); | |
2091 | ||
2092 | virtual void DoThaw(); | |
2093 | ||
2094 | ||
2095 | // Data members | |
0c0e063e | 2096 | protected: |
7afd2b58 JS |
2097 | #if wxRICHTEXT_BUFFERED_PAINTING |
2098 | /// Buffer bitmap | |
2099 | wxBitmap m_bufferBitmap; | |
2100 | #endif | |
2101 | ||
2102 | /// Text buffer | |
2103 | wxRichTextBuffer m_buffer; | |
2104 | ||
2105 | wxMenu* m_contextMenu; | |
2106 | ||
2107 | /// Caret position (1 less than the character position, so -1 is the | |
2108 | /// first caret position). | |
2109 | long m_caretPosition; | |
2110 | ||
2111 | /// Caret position when the default formatting has been changed. As | |
2112 | /// soon as this position changes, we no longer reflect the default style | |
2113 | /// in the UI. | |
2114 | long m_caretPositionForDefaultStyle; | |
2115 | ||
2116 | /// Selection range in character positions. -2, -2 means no selection. | |
2117 | wxRichTextSelection m_selection; | |
2118 | ||
2119 | wxRichTextCtrlSelectionState m_selectionState; | |
2120 | ||
2121 | /// Anchor so we know how to extend the selection | |
2122 | /// It's a caret position since it's between two characters. | |
2123 | long m_selectionAnchor; | |
2124 | ||
2125 | /// Anchor object if selecting multiple container objects, such as grid cells. | |
2126 | wxRichTextObject* m_selectionAnchorObject; | |
2127 | ||
2128 | /// Are we editable? | |
2129 | bool m_editable; | |
2130 | ||
2131 | /// Are we showing the caret position at the start of a line | |
2132 | /// instead of at the end of the previous one? | |
2133 | bool m_caretAtLineStart; | |
2134 | ||
2135 | /// Are we dragging a selection? | |
2136 | bool m_dragging; | |
2137 | ||
7afd2b58 JS |
2138 | /// Do we need full layout in idle? |
2139 | bool m_fullLayoutRequired; | |
2140 | wxLongLong m_fullLayoutTime; | |
2141 | long m_fullLayoutSavedPosition; | |
2142 | ||
2143 | /// Threshold for doing delayed layout | |
2144 | long m_delayedLayoutThreshold; | |
2145 | ||
2146 | /// Cursors | |
2147 | wxCursor m_textCursor; | |
2148 | wxCursor m_urlCursor; | |
2149 | ||
2150 | static wxArrayString sm_availableFontNames; | |
2151 | ||
2152 | wxRichTextContextMenuPropertiesInfo m_contextMenuPropertiesInfo; | |
2153 | ||
2154 | /// The object that currently has the editing focus | |
2155 | wxRichTextParagraphLayoutBox* m_focusObject; | |
2156 | }; | |
2157 | ||
2158 | /** | |
2159 | @class wxRichTextEvent | |
2160 | ||
2161 | This is the event class for wxRichTextCtrl notifications. | |
2162 | ||
2163 | @beginEventTable{wxRichTextEvent} | |
2164 | @event{EVT_RICHTEXT_LEFT_CLICK(id, func)} | |
2165 | Process a @c wxEVT_COMMAND_RICHTEXT_LEFT_CLICK event, generated when the user | |
2166 | releases the left mouse button over an object. | |
2167 | @event{EVT_RICHTEXT_RIGHT_CLICK(id, func)} | |
2168 | Process a @c wxEVT_COMMAND_RICHTEXT_RIGHT_CLICK event, generated when the user | |
2169 | releases the right mouse button over an object. | |
2170 | @event{EVT_RICHTEXT_MIDDLE_CLICK(id, func)} | |
2171 | Process a @c wxEVT_COMMAND_RICHTEXT_MIDDLE_CLICK event, generated when the user | |
2172 | releases the middle mouse button over an object. | |
2173 | @event{EVT_RICHTEXT_LEFT_DCLICK(id, func)} | |
b099835e | 2174 | Process a @c wxEVT_COMMAND_RICHTEXT_LEFT_DCLICK event, generated when the user |
7afd2b58 JS |
2175 | double-clicks an object. |
2176 | @event{EVT_RICHTEXT_RETURN(id, func)} | |
2177 | Process a @c wxEVT_COMMAND_RICHTEXT_RETURN event, generated when the user | |
2178 | presses the return key. Valid event functions: GetFlags, GetPosition. | |
2179 | @event{EVT_RICHTEXT_CHARACTER(id, func)} | |
2180 | Process a @c wxEVT_COMMAND_RICHTEXT_CHARACTER event, generated when the user | |
2181 | presses a character key. Valid event functions: GetFlags, GetPosition, GetCharacter. | |
2182 | @event{EVT_RICHTEXT_DELETE(id, func)} | |
2183 | Process a @c wxEVT_COMMAND_RICHTEXT_DELETE event, generated when the user | |
2184 | presses the backspace or delete key. Valid event functions: GetFlags, GetPosition. | |
2185 | @event{EVT_RICHTEXT_RETURN(id, func)} | |
2186 | Process a @c wxEVT_COMMAND_RICHTEXT_RETURN event, generated when the user | |
2187 | presses the return key. Valid event functions: GetFlags, GetPosition. | |
2188 | @event{EVT_RICHTEXT_STYLE_CHANGED(id, func)} | |
2189 | Process a @c wxEVT_COMMAND_RICHTEXT_STYLE_CHANGED event, generated when | |
2190 | styling has been applied to the control. Valid event functions: GetPosition, GetRange. | |
2191 | @event{EVT_RICHTEXT_STYLESHEET_CHANGED(id, func)} | |
2192 | Process a @c wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGING event, generated | |
2193 | when the control's stylesheet has changed, for example the user added, | |
2194 | edited or deleted a style. Valid event functions: GetRange, GetPosition. | |
2195 | @event{EVT_RICHTEXT_STYLESHEET_REPLACING(id, func)} | |
2196 | Process a @c wxEVT_COMMAND_RICHTEXT_STYLESHEET_REPLACING event, generated | |
2197 | when the control's stylesheet is about to be replaced, for example when | |
2198 | a file is loaded into the control. | |
2199 | Valid event functions: Veto, GetOldStyleSheet, GetNewStyleSheet. | |
2200 | @event{EVT_RICHTEXT_STYLESHEET_REPLACED(id, func)} | |
2201 | Process a @c wxEVT_COMMAND_RICHTEXT_STYLESHEET_REPLACED event, generated | |
2202 | when the control's stylesheet has been replaced, for example when a file | |
2203 | is loaded into the control. | |
2204 | Valid event functions: GetOldStyleSheet, GetNewStyleSheet. | |
590a0f8b JS |
2205 | @event{EVT_RICHTEXT_PROPERTIES_CHANGED(id, func)} |
2206 | Process a @c wxEVT_COMMAND_RICHTEXT_PROPERTIES_CHANGED event, generated when | |
2207 | properties have been applied to the control. Valid event functions: GetPosition, GetRange. | |
7afd2b58 JS |
2208 | @event{EVT_RICHTEXT_CONTENT_INSERTED(id, func)} |
2209 | Process a @c wxEVT_COMMAND_RICHTEXT_CONTENT_INSERTED event, generated when | |
2210 | content has been inserted into the control. | |
2211 | Valid event functions: GetPosition, GetRange. | |
2212 | @event{EVT_RICHTEXT_CONTENT_DELETED(id, func)} | |
2213 | Process a @c wxEVT_COMMAND_RICHTEXT_CONTENT_DELETED event, generated when | |
2214 | content has been deleted from the control. | |
2215 | Valid event functions: GetPosition, GetRange. | |
2216 | @event{EVT_RICHTEXT_BUFFER_RESET(id, func)} | |
2217 | Process a @c wxEVT_COMMAND_RICHTEXT_BUFFER_RESET event, generated when the | |
2218 | buffer has been reset by deleting all content. | |
2219 | You can use this to set a default style for the first new paragraph. | |
2220 | @event{EVT_RICHTEXT_SELECTION_CHANGED(id, func)} | |
2221 | Process a @c wxEVT_COMMAND_RICHTEXT_SELECTION_CHANGED event, generated when the | |
2222 | selection range has changed. | |
2223 | @event{EVT_RICHTEXT_FOCUS_OBJECT_CHANGED(id, func)} | |
2224 | Process a @c wxEVT_COMMAND_RICHTEXT_FOCUS_OBJECT_CHANGED event, generated when the | |
2225 | current focus object has changed. | |
2226 | @endEventTable | |
2227 | ||
2228 | @library{wxrichtext} | |
2229 | @category{events,richtext} | |
2230 | */ | |
2231 | ||
2232 | class WXDLLIMPEXP_RICHTEXT wxRichTextEvent : public wxNotifyEvent | |
2233 | { | |
2234 | public: | |
2235 | /** | |
2236 | Constructor. | |
2237 | ||
2238 | @param commandType | |
2239 | The type of the event. | |
2240 | @param id | |
2241 | Window identifier. The value @c wxID_ANY indicates a default value. | |
2242 | */ | |
2243 | wxRichTextEvent(wxEventType commandType = wxEVT_NULL, int winid = 0) | |
2244 | : wxNotifyEvent(commandType, winid), | |
2245 | m_flags(0), m_position(-1), m_oldStyleSheet(NULL), m_newStyleSheet(NULL), | |
2246 | m_char((wxChar) 0), m_container(NULL), m_oldContainer(NULL) | |
2247 | { } | |
2248 | ||
2249 | /** | |
2250 | Copy constructor. | |
2251 | */ | |
2252 | wxRichTextEvent(const wxRichTextEvent& event) | |
2253 | : wxNotifyEvent(event), | |
2254 | m_flags(event.m_flags), m_position(-1), | |
2255 | m_oldStyleSheet(event.m_oldStyleSheet), m_newStyleSheet(event.m_newStyleSheet), | |
2256 | m_char((wxChar) 0), m_container(event.m_container), m_oldContainer(event.m_oldContainer) | |
2257 | { } | |
2258 | ||
2259 | /** | |
f090e4ef | 2260 | Returns the buffer position at which the event occurred. |
7afd2b58 JS |
2261 | */ |
2262 | long GetPosition() const { return m_position; } | |
2263 | ||
2264 | /** | |
2265 | Sets the buffer position variable. | |
2266 | */ | |
2267 | void SetPosition(long pos) { m_position = pos; } | |
2268 | ||
2269 | /** | |
2270 | Returns flags indicating modifier keys pressed. | |
2271 | ||
2272 | Possible values are @c wxRICHTEXT_CTRL_DOWN, @c wxRICHTEXT_SHIFT_DOWN, and @c wxRICHTEXT_ALT_DOWN. | |
2273 | */ | |
2274 | int GetFlags() const { return m_flags; } | |
2275 | ||
2276 | /** | |
2277 | Sets flags indicating modifier keys pressed. | |
2278 | ||
2279 | Possible values are @c wxRICHTEXT_CTRL_DOWN, @c wxRICHTEXT_SHIFT_DOWN, and @c wxRICHTEXT_ALT_DOWN. | |
2280 | */ | |
2281 | void SetFlags(int flags) { m_flags = flags; } | |
2282 | ||
2283 | /** | |
2284 | Returns the old style sheet. | |
2285 | ||
2286 | Can be used in a @c wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGING or | |
2287 | @c wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGED event handler. | |
2288 | */ | |
2289 | wxRichTextStyleSheet* GetOldStyleSheet() const { return m_oldStyleSheet; } | |
2290 | ||
2291 | /** | |
2292 | Sets the old style sheet variable. | |
2293 | */ | |
2294 | void SetOldStyleSheet(wxRichTextStyleSheet* sheet) { m_oldStyleSheet = sheet; } | |
2295 | ||
2296 | /** | |
2297 | Returns the new style sheet. | |
2298 | ||
2299 | Can be used in a @c wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGING or | |
2300 | @c wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGED event handler. | |
2301 | */ | |
2302 | wxRichTextStyleSheet* GetNewStyleSheet() const { return m_newStyleSheet; } | |
2303 | ||
2304 | /** | |
2305 | Sets the new style sheet variable. | |
2306 | */ | |
2307 | void SetNewStyleSheet(wxRichTextStyleSheet* sheet) { m_newStyleSheet = sheet; } | |
2308 | ||
2309 | /** | |
2310 | Gets the range for the current operation. | |
2311 | */ | |
2312 | const wxRichTextRange& GetRange() const { return m_range; } | |
2313 | ||
2314 | /** | |
2315 | Sets the range variable. | |
2316 | */ | |
2317 | void SetRange(const wxRichTextRange& range) { m_range = range; } | |
2318 | ||
2319 | /** | |
2320 | Returns the character pressed, within a @c wxEVT_COMMAND_RICHTEXT_CHARACTER event. | |
2321 | */ | |
2322 | wxChar GetCharacter() const { return m_char; } | |
2323 | ||
2324 | /** | |
2325 | Sets the character variable. | |
2326 | */ | |
2327 | void SetCharacter(wxChar ch) { m_char = ch; } | |
2328 | ||
2329 | /** | |
2330 | Returns the container for which the event is relevant. | |
2331 | */ | |
2332 | wxRichTextParagraphLayoutBox* GetContainer() const { return m_container; } | |
2333 | ||
2334 | /** | |
2335 | Sets the container for which the event is relevant. | |
2336 | */ | |
2337 | void SetContainer(wxRichTextParagraphLayoutBox* container) { m_container = container; } | |
2338 | ||
2339 | /** | |
2340 | Returns the old container, for a focus change event. | |
2341 | */ | |
2342 | wxRichTextParagraphLayoutBox* GetOldContainer() const { return m_oldContainer; } | |
2343 | ||
2344 | /** | |
2345 | Sets the old container, for a focus change event. | |
2346 | */ | |
2347 | void SetOldContainer(wxRichTextParagraphLayoutBox* container) { m_oldContainer = container; } | |
2348 | ||
2349 | virtual wxEvent *Clone() const { return new wxRichTextEvent(*this); } | |
2350 | ||
2351 | protected: | |
2352 | int m_flags; | |
2353 | long m_position; | |
2354 | wxRichTextStyleSheet* m_oldStyleSheet; | |
2355 | wxRichTextStyleSheet* m_newStyleSheet; | |
2356 | wxRichTextRange m_range; | |
2357 | wxChar m_char; | |
2358 | wxRichTextParagraphLayoutBox* m_container; | |
2359 | wxRichTextParagraphLayoutBox* m_oldContainer; | |
2360 | ||
2361 | private: | |
2362 | DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxRichTextEvent) | |
23324ae1 | 2363 | }; |