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