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