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