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