Commit | Line | Data |
---|---|---|
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 | |
3e3a754f JS |
24 | #if !defined(__WXGTK__) && !defined(__WXMAC__) |
25 | #define wxRICHTEXT_BUFFERED_PAINTING 1 | |
26 | #else | |
27 | #define wxRICHTEXT_BUFFERED_PAINTING 0 | |
28 | #endif | |
29 | ||
b5dbe15d | 30 | class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextStyleDefinition; |
ab14c7aa | 31 | |
5d7836c4 JS |
32 | /*! |
33 | * Styles and flags | |
34 | */ | |
35 | ||
36 | /* Styles | |
37 | */ | |
38 | ||
39 | #define wxRE_READONLY 0x0010 | |
40 | #define wxRE_MULTILINE 0x0020 | |
e9f10004 JS |
41 | #define wxRE_CENTRE_CARET 0x8000 |
42 | #define wxRE_CENTER_CARET wxRE_CENTRE_CARET | |
5d7836c4 JS |
43 | |
44 | /* Flags | |
45 | */ | |
46 | ||
47 | #define wxRICHTEXT_SHIFT_DOWN 0x01 | |
48 | #define wxRICHTEXT_CTRL_DOWN 0x02 | |
49 | #define wxRICHTEXT_ALT_DOWN 0x04 | |
50 | ||
51 | /* Defaults | |
52 | */ | |
53 | ||
54 | #define wxRICHTEXT_DEFAULT_OVERALL_SIZE wxSize(-1, -1) | |
55 | #define wxRICHTEXT_DEFAULT_IMAGE_SIZE wxSize(80, 80) | |
56 | #define wxRICHTEXT_DEFAULT_SPACING 3 | |
57 | #define wxRICHTEXT_DEFAULT_MARGIN 3 | |
58 | #define wxRICHTEXT_DEFAULT_UNFOCUSSED_BACKGROUND wxColour(175, 175, 175) | |
59 | #define wxRICHTEXT_DEFAULT_FOCUSSED_BACKGROUND wxColour(140, 140, 140) | |
60 | #define wxRICHTEXT_DEFAULT_UNSELECTED_BACKGROUND wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE) | |
61 | #define wxRICHTEXT_DEFAULT_TYPE_COLOUR wxColour(0, 0, 200) | |
62 | #define wxRICHTEXT_DEFAULT_FOCUS_RECT_COLOUR wxColour(100, 80, 80) | |
63 | #define wxRICHTEXT_DEFAULT_CARET_WIDTH 2 | |
4d551ad5 JS |
64 | // Minimum buffer size before delayed layout kicks in |
65 | #define wxRICHTEXT_DEFAULT_DELAYED_LAYOUT_THRESHOLD 20000 | |
66 | // Milliseconds before layout occurs after resize | |
67 | #define wxRICHTEXT_DEFAULT_LAYOUT_INTERVAL 50 | |
5d7836c4 JS |
68 | |
69 | /*! | |
70 | * Forward declarations | |
71 | */ | |
72 | ||
73 | /*! | |
74 | * wxRichTextItem class declaration | |
75 | */ | |
76 | ||
77 | // Drawing styles/states | |
78 | #define wxRICHTEXT_SELECTED 0x01 | |
79 | #define wxRICHTEXT_TAGGED 0x02 | |
80 | // The control is focussed | |
81 | #define wxRICHTEXT_FOCUSSED 0x04 | |
82 | // The item itself has the focus | |
83 | #define wxRICHTEXT_IS_FOCUS 0x08 | |
84 | ||
85 | /*! | |
86 | * wxRichTextCtrl class declaration | |
87 | */ | |
88 | ||
f5172305 | 89 | class WXDLLIMPEXP_RICHTEXT wxRichTextCtrl : public wxTextCtrlBase, |
343ae70d | 90 | public wxScrollHelper |
7fe8059f | 91 | { |
5d7836c4 JS |
92 | DECLARE_CLASS( wxRichTextCtrl ) |
93 | DECLARE_EVENT_TABLE() | |
94 | ||
95 | public: | |
96 | // Constructors | |
97 | ||
98 | wxRichTextCtrl( ); | |
27e20452 | 99 | wxRichTextCtrl( wxWindow* parent, wxWindowID id = -1, const wxString& value = wxEmptyString, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, |
4e8d9558 JS |
100 | long style = wxRE_MULTILINE, const wxValidator& validator = wxDefaultValidator, const wxString& name = wxTextCtrlNameStr); |
101 | ||
d3c7fc99 | 102 | virtual ~wxRichTextCtrl( ); |
5d7836c4 JS |
103 | |
104 | // Operations | |
105 | ||
106 | /// Creation | |
27e20452 | 107 | bool Create( wxWindow* parent, wxWindowID id = -1, const wxString& value = wxEmptyString, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, |
4e8d9558 | 108 | long style = wxRE_MULTILINE, const wxValidator& validator = wxDefaultValidator, const wxString& name = wxTextCtrlNameStr ); |
5d7836c4 JS |
109 | |
110 | /// Member initialisation | |
111 | void Init(); | |
112 | ||
113 | ///// wxTextCtrl compatibility | |
114 | ||
115 | // Accessors | |
116 | ||
5d7836c4 JS |
117 | virtual wxString GetRange(long from, long to) const; |
118 | ||
119 | virtual int GetLineLength(long lineNo) const ; | |
120 | virtual wxString GetLineText(long lineNo) const ; | |
121 | virtual int GetNumberOfLines() const ; | |
122 | ||
123 | virtual bool IsModified() const ; | |
124 | virtual bool IsEditable() const ; | |
125 | ||
126 | // more readable flag testing methods | |
127 | bool IsSingleLine() const { return !HasFlag(wxRE_MULTILINE); } | |
128 | bool IsMultiLine() const { return !IsSingleLine(); } | |
129 | ||
130 | // If the return values from and to are the same, there is no selection. | |
131 | virtual void GetSelection(long* from, long* to) const; | |
132 | ||
133 | virtual wxString GetStringSelection() const; | |
134 | ||
135 | /// Get filename | |
136 | wxString GetFilename() const { return m_filename; } | |
137 | ||
138 | /// Set filename | |
139 | void SetFilename(const wxString& filename) { m_filename = filename; } | |
140 | ||
4d551ad5 JS |
141 | /// Set the threshold in character positions for doing layout optimization during sizing |
142 | void SetDelayedLayoutThreshold(long threshold) { m_delayedLayoutThreshold = threshold; } | |
143 | ||
144 | /// Get the threshold in character positions for doing layout optimization during sizing | |
145 | long GetDelayedLayoutThreshold() const { return m_delayedLayoutThreshold; } | |
146 | ||
c2a4fabb JS |
147 | /// Set text cursor |
148 | void SetTextCursor(const wxCursor& cursor ) { m_textCursor = cursor; } | |
149 | ||
150 | /// Get text cursor | |
151 | wxCursor GetTextCursor() const { return m_textCursor; } | |
152 | ||
153 | /// Set URL cursor | |
154 | void SetURLCursor(const wxCursor& cursor ) { m_urlCursor = cursor; } | |
155 | ||
156 | /// Get URL cursor | |
157 | wxCursor GetURLCursor() const { return m_urlCursor; } | |
158 | ||
2f0baf97 JS |
159 | /// Are we showing the caret position at the start of a line |
160 | /// instead of at the end of the previous one? | |
161 | bool GetCaretAtLineStart() const { return m_caretAtLineStart; } | |
162 | void SetCaretAtLineStart(bool atStart) { m_caretAtLineStart = atStart; } | |
163 | ||
164 | /// Are we dragging a selection? | |
165 | bool GetDragging() const { return m_dragging; } | |
166 | void SetDragging(bool dragging) { m_dragging = dragging; } | |
167 | ||
168 | /// Get/set drag start position | |
169 | const wxPoint& GetDragStart() const { return m_dragStart; } | |
170 | void SetDragStart(const wxPoint& pt) { m_dragStart = pt; } | |
171 | ||
c631741b | 172 | #if wxRICHTEXT_BUFFERED_PAINTING |
2f0baf97 JS |
173 | /// Get the buffer bitmap |
174 | const wxBitmap& GetBufferBitmap() const { return m_bufferBitmap; } | |
175 | wxBitmap& GetBufferBitmap() { return m_bufferBitmap; } | |
c631741b | 176 | #endif |
2f0baf97 JS |
177 | |
178 | /// Get/set context menu | |
179 | wxMenu* GetContextMenu() const { return m_contextMenu; } | |
8e43fc77 | 180 | void SetContextMenu(wxMenu* menu); |
2f0baf97 JS |
181 | |
182 | /// Anchor so we know how to extend the selection | |
183 | /// It's a caret position since it's between two characters. | |
184 | long GetSelectionAnchor() const { return m_selectionAnchor; } | |
185 | void SetSelectionAnchor(long anchor) { m_selectionAnchor = anchor; } | |
186 | ||
5d7836c4 JS |
187 | // Operations |
188 | ||
189 | // editing | |
190 | virtual void Clear(); | |
191 | virtual void Replace(long from, long to, const wxString& value); | |
192 | virtual void Remove(long from, long to); | |
193 | ||
194 | // load/save the controls contents from/to the file | |
3306aec1 | 195 | virtual bool DoLoadFile(const wxString& file, int fileType); |
d75a69e8 FM |
196 | virtual bool DoSaveFile(const wxString& file = wxEmptyString, |
197 | int fileType = wxRICHTEXT_TYPE_ANY); | |
5d7836c4 | 198 | |
d2d0adc7 JS |
199 | /// Set the handler flags, controlling loading and saving |
200 | void SetHandlerFlags(int flags) { GetBuffer().SetHandlerFlags(flags); } | |
201 | ||
202 | /// Get the handler flags, controlling loading and saving | |
203 | int GetHandlerFlags() const { return GetBuffer().GetHandlerFlags(); } | |
204 | ||
5d7836c4 JS |
205 | // sets/clears the dirty flag |
206 | virtual void MarkDirty(); | |
207 | virtual void DiscardEdits(); | |
208 | ||
209 | // set the max number of characters which may be entered in a single line | |
210 | // text control | |
211 | virtual void SetMaxLength(unsigned long WXUNUSED(len)) { } | |
212 | ||
213 | // writing text inserts it at the current position, appending always | |
214 | // inserts it at the end | |
215 | virtual void WriteText(const wxString& text); | |
216 | virtual void AppendText(const wxString& text); | |
217 | ||
218 | // text control under some platforms supports the text styles: these | |
219 | // methods allow to apply the given text style to the given selection or to | |
220 | // set/get the style which will be used for all appended text | |
27e20452 | 221 | virtual bool SetStyle(long start, long end, const wxTextAttr& style); |
44cc96a8 | 222 | virtual bool SetStyle(const wxRichTextRange& range, const wxTextAttr& style); |
3966a9f4 | 223 | virtual bool GetStyle(long position, wxTextAttr& style); |
fe5aa22c | 224 | |
a7ed48a5 | 225 | // get the common set of styles for the range |
44cc96a8 | 226 | virtual bool GetStyleForRange(const wxRichTextRange& range, wxTextAttr& style); |
3e3a754f JS |
227 | // extended style setting operation with flags including: |
228 | // wxRICHTEXT_SETSTYLE_WITH_UNDO, wxRICHTEXT_SETSTYLE_OPTIMIZE, wxRICHTEXT_SETSTYLE_PARAGRAPHS_ONLY, wxRICHTEXT_SETSTYLE_CHARACTERS_ONLY | |
229 | // see richtextbuffer.h for more details. | |
44cc96a8 | 230 | virtual bool SetStyleEx(const wxRichTextRange& range, const wxTextAttr& style, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO); |
3e3a754f | 231 | |
fe5aa22c JS |
232 | /// Get the content (uncombined) attributes for this position. |
233 | virtual bool GetUncombinedStyle(long position, wxTextAttr& style); | |
fe5aa22c | 234 | |
27e20452 | 235 | virtual bool SetDefaultStyle(const wxTextAttr& style); |
5d7836c4 | 236 | |
44cc96a8 JS |
237 | virtual const wxTextAttr& GetDefaultStyleEx() const { return GetDefaultStyle(); } |
238 | ||
27e20452 | 239 | virtual const wxTextAttr& GetDefaultStyle() const; |
5d7836c4 | 240 | |
38f833b1 JS |
241 | /// Set list style |
242 | virtual bool SetListStyle(const wxRichTextRange& range, wxRichTextListStyleDefinition* def, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom = 1, int specifiedLevel = -1); | |
243 | virtual bool SetListStyle(const wxRichTextRange& range, const wxString& defName, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom = 1, int specifiedLevel = -1); | |
244 | ||
245 | /// Clear list for given range | |
246 | virtual bool ClearListStyle(const wxRichTextRange& range, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO); | |
247 | ||
248 | /// Number/renumber any list elements in the given range | |
249 | /// def/defName can be NULL/empty to indicate that the existing list style should be used. | |
dadd4f55 | 250 | virtual bool NumberList(const wxRichTextRange& range, wxRichTextListStyleDefinition* def = NULL, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom = 1, int specifiedLevel = -1); |
38f833b1 JS |
251 | virtual bool NumberList(const wxRichTextRange& range, const wxString& defName, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom = 1, int specifiedLevel = -1); |
252 | ||
253 | /// Promote the list items within the given range. promoteBy can be a positive or negative number, e.g. 1 or -1 | |
254 | /// def/defName can be NULL/empty to indicate that the existing list style should be used. | |
dadd4f55 | 255 | virtual bool PromoteList(int promoteBy, const wxRichTextRange& range, wxRichTextListStyleDefinition* def = NULL, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int specifiedLevel = -1); |
38f833b1 JS |
256 | virtual bool PromoteList(int promoteBy, const wxRichTextRange& range, const wxString& defName, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int specifiedLevel = -1); |
257 | ||
12cc29c5 JS |
258 | /// Deletes the content in the given range |
259 | virtual bool Delete(const wxRichTextRange& range); | |
260 | ||
5d7836c4 JS |
261 | // translate between the position (which is just an index in the text ctrl |
262 | // considering all its contents as a single strings) and (x, y) coordinates | |
263 | // which represent column and line. | |
264 | virtual long XYToPosition(long x, long y) const; | |
265 | virtual bool PositionToXY(long pos, long *x, long *y) const; | |
266 | ||
267 | virtual void ShowPosition(long pos); | |
268 | ||
269 | // find the character at position given in pixels | |
270 | // | |
271 | // NB: pt is in device coords (not adjusted for the client area origin nor | |
272 | // scrolling) | |
273 | virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt, long *pos) const; | |
274 | virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt, | |
275 | wxTextCoord *col, | |
276 | wxTextCoord *row) const; | |
277 | ||
278 | // Clipboard operations | |
279 | virtual void Copy(); | |
280 | virtual void Cut(); | |
281 | virtual void Paste(); | |
282 | virtual void DeleteSelection(); | |
283 | ||
284 | virtual bool CanCopy() const; | |
285 | virtual bool CanCut() const; | |
286 | virtual bool CanPaste() const; | |
287 | virtual bool CanDeleteSelection() const; | |
288 | ||
289 | // Undo/redo | |
290 | virtual void Undo(); | |
291 | virtual void Redo(); | |
292 | ||
293 | virtual bool CanUndo() const; | |
294 | virtual bool CanRedo() const; | |
295 | ||
296 | // Insertion point | |
297 | virtual void SetInsertionPoint(long pos); | |
298 | virtual void SetInsertionPointEnd(); | |
299 | virtual long GetInsertionPoint() const; | |
300 | virtual wxTextPos GetLastPosition() const; | |
301 | ||
302 | virtual void SetSelection(long from, long to); | |
303 | virtual void SelectAll(); | |
304 | virtual void SetEditable(bool editable); | |
305 | ||
5d7836c4 JS |
306 | virtual bool HasSelection() const; |
307 | ||
308 | ///// Functionality specific to wxRichTextCtrl | |
309 | ||
310 | /// Write an image at the current insertion point. Supply optional type to use | |
311 | /// for internal and file storage of the raw data. | |
d75a69e8 | 312 | virtual bool WriteImage(const wxImage& image, wxBitmapType bitmapType = wxBITMAP_TYPE_PNG); |
5d7836c4 JS |
313 | |
314 | /// Write a bitmap at the current insertion point. Supply optional type to use | |
315 | /// for internal and file storage of the raw data. | |
d75a69e8 | 316 | virtual bool WriteImage(const wxBitmap& bitmap, wxBitmapType bitmapType = wxBITMAP_TYPE_PNG); |
5d7836c4 JS |
317 | |
318 | /// Load an image from file and write at the current insertion point. | |
d75a69e8 | 319 | virtual bool WriteImage(const wxString& filename, wxBitmapType bitmapType); |
5d7836c4 JS |
320 | |
321 | /// Write an image block at the current insertion point. | |
322 | virtual bool WriteImage(const wxRichTextImageBlock& imageBlock); | |
323 | ||
324 | /// Insert a newline (actually paragraph) at the current insertion point. | |
325 | virtual bool Newline(); | |
326 | ||
ff76711f JS |
327 | /// Insert a line break at the current insertion point. |
328 | virtual bool LineBreak(); | |
329 | ||
5d7836c4 | 330 | /// Set basic (overall) style |
44cc96a8 | 331 | virtual void SetBasicStyle(const wxTextAttr& style) { GetBuffer().SetBasicStyle(style); } |
5d7836c4 JS |
332 | |
333 | /// Get basic (overall) style | |
44cc96a8 | 334 | virtual const wxTextAttr& GetBasicStyle() const { return GetBuffer().GetBasicStyle(); } |
5d7836c4 | 335 | |
44cc96a8 | 336 | virtual bool BeginStyle(const wxTextAttr& style) { return GetBuffer().BeginStyle(style); } |
5d7836c4 JS |
337 | |
338 | /// End the style | |
339 | virtual bool EndStyle() { return GetBuffer().EndStyle(); } | |
340 | ||
341 | /// End all styles | |
342 | virtual bool EndAllStyles() { return GetBuffer().EndAllStyles(); } | |
343 | ||
344 | /// Begin using bold | |
345 | bool BeginBold() { return GetBuffer().BeginBold(); } | |
346 | ||
347 | /// End using bold | |
348 | bool EndBold() { return GetBuffer().EndBold(); } | |
349 | ||
350 | /// Begin using italic | |
351 | bool BeginItalic() { return GetBuffer().BeginItalic(); } | |
352 | ||
353 | /// End using italic | |
354 | bool EndItalic() { return GetBuffer().EndItalic(); } | |
355 | ||
356 | /// Begin using underline | |
357 | bool BeginUnderline() { return GetBuffer().BeginUnderline(); } | |
358 | ||
359 | /// End using underline | |
360 | bool EndUnderline() { return GetBuffer().EndUnderline(); } | |
361 | ||
362 | /// Begin using point size | |
363 | bool BeginFontSize(int pointSize) { return GetBuffer().BeginFontSize(pointSize); } | |
364 | ||
365 | /// End using point size | |
366 | bool EndFontSize() { return GetBuffer().EndFontSize(); } | |
367 | ||
368 | /// Begin using this font | |
369 | bool BeginFont(const wxFont& font) { return GetBuffer().BeginFont(font); } | |
370 | ||
371 | /// End using a font | |
372 | bool EndFont() { return GetBuffer().EndFont(); } | |
373 | ||
374 | /// Begin using this colour | |
375 | bool BeginTextColour(const wxColour& colour) { return GetBuffer().BeginTextColour(colour); } | |
376 | ||
377 | /// End using a colour | |
378 | bool EndTextColour() { return GetBuffer().EndTextColour(); } | |
379 | ||
380 | /// Begin using alignment | |
381 | bool BeginAlignment(wxTextAttrAlignment alignment) { return GetBuffer().BeginAlignment(alignment); } | |
382 | ||
383 | /// End alignment | |
384 | bool EndAlignment() { return GetBuffer().EndAlignment(); } | |
385 | ||
386 | /// Begin left indent | |
387 | bool BeginLeftIndent(int leftIndent, int leftSubIndent = 0) { return GetBuffer().BeginLeftIndent(leftIndent, leftSubIndent); } | |
388 | ||
389 | /// End left indent | |
390 | bool EndLeftIndent() { return GetBuffer().EndLeftIndent(); } | |
391 | ||
392 | /// Begin right indent | |
393 | bool BeginRightIndent(int rightIndent) { return GetBuffer().BeginRightIndent(rightIndent); } | |
394 | ||
395 | /// End right indent | |
396 | bool EndRightIndent() { return GetBuffer().EndRightIndent(); } | |
397 | ||
398 | /// Begin paragraph spacing | |
399 | bool BeginParagraphSpacing(int before, int after) { return GetBuffer().BeginParagraphSpacing(before, after); } | |
400 | ||
401 | /// End paragraph spacing | |
402 | bool EndParagraphSpacing() { return GetBuffer().EndParagraphSpacing(); } | |
403 | ||
404 | /// Begin line spacing | |
405 | bool BeginLineSpacing(int lineSpacing) { return GetBuffer().BeginLineSpacing(lineSpacing); } | |
406 | ||
407 | /// End line spacing | |
408 | bool EndLineSpacing() { return GetBuffer().EndLineSpacing(); } | |
409 | ||
410 | /// Begin numbered bullet | |
411 | bool BeginNumberedBullet(int bulletNumber, int leftIndent, int leftSubIndent, int bulletStyle = wxTEXT_ATTR_BULLET_STYLE_ARABIC|wxTEXT_ATTR_BULLET_STYLE_PERIOD) | |
412 | { return GetBuffer().BeginNumberedBullet(bulletNumber, leftIndent, leftSubIndent, bulletStyle); } | |
413 | ||
414 | /// End numbered bullet | |
415 | bool EndNumberedBullet() { return GetBuffer().EndNumberedBullet(); } | |
416 | ||
417 | /// Begin symbol bullet | |
d2d0adc7 | 418 | bool BeginSymbolBullet(const wxString& symbol, int leftIndent, int leftSubIndent, int bulletStyle = wxTEXT_ATTR_BULLET_STYLE_SYMBOL) |
5d7836c4 JS |
419 | { return GetBuffer().BeginSymbolBullet(symbol, leftIndent, leftSubIndent, bulletStyle); } |
420 | ||
421 | /// End symbol bullet | |
422 | bool EndSymbolBullet() { return GetBuffer().EndSymbolBullet(); } | |
423 | ||
f089713f JS |
424 | /// Begin standard bullet |
425 | bool BeginStandardBullet(const wxString& bulletName, int leftIndent, int leftSubIndent, int bulletStyle = wxTEXT_ATTR_BULLET_STYLE_STANDARD) | |
426 | { return GetBuffer().BeginStandardBullet(bulletName, leftIndent, leftSubIndent, bulletStyle); } | |
427 | ||
428 | /// End standard bullet | |
429 | bool EndStandardBullet() { return GetBuffer().EndStandardBullet(); } | |
430 | ||
5d7836c4 JS |
431 | /// Begin named character style |
432 | bool BeginCharacterStyle(const wxString& characterStyle) { return GetBuffer().BeginCharacterStyle(characterStyle); } | |
433 | ||
434 | /// End named character style | |
435 | bool EndCharacterStyle() { return GetBuffer().EndCharacterStyle(); } | |
436 | ||
437 | /// Begin named paragraph style | |
438 | bool BeginParagraphStyle(const wxString& paragraphStyle) { return GetBuffer().BeginParagraphStyle(paragraphStyle); } | |
439 | ||
440 | /// End named character style | |
441 | bool EndParagraphStyle() { return GetBuffer().EndParagraphStyle(); } | |
442 | ||
f089713f JS |
443 | /// Begin named list style |
444 | bool BeginListStyle(const wxString& listStyle, int level = 1, int number = 1) { return GetBuffer().BeginListStyle(listStyle, level, number); } | |
445 | ||
446 | /// End named character style | |
447 | bool EndListStyle() { return GetBuffer().EndListStyle(); } | |
448 | ||
d2d0adc7 JS |
449 | /// Begin URL |
450 | bool BeginURL(const wxString& url, const wxString& characterStyle = wxEmptyString) { return GetBuffer().BeginURL(url, characterStyle); } | |
451 | ||
452 | /// End URL | |
453 | bool EndURL() { return GetBuffer().EndURL(); } | |
454 | ||
5d7836c4 JS |
455 | /// Sets the default style to the style under the cursor |
456 | bool SetDefaultStyleToCursorStyle(); | |
457 | ||
458 | /// Clear the selection | |
459 | virtual void SelectNone(); | |
460 | ||
0ca07313 JS |
461 | /// Select the word at the given character position |
462 | virtual bool SelectWord(long position); | |
463 | ||
5d7836c4 | 464 | /// Get/set the selection range in character positions. -1, -1 means no selection. |
96c9f0f6 JS |
465 | /// The range is in API convention, i.e. a single character selection is denoted |
466 | /// by (n, n+1) | |
467 | wxRichTextRange GetSelectionRange() const; | |
468 | void SetSelectionRange(const wxRichTextRange& range); | |
469 | ||
470 | /// Get/set the selection range in character positions. -1, -1 means no selection. | |
471 | /// The range is in internal format, i.e. a single character selection is denoted | |
472 | /// by (n, n) | |
473 | const wxRichTextRange& GetInternalSelectionRange() const { return m_selectionRange; } | |
474 | void SetInternalSelectionRange(const wxRichTextRange& range) { m_selectionRange = range; } | |
5d7836c4 JS |
475 | |
476 | /// Add a new paragraph of text to the end of the buffer | |
477 | virtual wxRichTextRange AddParagraph(const wxString& text); | |
478 | ||
479 | /// Add an image | |
480 | virtual wxRichTextRange AddImage(const wxImage& image); | |
481 | ||
482 | /// Layout the buffer: which we must do before certain operations, such as | |
483 | /// setting the caret position. | |
2f36e8dc | 484 | virtual bool LayoutContent(bool onlyVisibleRect = false); |
5d7836c4 JS |
485 | |
486 | /// Move the caret to the given character position | |
487 | virtual bool MoveCaret(long pos, bool showAtLineStart = false); | |
488 | ||
489 | /// Move right | |
490 | virtual bool MoveRight(int noPositions = 1, int flags = 0); | |
491 | ||
492 | /// Move left | |
493 | virtual bool MoveLeft(int noPositions = 1, int flags = 0); | |
494 | ||
495 | /// Move up | |
496 | virtual bool MoveUp(int noLines = 1, int flags = 0); | |
497 | ||
498 | /// Move up | |
499 | virtual bool MoveDown(int noLines = 1, int flags = 0); | |
500 | ||
501 | /// Move to the end of the line | |
502 | virtual bool MoveToLineEnd(int flags = 0); | |
503 | ||
504 | /// Move to the start of the line | |
505 | virtual bool MoveToLineStart(int flags = 0); | |
506 | ||
507 | /// Move to the end of the paragraph | |
508 | virtual bool MoveToParagraphEnd(int flags = 0); | |
509 | ||
510 | /// Move to the start of the paragraph | |
511 | virtual bool MoveToParagraphStart(int flags = 0); | |
512 | ||
513 | /// Move to the start of the buffer | |
514 | virtual bool MoveHome(int flags = 0); | |
515 | ||
516 | /// Move to the end of the buffer | |
517 | virtual bool MoveEnd(int flags = 0); | |
518 | ||
519 | /// Move n pages up | |
520 | virtual bool PageUp(int noPages = 1, int flags = 0); | |
521 | ||
522 | /// Move n pages down | |
523 | virtual bool PageDown(int noPages = 1, int flags = 0); | |
524 | ||
525 | /// Move n words left | |
526 | virtual bool WordLeft(int noPages = 1, int flags = 0); | |
527 | ||
528 | /// Move n words right | |
529 | virtual bool WordRight(int noPages = 1, int flags = 0); | |
530 | ||
531 | /// Returns the buffer associated with the control. | |
532 | wxRichTextBuffer& GetBuffer() { return m_buffer; } | |
533 | const wxRichTextBuffer& GetBuffer() const { return m_buffer; } | |
534 | ||
535 | /// Start batching undo history for commands. | |
536 | virtual bool BeginBatchUndo(const wxString& cmdName) { return m_buffer.BeginBatchUndo(cmdName); } | |
537 | ||
538 | /// End batching undo history for commands. | |
539 | virtual bool EndBatchUndo() { return m_buffer.EndBatchUndo(); } | |
540 | ||
541 | /// Are we batching undo history for commands? | |
542 | virtual bool BatchingUndo() const { return m_buffer.BatchingUndo(); } | |
543 | ||
544 | /// Start suppressing undo history for commands. | |
545 | virtual bool BeginSuppressUndo() { return m_buffer.BeginSuppressUndo(); } | |
546 | ||
547 | /// End suppressing undo history for commands. | |
548 | virtual bool EndSuppressUndo() { return m_buffer.EndSuppressUndo(); } | |
549 | ||
550 | /// Are we suppressing undo history for commands? | |
551 | virtual bool SuppressingUndo() const { return m_buffer.SuppressingUndo(); } | |
552 | ||
553 | /// Test if this whole range has character attributes of the specified kind. If any | |
554 | /// of the attributes are different within the range, the test fails. You | |
555 | /// can use this to implement, for example, bold button updating. style must have | |
556 | /// flags indicating which attributes are of interest. | |
44cc96a8 | 557 | virtual bool HasCharacterAttributes(const wxRichTextRange& range, const wxTextAttr& style) const |
5d7836c4 | 558 | { |
a7ed48a5 | 559 | return GetBuffer().HasCharacterAttributes(range.ToInternal(), style); |
5d7836c4 JS |
560 | } |
561 | ||
562 | /// Test if this whole range has paragraph attributes of the specified kind. If any | |
563 | /// of the attributes are different within the range, the test fails. You | |
564 | /// can use this to implement, for example, centering button updating. style must have | |
565 | /// flags indicating which attributes are of interest. | |
44cc96a8 | 566 | virtual bool HasParagraphAttributes(const wxRichTextRange& range, const wxTextAttr& style) const |
5d7836c4 | 567 | { |
a7ed48a5 | 568 | return GetBuffer().HasParagraphAttributes(range.ToInternal(), style); |
5d7836c4 JS |
569 | } |
570 | ||
571 | /// Is all of the selection bold? | |
3966a9f4 | 572 | virtual bool IsSelectionBold(); |
5d7836c4 JS |
573 | |
574 | /// Is all of the selection italics? | |
3966a9f4 | 575 | virtual bool IsSelectionItalics(); |
5d7836c4 JS |
576 | |
577 | /// Is all of the selection underlined? | |
3966a9f4 | 578 | virtual bool IsSelectionUnderlined(); |
5d7836c4 JS |
579 | |
580 | /// Is all of the selection aligned according to the specified flag? | |
3966a9f4 | 581 | virtual bool IsSelectionAligned(wxTextAttrAlignment alignment); |
5d7836c4 JS |
582 | |
583 | /// Apply bold to the selection | |
584 | virtual bool ApplyBoldToSelection(); | |
585 | ||
586 | /// Apply italic to the selection | |
587 | virtual bool ApplyItalicToSelection(); | |
588 | ||
589 | /// Apply underline to the selection | |
590 | virtual bool ApplyUnderlineToSelection(); | |
591 | ||
592 | /// Apply alignment to the selection | |
593 | virtual bool ApplyAlignmentToSelection(wxTextAttrAlignment alignment); | |
594 | ||
ab14c7aa | 595 | /// Apply a named style to the selection |
1807a1f3 | 596 | virtual bool ApplyStyle(wxRichTextStyleDefinition* def); |
ab14c7aa | 597 | |
38f833b1 | 598 | /// Set style sheet, if any |
5d7836c4 JS |
599 | void SetStyleSheet(wxRichTextStyleSheet* styleSheet) { GetBuffer().SetStyleSheet(styleSheet); } |
600 | wxRichTextStyleSheet* GetStyleSheet() const { return GetBuffer().GetStyleSheet(); } | |
601 | ||
38f833b1 JS |
602 | /// Push style sheet to top of stack |
603 | bool PushStyleSheet(wxRichTextStyleSheet* styleSheet) { return GetBuffer().PushStyleSheet(styleSheet); } | |
604 | ||
605 | /// Pop style sheet from top of stack | |
606 | wxRichTextStyleSheet* PopStyleSheet() { return GetBuffer().PopStyleSheet(); } | |
607 | ||
fe5aa22c JS |
608 | /// Apply the style sheet to the buffer, for example if the styles have changed. |
609 | bool ApplyStyleSheet(wxRichTextStyleSheet* styleSheet = NULL); | |
610 | ||
5d7836c4 JS |
611 | // Command handlers |
612 | ||
c9f3a6a8 | 613 | void Command(wxCommandEvent& event); |
5d7836c4 | 614 | void OnDropFiles(wxDropFilesEvent& event); |
61f84e24 | 615 | void OnCaptureLost(wxMouseCaptureLostEvent& event); |
52170c5b | 616 | void OnSysColourChanged(wxSysColourChangedEvent& event); |
5d7836c4 JS |
617 | |
618 | void OnCut(wxCommandEvent& event); | |
619 | void OnCopy(wxCommandEvent& event); | |
620 | void OnPaste(wxCommandEvent& event); | |
621 | void OnUndo(wxCommandEvent& event); | |
622 | void OnRedo(wxCommandEvent& event); | |
623 | void OnSelectAll(wxCommandEvent& event); | |
624 | void OnClear(wxCommandEvent& event); | |
625 | ||
626 | void OnUpdateCut(wxUpdateUIEvent& event); | |
627 | void OnUpdateCopy(wxUpdateUIEvent& event); | |
628 | void OnUpdatePaste(wxUpdateUIEvent& event); | |
629 | void OnUpdateUndo(wxUpdateUIEvent& event); | |
630 | void OnUpdateRedo(wxUpdateUIEvent& event); | |
631 | void OnUpdateSelectAll(wxUpdateUIEvent& event); | |
632 | void OnUpdateClear(wxUpdateUIEvent& event); | |
633 | ||
634 | // Show a context menu for Rich Edit controls (the standard | |
635 | // EDIT control has one already) | |
636 | void OnContextMenu(wxContextMenuEvent& event); | |
7fe8059f | 637 | |
5d7836c4 JS |
638 | // Event handlers |
639 | ||
640 | /// Painting | |
641 | void OnPaint(wxPaintEvent& event); | |
642 | void OnEraseBackground(wxEraseEvent& event); | |
643 | ||
644 | /// Left-click | |
645 | void OnLeftClick(wxMouseEvent& event); | |
646 | ||
647 | /// Left-up | |
648 | void OnLeftUp(wxMouseEvent& event); | |
649 | ||
650 | /// Motion | |
651 | void OnMoveMouse(wxMouseEvent& event); | |
652 | ||
653 | /// Left-double-click | |
654 | void OnLeftDClick(wxMouseEvent& event); | |
655 | ||
656 | /// Middle-click | |
657 | void OnMiddleClick(wxMouseEvent& event); | |
658 | ||
659 | /// Right-click | |
660 | void OnRightClick(wxMouseEvent& event); | |
661 | ||
662 | /// Key press | |
663 | void OnChar(wxKeyEvent& event); | |
664 | ||
665 | /// Sizing | |
666 | void OnSize(wxSizeEvent& event); | |
667 | ||
668 | /// Setting/losing focus | |
669 | void OnSetFocus(wxFocusEvent& event); | |
670 | void OnKillFocus(wxFocusEvent& event); | |
671 | ||
4d551ad5 JS |
672 | /// Idle-time processing |
673 | void OnIdle(wxIdleEvent& event); | |
674 | ||
c59f6793 JS |
675 | /// Scrolling |
676 | void OnScroll(wxScrollWinEvent& event); | |
677 | ||
5d7836c4 JS |
678 | /// Set font, and also default attributes |
679 | virtual bool SetFont(const wxFont& font); | |
680 | ||
681 | /// Set up scrollbars, e.g. after a resize | |
169adfa9 | 682 | virtual void SetupScrollbars(bool atTop = false); |
5d7836c4 JS |
683 | |
684 | /// Keyboard navigation | |
0bab774b | 685 | virtual bool KeyboardNavigate(int keyCode, int flags); |
5d7836c4 JS |
686 | |
687 | /// Paint the background | |
688 | virtual void PaintBackground(wxDC& dc); | |
7fe8059f | 689 | |
3e3a754f | 690 | #if wxRICHTEXT_BUFFERED_PAINTING |
5d7836c4 JS |
691 | /// Recreate buffer bitmap if necessary |
692 | virtual bool RecreateBuffer(const wxSize& size = wxDefaultSize); | |
3e3a754f | 693 | #endif |
5d7836c4 | 694 | |
5d7836c4 | 695 | /// Write text |
343ae70d | 696 | virtual void DoWriteText(const wxString& value, int flags = 0); |
5d7836c4 JS |
697 | |
698 | /// Should we inherit colours? | |
699 | virtual bool ShouldInheritColours() const { return false; } | |
700 | ||
701 | /// Position the caret | |
702 | virtual void PositionCaret(); | |
703 | ||
704 | /// Extend the selection, returning true if the selection was | |
705 | /// changed. Selections are in caret positions. | |
706 | virtual bool ExtendSelection(long oldPosition, long newPosition, int flags); | |
707 | ||
708 | /// Scroll into view. This takes a _caret_ position. | |
709 | virtual bool ScrollIntoView(long position, int keyCode); | |
710 | ||
7051fa41 JS |
711 | /// Refresh the area affected by a selection change |
712 | bool RefreshForSelectionChange(const wxRichTextRange& oldSelection, const wxRichTextRange& newSelection); | |
713 | ||
5d7836c4 JS |
714 | /// The caret position is the character position just before the caret. |
715 | /// A value of -1 means the caret is at the start of the buffer. | |
716 | void SetCaretPosition(long position, bool showAtLineStart = false) ; | |
717 | long GetCaretPosition() const { return m_caretPosition; } | |
718 | ||
ab14c7aa JS |
719 | /// The adjusted caret position is the character position adjusted to take |
720 | /// into account whether we're at the start of a paragraph, in which case | |
721 | /// style information should be taken from the next position, not current one. | |
722 | long GetAdjustedCaretPosition(long caretPos) const; | |
723 | ||
5d7836c4 JS |
724 | /// Move caret one visual step forward: this may mean setting a flag |
725 | /// and keeping the same position if we're going from the end of one line | |
726 | /// to the start of the next, which may be the exact same caret position. | |
727 | void MoveCaretForward(long oldPosition) ; | |
728 | ||
729 | /// Move caret one visual step forward: this may mean setting a flag | |
730 | /// and keeping the same position if we're going from the end of one line | |
731 | /// to the start of the next, which may be the exact same caret position. | |
732 | void MoveCaretBack(long oldPosition) ; | |
733 | ||
734 | /// Get the caret height and position for the given character position | |
735 | bool GetCaretPositionForIndex(long position, wxRect& rect); | |
736 | ||
737 | /// Gets the line for the visible caret position. If the caret is | |
738 | /// shown at the very end of the line, it means the next character is actually | |
739 | /// on the following line. So let's get the line we're expecting to find | |
740 | /// if this is the case. | |
741 | wxRichTextLine* GetVisibleLineForCaretPosition(long caretPosition) const; | |
742 | ||
743 | /// Gets the command processor | |
744 | wxCommandProcessor* GetCommandProcessor() const { return GetBuffer().GetCommandProcessor(); } | |
745 | ||
746 | /// Delete content if there is a selection, e.g. when pressing a key. | |
747 | /// Returns the new caret position in newPos, or leaves it if there | |
748 | /// was no action. | |
749 | bool DeleteSelectedContent(long* newPos= NULL); | |
750 | ||
751 | /// Transform logical to physical | |
4d551ad5 | 752 | wxPoint GetPhysicalPoint(const wxPoint& ptLogical) const; |
5d7836c4 JS |
753 | |
754 | /// Transform physical to logical | |
4d551ad5 | 755 | wxPoint GetLogicalPoint(const wxPoint& ptPhysical) const; |
5d7836c4 JS |
756 | |
757 | /// Finds the caret position for the next word. Direction | |
758 | /// is 1 (forward) or -1 (backwards). | |
759 | virtual long FindNextWordPosition(int direction = 1) const; | |
760 | ||
761 | /// Is the given position visible on the screen? | |
762 | bool IsPositionVisible(long pos) const; | |
763 | ||
4d551ad5 JS |
764 | /// Returns the first visible position in the current view |
765 | long GetFirstVisiblePosition() const; | |
766 | ||
ab14c7aa JS |
767 | /// Returns the caret position since the default formatting was changed. As |
768 | /// soon as this position changes, we no longer reflect the default style | |
769 | /// in the UI. A value of -2 means that we should only reflect the style of the | |
770 | /// content under the caret. | |
771 | long GetCaretPositionForDefaultStyle() const { return m_caretPositionForDefaultStyle; } | |
772 | ||
773 | /// Set the caret position for the default style that the user is selecting. | |
774 | void SetCaretPositionForDefaultStyle(long pos) { m_caretPositionForDefaultStyle = pos; } | |
775 | ||
776 | /// Should the UI reflect the default style chosen by the user, rather than the style under | |
777 | /// the caret? | |
778 | bool IsDefaultStyleShowing() const { return m_caretPositionForDefaultStyle != -2; } | |
779 | ||
780 | /// Convenience function that tells the control to start reflecting the default | |
781 | /// style, since the user is changing it. | |
44cc96a8 | 782 | void SetAndShowDefaultStyle(const wxTextAttr& attr) |
ab14c7aa JS |
783 | { |
784 | SetDefaultStyle(attr); | |
785 | SetCaretPositionForDefaultStyle(GetCaretPosition()); | |
786 | } | |
787 | ||
ea160b2e JS |
788 | /// Get the first visible point in the window |
789 | wxPoint GetFirstVisiblePoint() const; | |
790 | ||
fe5aa22c JS |
791 | // Implementation |
792 | ||
dadd4f55 JS |
793 | /// Font names take a long time to retrieve, so cache them (on demand) |
794 | static const wxArrayString& GetAvailableFontNames(); | |
795 | static void ClearAvailableFontNames(); | |
796 | ||
805c8d92 VZ |
797 | WX_FORWARD_TO_SCROLL_HELPER() |
798 | ||
799 | // implement wxTextEntry methods | |
800 | virtual wxString DoGetValue() const; | |
801 | ||
802 | protected: | |
63f7d502 VZ |
803 | // FIXME: this does not work, it allows this code to compile but will fail |
804 | // during run-time | |
f5172305 JS |
805 | #ifdef __WXMSW__ |
806 | virtual WXHWND GetEditHWND() const { return GetHWND(); } | |
128fae46 | 807 | #endif |
5eb34e9e VZ |
808 | #ifdef __WXMOTIF__ |
809 | virtual WXWidget GetTextWidget() const { return NULL; } | |
810 | #endif | |
811 | #ifdef __WXGTK20__ | |
586a7894 | 812 | virtual wxWindow *GetEditableWindow() { return this; } |
128fae46 | 813 | virtual GtkEditable *GetEditable() const { return NULL; } |
0847e36e | 814 | virtual GtkEntry *GetEntry() const { return NULL; } |
f5172305 JS |
815 | #endif |
816 | ||
5d7836c4 | 817 | // Overrides |
6f02a879 | 818 | protected: |
5d7836c4 JS |
819 | |
820 | virtual wxSize DoGetBestSize() const ; | |
821 | ||
343ae70d VZ |
822 | virtual void DoSetValue(const wxString& value, int flags = 0); |
823 | ||
17808a75 VZ |
824 | virtual void DoThaw(); |
825 | ||
343ae70d | 826 | |
5d7836c4 JS |
827 | // Data members |
828 | private: | |
3e3a754f | 829 | #if wxRICHTEXT_BUFFERED_PAINTING |
5d7836c4 JS |
830 | /// Buffer bitmap |
831 | wxBitmap m_bufferBitmap; | |
3e3a754f | 832 | #endif |
5d7836c4 JS |
833 | |
834 | /// Text buffer | |
835 | wxRichTextBuffer m_buffer; | |
836 | ||
5d7836c4 JS |
837 | wxMenu* m_contextMenu; |
838 | ||
839 | /// Caret position (1 less than the character position, so -1 is the | |
840 | /// first caret position). | |
841 | long m_caretPosition; | |
842 | ||
ab14c7aa JS |
843 | /// Caret position when the default formatting has been changed. As |
844 | /// soon as this position changes, we no longer reflect the default style | |
845 | /// in the UI. | |
846 | long m_caretPositionForDefaultStyle; | |
847 | ||
5d7836c4 JS |
848 | /// Selection range in character positions. -2, -2 means no selection. |
849 | wxRichTextRange m_selectionRange; | |
850 | ||
851 | /// Anchor so we know how to extend the selection | |
852 | /// It's a caret position since it's between two characters. | |
853 | long m_selectionAnchor; | |
854 | ||
855 | /// Are we editable? | |
856 | bool m_editable; | |
857 | ||
858 | /// Are we showing the caret position at the start of a line | |
859 | /// instead of at the end of the previous one? | |
860 | bool m_caretAtLineStart; | |
861 | ||
862 | /// Are we dragging a selection? | |
863 | bool m_dragging; | |
864 | ||
865 | /// Start position for drag | |
866 | wxPoint m_dragStart; | |
4d551ad5 JS |
867 | |
868 | /// Do we need full layout in idle? | |
869 | bool m_fullLayoutRequired; | |
870 | wxLongLong m_fullLayoutTime; | |
871 | long m_fullLayoutSavedPosition; | |
872 | ||
873 | /// Threshold for doing delayed layout | |
874 | long m_delayedLayoutThreshold; | |
dadd4f55 | 875 | |
d2d0adc7 JS |
876 | /// Cursors |
877 | wxCursor m_textCursor; | |
878 | wxCursor m_urlCursor; | |
879 | ||
dadd4f55 | 880 | static wxArrayString sm_availableFontNames; |
5d7836c4 JS |
881 | }; |
882 | ||
883 | /*! | |
884 | * wxRichTextEvent - the event class for wxRichTextCtrl notifications | |
885 | */ | |
886 | ||
3b2cb431 | 887 | class WXDLLIMPEXP_RICHTEXT wxRichTextEvent : public wxNotifyEvent |
5d7836c4 JS |
888 | { |
889 | public: | |
890 | wxRichTextEvent(wxEventType commandType = wxEVT_NULL, int winid = 0) | |
891 | : wxNotifyEvent(commandType, winid), | |
5912d19e JS |
892 | m_flags(0), m_position(-1), m_oldStyleSheet(NULL), m_newStyleSheet(NULL), |
893 | m_char((wxChar) 0) | |
5d7836c4 JS |
894 | { } |
895 | ||
896 | wxRichTextEvent(const wxRichTextEvent& event) | |
897 | : wxNotifyEvent(event), | |
5912d19e JS |
898 | m_flags(event.m_flags), m_position(-1), |
899 | m_oldStyleSheet(event.m_oldStyleSheet), m_newStyleSheet(event.m_newStyleSheet), | |
900 | m_char((wxChar) 0) | |
5d7836c4 JS |
901 | { } |
902 | ||
5912d19e JS |
903 | long GetPosition() const { return m_position; } |
904 | void SetPosition(long pos) { m_position = pos; } | |
5d7836c4 JS |
905 | |
906 | int GetFlags() const { return m_flags; } | |
907 | void SetFlags(int flags) { m_flags = flags; } | |
908 | ||
d2d0adc7 JS |
909 | wxRichTextStyleSheet* GetOldStyleSheet() const { return m_oldStyleSheet; } |
910 | void SetOldStyleSheet(wxRichTextStyleSheet* sheet) { m_oldStyleSheet = sheet; } | |
911 | ||
912 | wxRichTextStyleSheet* GetNewStyleSheet() const { return m_newStyleSheet; } | |
913 | void SetNewStyleSheet(wxRichTextStyleSheet* sheet) { m_newStyleSheet = sheet; } | |
914 | ||
5912d19e JS |
915 | const wxRichTextRange& GetRange() const { return m_range; } |
916 | void SetRange(const wxRichTextRange& range) { m_range = range; } | |
917 | ||
918 | wxChar GetCharacter() const { return m_char; } | |
919 | void SetCharacter(wxChar ch) { m_char = ch; } | |
920 | ||
5d7836c4 JS |
921 | virtual wxEvent *Clone() const { return new wxRichTextEvent(*this); } |
922 | ||
923 | protected: | |
d2d0adc7 | 924 | int m_flags; |
5912d19e | 925 | long m_position; |
d2d0adc7 JS |
926 | wxRichTextStyleSheet* m_oldStyleSheet; |
927 | wxRichTextStyleSheet* m_newStyleSheet; | |
5912d19e JS |
928 | wxRichTextRange m_range; |
929 | wxChar m_char; | |
5d7836c4 JS |
930 | |
931 | private: | |
932 | DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxRichTextEvent) | |
933 | }; | |
934 | ||
935 | /*! | |
c058cafa | 936 | * wxRichTextCtrl events |
5d7836c4 | 937 | */ |
9b11752c VZ |
938 | wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_LEFT_CLICK, wxRichTextEvent ); |
939 | wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_RIGHT_CLICK, wxRichTextEvent ); | |
940 | wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_MIDDLE_CLICK, wxRichTextEvent ); | |
941 | wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_LEFT_DCLICK, wxRichTextEvent ); | |
942 | wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_RETURN, wxRichTextEvent ); | |
943 | wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_CHARACTER, wxRichTextEvent ); | |
944 | wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_DELETE, wxRichTextEvent ); | |
945 | ||
946 | wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGING, wxRichTextEvent ); | |
947 | wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGED, wxRichTextEvent ); | |
948 | wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_STYLESHEET_REPLACING, wxRichTextEvent ); | |
949 | wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_STYLESHEET_REPLACED, wxRichTextEvent ); | |
950 | ||
951 | wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_CONTENT_INSERTED, wxRichTextEvent ); | |
952 | wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_CONTENT_DELETED, wxRichTextEvent ); | |
953 | wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_STYLE_CHANGED, wxRichTextEvent ); | |
954 | wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_SELECTION_CHANGED, wxRichTextEvent ); | |
955 | wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_BUFFER_RESET, wxRichTextEvent ); | |
5d7836c4 JS |
956 | |
957 | typedef void (wxEvtHandler::*wxRichTextEventFunction)(wxRichTextEvent&); | |
958 | ||
97f3b1e9 | 959 | #define wxRichTextEventHandler(func) \ |
3c778901 VZ |
960 | wxEVENT_HANDLER_CAST(wxRichTextEventFunction, func) |
961 | ||
962 | #define EVT_RICHTEXT_LEFT_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_LEFT_CLICK, id, -1, wxRichTextEventHandler( fn ), NULL ), | |
963 | #define EVT_RICHTEXT_RIGHT_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_RIGHT_CLICK, id, -1, wxRichTextEventHandler( fn ), NULL ), | |
964 | #define EVT_RICHTEXT_MIDDLE_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_MIDDLE_CLICK, id, -1, wxRichTextEventHandler( fn ), NULL ), | |
965 | #define EVT_RICHTEXT_LEFT_DCLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_LEFT_DCLICK, id, -1, wxRichTextEventHandler( fn ), NULL ), | |
966 | #define EVT_RICHTEXT_RETURN(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_RETURN, id, -1, wxRichTextEventHandler( fn ), NULL ), | |
967 | #define EVT_RICHTEXT_CHARACTER(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_CHARACTER, id, -1, wxRichTextEventHandler( fn ), NULL ), | |
968 | #define EVT_RICHTEXT_DELETE(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_DELETE, id, -1, wxRichTextEventHandler( fn ), NULL ), | |
969 | ||
970 | #define EVT_RICHTEXT_STYLESHEET_CHANGING(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGING, id, -1, wxRichTextEventHandler( fn ), NULL ), | |
971 | #define EVT_RICHTEXT_STYLESHEET_CHANGED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGED, id, -1, wxRichTextEventHandler( fn ), NULL ), | |
972 | #define EVT_RICHTEXT_STYLESHEET_REPLACING(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_STYLESHEET_REPLACING, id, -1, wxRichTextEventHandler( fn ), NULL ), | |
973 | #define EVT_RICHTEXT_STYLESHEET_REPLACED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_STYLESHEET_REPLACED, id, -1, wxRichTextEventHandler( fn ), NULL ), | |
974 | ||
975 | #define EVT_RICHTEXT_CONTENT_INSERTED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_CONTENT_INSERTED, id, -1, wxRichTextEventHandler( fn ), NULL ), | |
976 | #define EVT_RICHTEXT_CONTENT_DELETED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_CONTENT_DELETED, id, -1, wxRichTextEventHandler( fn ), NULL ), | |
977 | #define EVT_RICHTEXT_STYLE_CHANGED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_STYLE_CHANGED, id, -1, wxRichTextEventHandler( fn ), NULL ), | |
978 | #define EVT_RICHTEXT_SELECTION_CHANGED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_SELECTION_CHANGED, id, -1, wxRichTextEventHandler( fn ), NULL ), | |
979 | #define EVT_RICHTEXT_BUFFER_RESET(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_BUFFER_RESET, id, -1, wxRichTextEventHandler( fn ), NULL ), | |
5912d19e | 980 | |
5d7836c4 JS |
981 | #endif |
982 | // wxUSE_RICHTEXT | |
983 | ||
984 | #endif | |
985 | // _WX_RICHTEXTCTRL_H_ |