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