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