include/wx/richtext/richtextctrl.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/richtext/richtextctrl.h
   3 // Purpose:     A rich edit control
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     2005-09-30
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_RICHTEXTCTRL_H_
  13 #define _WX_RICHTEXTCTRL_H_
  14
  15 #include "wx/richtext/richtextbuffer.h"
  16
  17 #if wxUSE_RICHTEXT
  18
  19 #include "wx/scrolwin.h"
  20 #include "wx/caret.h"
  21
  22 #include "wx/textctrl.h"
  23
  24 #if !defined(__WXGTK__) && !defined(__WXMAC__)
  25 #define wxRICHTEXT_BUFFERED_PAINTING 1
  26 #else
  27 #define wxRICHTEXT_BUFFERED_PAINTING 0
  28 #endif
  29
  30 class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextStyleDefinition;
  31
  32 /*!
  33  * Styles and flags
  34  */
  35
  36 /* Styles
  37  */
  38
  39 #define wxRE_READONLY          0x0010
  40 #define wxRE_MULTILINE         0x0020
  41 #define wxRE_CENTRE_CARET      0x8000
  42 #define wxRE_CENTER_CARET      wxRE_CENTRE_CARET
  43
  44 /* Flags
  45  */
  46
  47 #define wxRICHTEXT_SHIFT_DOWN  0x01
  48 #define wxRICHTEXT_CTRL_DOWN   0x02
  49 #define wxRICHTEXT_ALT_DOWN    0x04
  50
  51 /* Defaults
  52  */
  53
  54 #define wxRICHTEXT_DEFAULT_OVERALL_SIZE wxSize(-1, -1)
  55 #define wxRICHTEXT_DEFAULT_IMAGE_SIZE wxSize(80, 80)
  56 #define wxRICHTEXT_DEFAULT_SPACING 3
  57 #define wxRICHTEXT_DEFAULT_MARGIN 3
  58 #define wxRICHTEXT_DEFAULT_UNFOCUSSED_BACKGROUND wxColour(175, 175, 175)
  59 #define wxRICHTEXT_DEFAULT_FOCUSSED_BACKGROUND wxColour(140, 140, 140)
  60 #define wxRICHTEXT_DEFAULT_UNSELECTED_BACKGROUND wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE)
  61 #define wxRICHTEXT_DEFAULT_TYPE_COLOUR wxColour(0, 0, 200)
  62 #define wxRICHTEXT_DEFAULT_FOCUS_RECT_COLOUR wxColour(100, 80, 80)
  63 #define wxRICHTEXT_DEFAULT_CARET_WIDTH 2
  64 // Minimum buffer size before delayed layout kicks in
  65 #define wxRICHTEXT_DEFAULT_DELAYED_LAYOUT_THRESHOLD 20000
  66 // Milliseconds before layout occurs after resize
  67 #define wxRICHTEXT_DEFAULT_LAYOUT_INTERVAL 50
  68
  69 /*!
  70  * Forward declarations
  71  */
  72
  73 /*!
  74  * wxRichTextItem class declaration
  75  */
  76
  77 // Drawing styles/states
  78 #define wxRICHTEXT_SELECTED    0x01
  79 #define wxRICHTEXT_TAGGED      0x02
  80 // The control is focussed
  81 #define wxRICHTEXT_FOCUSSED    0x04
  82 // The item itself has the focus
  83 #define wxRICHTEXT_IS_FOCUS    0x08
  84
  85 /*!
  86  * wxRichTextCtrl class declaration
  87  */
  88
  89 class WXDLLIMPEXP_RICHTEXT wxRichTextCtrl : public wxControl,
  90                                             public wxTextCtrlIface,
  91                                             public wxScrollHelper
  92 {
  93     DECLARE_CLASS( wxRichTextCtrl )
  94     DECLARE_EVENT_TABLE()
  95
  96 public:
  97 // Constructors
  98
  99     wxRichTextCtrl( );
 100     wxRichTextCtrl( wxWindow* parent, wxWindowID id = -1, const wxString& value = wxEmptyString, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize,
 101         long style = wxRE_MULTILINE, const wxValidator& validator = wxDefaultValidator, const wxString& name = wxTextCtrlNameStr);
 102
 103     virtual ~wxRichTextCtrl( );
 104
 105 // Operations
 106
 107     /// Creation
 108     bool Create( wxWindow* parent, wxWindowID id = -1, const wxString& value = wxEmptyString, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize,
 109         long style = wxRE_MULTILINE, const wxValidator& validator = wxDefaultValidator, const wxString& name = wxTextCtrlNameStr );
 110
 111     /// Member initialisation
 112     void Init();
 113
 114 ///// wxTextCtrl compatibility
 115
 116 // Accessors
 117
 118     virtual wxString GetValue() const;
 119
 120     virtual wxString GetRange(long from, long to) const;
 121
 122     virtual int GetLineLength(long lineNo) const ;
 123     virtual wxString GetLineText(long lineNo) const ;
 124     virtual int GetNumberOfLines() const ;
 125
 126     virtual bool IsModified() const ;
 127     virtual bool IsEditable() const ;
 128
 129     // more readable flag testing methods
 130     bool IsSingleLine() const { return !HasFlag(wxRE_MULTILINE); }
 131     bool IsMultiLine() const { return !IsSingleLine(); }
 132
 133     // If the return values from and to are the same, there is no selection.
 134     virtual void GetSelection(long* from, long* to) const;
 135
 136     virtual wxString GetStringSelection() const;
 137
 138     /// Get filename
 139     wxString GetFilename() const { return m_filename; }
 140
 141     /// Set filename
 142     void SetFilename(const wxString& filename) { m_filename = filename; }
 143
 144     /// Set the threshold in character positions for doing layout optimization during sizing
 145     void SetDelayedLayoutThreshold(long threshold) { m_delayedLayoutThreshold = threshold; }
 146
 147     /// Get the threshold in character positions for doing layout optimization during sizing
 148     long GetDelayedLayoutThreshold() const { return m_delayedLayoutThreshold; }
 149
 150     /// Set text cursor
 151     void SetTextCursor(const wxCursor& cursor ) { m_textCursor = cursor; }
 152
 153     /// Get text cursor
 154     wxCursor GetTextCursor() const { return m_textCursor; }
 155
 156     /// Set URL cursor
 157     void SetURLCursor(const wxCursor& cursor ) { m_urlCursor = cursor; }
 158
 159     /// Get URL cursor
 160     wxCursor GetURLCursor() const { return m_urlCursor; }
 161
 162 // Operations
 163
 164     // editing
 165     virtual void Clear();
 166     virtual void Replace(long from, long to, const wxString& value);
 167     virtual void Remove(long from, long to);
 168
 169     // load/save the controls contents from/to the file
 170     virtual bool DoLoadFile(const wxString& file, int fileType);
 171     virtual bool DoSaveFile(const wxString& file = wxEmptyString,
 172                             int fileType = wxRICHTEXT_TYPE_ANY);
 173
 174     /// Set the handler flags, controlling loading and saving
 175     void SetHandlerFlags(int flags) { GetBuffer().SetHandlerFlags(flags); }
 176
 177     /// Get the handler flags, controlling loading and saving
 178     int GetHandlerFlags() const { return GetBuffer().GetHandlerFlags(); }
 179
 180     // sets/clears the dirty flag
 181     virtual void MarkDirty();
 182     virtual void DiscardEdits();
 183
 184     // set the max number of characters which may be entered in a single line
 185     // text control
 186     virtual void SetMaxLength(unsigned long WXUNUSED(len)) { }
 187
 188     // writing text inserts it at the current position, appending always
 189     // inserts it at the end
 190     virtual void WriteText(const wxString& text);
 191     virtual void AppendText(const wxString& text);
 192
 193     // text control under some platforms supports the text styles: these
 194     // methods allow to apply the given text style to the given selection or to
 195     // set/get the style which will be used for all appended text
 196     virtual bool SetStyle(long start, long end, const wxTextAttr& style);
 197     virtual bool SetStyle(const wxRichTextRange& range, const wxTextAttr& style);
 198     virtual bool GetStyle(long position, wxTextAttr& style);
 199
 200     // get the common set of styles for the range
 201     virtual bool GetStyleForRange(const wxRichTextRange& range, wxTextAttr& style);
 202     // extended style setting operation with flags including:
 203     // wxRICHTEXT_SETSTYLE_WITH_UNDO, wxRICHTEXT_SETSTYLE_OPTIMIZE, wxRICHTEXT_SETSTYLE_PARAGRAPHS_ONLY, wxRICHTEXT_SETSTYLE_CHARACTERS_ONLY
 204     // see richtextbuffer.h for more details.
 205     virtual bool SetStyleEx(const wxRichTextRange& range, const wxTextAttr& style, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO);
 206
 207     /// Get the content (uncombined) attributes for this position.
 208     virtual bool GetUncombinedStyle(long position, wxTextAttr& style);
 209
 210     virtual bool SetDefaultStyle(const wxTextAttr& style);
 211
 212     virtual const wxTextAttr& GetDefaultStyleEx() const { return GetDefaultStyle(); }
 213
 214     virtual const wxTextAttr& GetDefaultStyle() const;
 215
 216     /// Set list style
 217     virtual bool SetListStyle(const wxRichTextRange& range, wxRichTextListStyleDefinition* def, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom = 1, int specifiedLevel = -1);
 218     virtual bool SetListStyle(const wxRichTextRange& range, const wxString& defName, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom = 1, int specifiedLevel = -1);
 219
 220     /// Clear list for given range
 221     virtual bool ClearListStyle(const wxRichTextRange& range, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO);
 222
 223     /// Number/renumber any list elements in the given range
 224     /// def/defName can be NULL/empty to indicate that the existing list style should be used.
 225     virtual bool NumberList(const wxRichTextRange& range, wxRichTextListStyleDefinition* def = NULL, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom = 1, int specifiedLevel = -1);
 226     virtual bool NumberList(const wxRichTextRange& range, const wxString& defName, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom = 1, int specifiedLevel = -1);
 227
 228     /// Promote the list items within the given range. promoteBy can be a positive or negative number, e.g. 1 or -1
 229     /// def/defName can be NULL/empty to indicate that the existing list style should be used.
 230     virtual bool PromoteList(int promoteBy, const wxRichTextRange& range, wxRichTextListStyleDefinition* def = NULL, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int specifiedLevel = -1);
 231     virtual bool PromoteList(int promoteBy, const wxRichTextRange& range, const wxString& defName, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int specifiedLevel = -1);
 232
 233     /// Deletes the content in the given range
 234     virtual bool Delete(const wxRichTextRange& range);
 235
 236     // translate between the position (which is just an index in the text ctrl
 237     // considering all its contents as a single strings) and (x, y) coordinates
 238     // which represent column and line.
 239     virtual long XYToPosition(long x, long y) const;
 240     virtual bool PositionToXY(long pos, long *x, long *y) const;
 241
 242     virtual void ShowPosition(long pos);
 243
 244     // find the character at position given in pixels
 245     //
 246     // NB: pt is in device coords (not adjusted for the client area origin nor
 247     //     scrolling)
 248     virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt, long *pos) const;
 249     virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt,
 250                                             wxTextCoord *col,
 251                                             wxTextCoord *row) const;
 252
 253     // Clipboard operations
 254     virtual void Copy();
 255     virtual void Cut();
 256     virtual void Paste();
 257     virtual void DeleteSelection();
 258
 259     virtual bool CanCopy() const;
 260     virtual bool CanCut() const;
 261     virtual bool CanPaste() const;
 262     virtual bool CanDeleteSelection() const;
 263
 264     // Undo/redo
 265     virtual void Undo();
 266     virtual void Redo();
 267
 268     virtual bool CanUndo() const;
 269     virtual bool CanRedo() const;
 270
 271     // Insertion point
 272     virtual void SetInsertionPoint(long pos);
 273     virtual void SetInsertionPointEnd();
 274     virtual long GetInsertionPoint() const;
 275     virtual wxTextPos GetLastPosition() const;
 276
 277     virtual void SetSelection(long from, long to);
 278     virtual void SelectAll();
 279     virtual void SetEditable(bool editable);
 280
 281     virtual bool HasSelection() const;
 282
 283 ///// Functionality specific to wxRichTextCtrl
 284
 285     /// Write an image 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 wxImage& image, wxBitmapType bitmapType = wxBITMAP_TYPE_PNG);
 288
 289     /// Write a bitmap at the current insertion point. Supply optional type to use
 290     /// for internal and file storage of the raw data.
 291     virtual bool WriteImage(const wxBitmap& bitmap, wxBitmapType bitmapType = wxBITMAP_TYPE_PNG);
 292
 293     /// Load an image from file and write at the current insertion point.
 294     virtual bool WriteImage(const wxString& filename, wxBitmapType bitmapType);
 295
 296     /// Write an image block at the current insertion point.
 297     virtual bool WriteImage(const wxRichTextImageBlock& imageBlock);
 298
 299     /// Insert a newline (actually paragraph) at the current insertion point.
 300     virtual bool Newline();
 301
 302     /// Insert a line break at the current insertion point.
 303     virtual bool LineBreak();
 304
 305     /// Set basic (overall) style
 306     virtual void SetBasicStyle(const wxTextAttr& style) { GetBuffer().SetBasicStyle(style); }
 307
 308     /// Get basic (overall) style
 309     virtual const wxTextAttr& GetBasicStyle() const { return GetBuffer().GetBasicStyle(); }
 310
 311     virtual bool BeginStyle(const wxTextAttr& style) { return GetBuffer().BeginStyle(style); }
 312
 313     /// End the style
 314     virtual bool EndStyle() { return GetBuffer().EndStyle(); }
 315
 316     /// End all styles
 317     virtual bool EndAllStyles() { return GetBuffer().EndAllStyles(); }
 318
 319     /// Begin using bold
 320     bool BeginBold() { return GetBuffer().BeginBold(); }
 321
 322     /// End using bold
 323     bool EndBold()  { return GetBuffer().EndBold(); }
 324
 325     /// Begin using italic
 326     bool BeginItalic() { return GetBuffer().BeginItalic(); }
 327
 328     /// End using italic
 329     bool EndItalic() { return GetBuffer().EndItalic(); }
 330
 331     /// Begin using underline
 332     bool BeginUnderline() { return GetBuffer().BeginUnderline(); }
 333
 334     /// End using underline
 335     bool EndUnderline() { return GetBuffer().EndUnderline(); }
 336
 337     /// Begin using point size
 338     bool BeginFontSize(int pointSize) { return GetBuffer().BeginFontSize(pointSize); }
 339
 340     /// End using point size
 341     bool EndFontSize() { return GetBuffer().EndFontSize(); }
 342
 343     /// Begin using this font
 344     bool BeginFont(const wxFont& font) { return GetBuffer().BeginFont(font); }
 345
 346     /// End using a font
 347     bool EndFont() { return GetBuffer().EndFont(); }
 348
 349     /// Begin using this colour
 350     bool BeginTextColour(const wxColour& colour) { return GetBuffer().BeginTextColour(colour); }
 351
 352     /// End using a colour
 353     bool EndTextColour() { return GetBuffer().EndTextColour(); }
 354
 355     /// Begin using alignment
 356     bool BeginAlignment(wxTextAttrAlignment alignment) { return GetBuffer().BeginAlignment(alignment); }
 357
 358     /// End alignment
 359     bool EndAlignment() { return GetBuffer().EndAlignment(); }
 360
 361     /// Begin left indent
 362     bool BeginLeftIndent(int leftIndent, int leftSubIndent = 0) { return GetBuffer().BeginLeftIndent(leftIndent, leftSubIndent); }
 363
 364     /// End left indent
 365     bool EndLeftIndent() { return GetBuffer().EndLeftIndent(); }
 366
 367     /// Begin right indent
 368     bool BeginRightIndent(int rightIndent) { return GetBuffer().BeginRightIndent(rightIndent); }
 369
 370     /// End right indent
 371     bool EndRightIndent() { return GetBuffer().EndRightIndent(); }
 372
 373     /// Begin paragraph spacing
 374     bool BeginParagraphSpacing(int before, int after) { return GetBuffer().BeginParagraphSpacing(before, after); }
 375
 376     /// End paragraph spacing
 377     bool EndParagraphSpacing() { return GetBuffer().EndParagraphSpacing(); }
 378
 379     /// Begin line spacing
 380     bool BeginLineSpacing(int lineSpacing) { return GetBuffer().BeginLineSpacing(lineSpacing); }
 381
 382     /// End line spacing
 383     bool EndLineSpacing() { return GetBuffer().EndLineSpacing(); }
 384
 385     /// Begin numbered bullet
 386     bool BeginNumberedBullet(int bulletNumber, int leftIndent, int leftSubIndent, int bulletStyle = wxTEXT_ATTR_BULLET_STYLE_ARABIC|wxTEXT_ATTR_BULLET_STYLE_PERIOD)
 387     { return GetBuffer().BeginNumberedBullet(bulletNumber, leftIndent, leftSubIndent, bulletStyle); }
 388
 389     /// End numbered bullet
 390     bool EndNumberedBullet() { return GetBuffer().EndNumberedBullet(); }
 391
 392     /// Begin symbol bullet
 393     bool BeginSymbolBullet(const wxString& symbol, int leftIndent, int leftSubIndent, int bulletStyle = wxTEXT_ATTR_BULLET_STYLE_SYMBOL)
 394     { return GetBuffer().BeginSymbolBullet(symbol, leftIndent, leftSubIndent, bulletStyle); }
 395
 396     /// End symbol bullet
 397     bool EndSymbolBullet() { return GetBuffer().EndSymbolBullet(); }
 398
 399     /// Begin standard bullet
 400     bool BeginStandardBullet(const wxString& bulletName, int leftIndent, int leftSubIndent, int bulletStyle = wxTEXT_ATTR_BULLET_STYLE_STANDARD)
 401     { return GetBuffer().BeginStandardBullet(bulletName, leftIndent, leftSubIndent, bulletStyle); }
 402
 403     /// End standard bullet
 404     bool EndStandardBullet() { return GetBuffer().EndStandardBullet(); }
 405
 406     /// Begin named character style
 407     bool BeginCharacterStyle(const wxString& characterStyle) { return GetBuffer().BeginCharacterStyle(characterStyle); }
 408
 409     /// End named character style
 410     bool EndCharacterStyle() { return GetBuffer().EndCharacterStyle(); }
 411
 412     /// Begin named paragraph style
 413     bool BeginParagraphStyle(const wxString& paragraphStyle) { return GetBuffer().BeginParagraphStyle(paragraphStyle); }
 414
 415     /// End named character style
 416     bool EndParagraphStyle() { return GetBuffer().EndParagraphStyle(); }
 417
 418     /// Begin named list style
 419     bool BeginListStyle(const wxString& listStyle, int level = 1, int number = 1) { return GetBuffer().BeginListStyle(listStyle, level, number); }
 420
 421     /// End named character style
 422     bool EndListStyle() { return GetBuffer().EndListStyle(); }
 423
 424     /// Begin URL
 425     bool BeginURL(const wxString& url, const wxString& characterStyle = wxEmptyString) { return GetBuffer().BeginURL(url, characterStyle); }
 426
 427     /// End URL
 428     bool EndURL() { return GetBuffer().EndURL(); }
 429
 430     /// Sets the default style to the style under the cursor
 431     bool SetDefaultStyleToCursorStyle();
 432
 433     /// Clear the selection
 434     virtual void SelectNone();
 435
 436     /// Select the word at the given character position
 437     virtual bool SelectWord(long position);
 438
 439     /// Get/set the selection range in character positions. -1, -1 means no selection.
 440     /// The range is in API convention, i.e. a single character selection is denoted
 441     /// by (n, n+1)
 442     wxRichTextRange GetSelectionRange() const;
 443     void SetSelectionRange(const wxRichTextRange& range);
 444
 445     /// Get/set the selection range in character positions. -1, -1 means no selection.
 446     /// The range is in internal format, i.e. a single character selection is denoted
 447     /// by (n, n)
 448     const wxRichTextRange& GetInternalSelectionRange() const { return m_selectionRange; }
 449     void SetInternalSelectionRange(const wxRichTextRange& range) { m_selectionRange = range; }
 450
 451     /// Add a new paragraph of text to the end of the buffer
 452     virtual wxRichTextRange AddParagraph(const wxString& text);
 453
 454     /// Add an image
 455     virtual wxRichTextRange AddImage(const wxImage& image);
 456
 457     /// Layout the buffer: which we must do before certain operations, such as
 458     /// setting the caret position.
 459     virtual bool LayoutContent(bool onlyVisibleRect = false);
 460
 461     /// Move the caret to the given character position
 462     virtual bool MoveCaret(long pos, bool showAtLineStart = false);
 463
 464     /// Move right
 465     virtual bool MoveRight(int noPositions = 1, int flags = 0);
 466
 467     /// Move left
 468     virtual bool MoveLeft(int noPositions = 1, int flags = 0);
 469
 470     /// Move up
 471     virtual bool MoveUp(int noLines = 1, int flags = 0);
 472
 473     /// Move up
 474     virtual bool MoveDown(int noLines = 1, int flags = 0);
 475
 476     /// Move to the end of the line
 477     virtual bool MoveToLineEnd(int flags = 0);
 478
 479     /// Move to the start of the line
 480     virtual bool MoveToLineStart(int flags = 0);
 481
 482     /// Move to the end of the paragraph
 483     virtual bool MoveToParagraphEnd(int flags = 0);
 484
 485     /// Move to the start of the paragraph
 486     virtual bool MoveToParagraphStart(int flags = 0);
 487
 488     /// Move to the start of the buffer
 489     virtual bool MoveHome(int flags = 0);
 490
 491     /// Move to the end of the buffer
 492     virtual bool MoveEnd(int flags = 0);
 493
 494     /// Move n pages up
 495     virtual bool PageUp(int noPages = 1, int flags = 0);
 496
 497     /// Move n pages down
 498     virtual bool PageDown(int noPages = 1, int flags = 0);
 499
 500     /// Move n words left
 501     virtual bool WordLeft(int noPages = 1, int flags = 0);
 502
 503     /// Move n words right
 504     virtual bool WordRight(int noPages = 1, int flags = 0);
 505
 506     /// Returns the buffer associated with the control.
 507     wxRichTextBuffer& GetBuffer() { return m_buffer; }
 508     const wxRichTextBuffer& GetBuffer() const { return m_buffer; }
 509
 510     /// Start batching undo history for commands.
 511     virtual bool BeginBatchUndo(const wxString& cmdName) { return m_buffer.BeginBatchUndo(cmdName); }
 512
 513     /// End batching undo history for commands.
 514     virtual bool EndBatchUndo() { return m_buffer.EndBatchUndo(); }
 515
 516     /// Are we batching undo history for commands?
 517     virtual bool BatchingUndo() const { return m_buffer.BatchingUndo(); }
 518
 519     /// Start suppressing undo history for commands.
 520     virtual bool BeginSuppressUndo() { return m_buffer.BeginSuppressUndo(); }
 521
 522     /// End suppressing undo history for commands.
 523     virtual bool EndSuppressUndo() { return m_buffer.EndSuppressUndo(); }
 524
 525     /// Are we suppressing undo history for commands?
 526     virtual bool SuppressingUndo() const { return m_buffer.SuppressingUndo(); }
 527
 528     /// Test if this whole range has character attributes of the specified kind. If any
 529     /// of the attributes are different within the range, the test fails. You
 530     /// can use this to implement, for example, bold button updating. style must have
 531     /// flags indicating which attributes are of interest.
 532     virtual bool HasCharacterAttributes(const wxRichTextRange& range, const wxTextAttr& style) const
 533     {
 534         return GetBuffer().HasCharacterAttributes(range.ToInternal(), style);
 535     }
 536
 537     /// Test if this whole range has paragraph attributes of the specified kind. If any
 538     /// of the attributes are different within the range, the test fails. You
 539     /// can use this to implement, for example, centering button updating. style must have
 540     /// flags indicating which attributes are of interest.
 541     virtual bool HasParagraphAttributes(const wxRichTextRange& range, const wxTextAttr& style) const
 542     {
 543         return GetBuffer().HasParagraphAttributes(range.ToInternal(), style);
 544     }
 545
 546     /// Is all of the selection bold?
 547     virtual bool IsSelectionBold();
 548
 549     /// Is all of the selection italics?
 550     virtual bool IsSelectionItalics();
 551
 552     /// Is all of the selection underlined?
 553     virtual bool IsSelectionUnderlined();
 554
 555     /// Is all of the selection aligned according to the specified flag?
 556     virtual bool IsSelectionAligned(wxTextAttrAlignment alignment);
 557
 558     /// Apply bold to the selection
 559     virtual bool ApplyBoldToSelection();
 560
 561     /// Apply italic to the selection
 562     virtual bool ApplyItalicToSelection();
 563
 564     /// Apply underline to the selection
 565     virtual bool ApplyUnderlineToSelection();
 566
 567     /// Apply alignment to the selection
 568     virtual bool ApplyAlignmentToSelection(wxTextAttrAlignment alignment);
 569
 570     /// Apply a named style to the selection
 571     virtual bool ApplyStyle(wxRichTextStyleDefinition* def);
 572
 573     /// Set style sheet, if any
 574     void SetStyleSheet(wxRichTextStyleSheet* styleSheet) { GetBuffer().SetStyleSheet(styleSheet); }
 575     wxRichTextStyleSheet* GetStyleSheet() const { return GetBuffer().GetStyleSheet(); }
 576
 577     /// Push style sheet to top of stack
 578     bool PushStyleSheet(wxRichTextStyleSheet* styleSheet) { return GetBuffer().PushStyleSheet(styleSheet); }
 579
 580     /// Pop style sheet from top of stack
 581     wxRichTextStyleSheet* PopStyleSheet() { return GetBuffer().PopStyleSheet(); }
 582
 583     /// Apply the style sheet to the buffer, for example if the styles have changed.
 584     bool ApplyStyleSheet(wxRichTextStyleSheet* styleSheet = NULL);
 585
 586 // Command handlers
 587
 588     void Command(wxCommandEvent& event);
 589     void OnDropFiles(wxDropFilesEvent& event);
 590     void OnCaptureLost(wxMouseCaptureLostEvent& event);
 591     void OnSysColourChanged(wxSysColourChangedEvent& 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     /// Refresh the area affected by a selection change
 690     bool RefreshForSelectionChange(const wxRichTextRange& oldSelection, const wxRichTextRange& newSelection);
 691
 692     /// The caret position is the character position just before the caret.
 693     /// A value of -1 means the caret is at the start of the buffer.
 694     void SetCaretPosition(long position, bool showAtLineStart = false) ;
 695     long GetCaretPosition() const { return m_caretPosition; }
 696
 697     /// The adjusted caret position is the character position adjusted to take
 698     /// into account whether we're at the start of a paragraph, in which case
 699     /// style information should be taken from the next position, not current one.
 700     long GetAdjustedCaretPosition(long caretPos) const;
 701
 702     /// Move caret one visual step forward: this may mean setting a flag
 703     /// and keeping the same position if we're going from the end of one line
 704     /// to the start of the next, which may be the exact same caret position.
 705     void MoveCaretForward(long oldPosition) ;
 706
 707     /// Move caret one visual step forward: this may mean setting a flag
 708     /// and keeping the same position if we're going from the end of one line
 709     /// to the start of the next, which may be the exact same caret position.
 710     void MoveCaretBack(long oldPosition) ;
 711
 712     /// Get the caret height and position for the given character position
 713     bool GetCaretPositionForIndex(long position, wxRect& rect);
 714
 715     /// Gets the line for the visible caret position. If the caret is
 716     /// shown at the very end of the line, it means the next character is actually
 717     /// on the following line. So let's get the line we're expecting to find
 718     /// if this is the case.
 719     wxRichTextLine* GetVisibleLineForCaretPosition(long caretPosition) const;
 720
 721     /// Gets the command processor
 722     wxCommandProcessor* GetCommandProcessor() const { return GetBuffer().GetCommandProcessor(); }
 723
 724     /// Delete content if there is a selection, e.g. when pressing a key.
 725     /// Returns the new caret position in newPos, or leaves it if there
 726     /// was no action.
 727     bool DeleteSelectedContent(long* newPos= NULL);
 728
 729     /// Transform logical to physical
 730     wxPoint GetPhysicalPoint(const wxPoint& ptLogical) const;
 731
 732     /// Transform physical to logical
 733     wxPoint GetLogicalPoint(const wxPoint& ptPhysical) const;
 734
 735     /// Finds the caret position for the next word. Direction
 736     /// is 1 (forward) or -1 (backwards).
 737     virtual long FindNextWordPosition(int direction = 1) const;
 738
 739     /// Is the given position visible on the screen?
 740     bool IsPositionVisible(long pos) const;
 741
 742     /// Returns the first visible position in the current view
 743     long GetFirstVisiblePosition() const;
 744
 745     /// Returns the caret position since the default formatting was changed. As
 746     /// soon as this position changes, we no longer reflect the default style
 747     /// in the UI. A value of -2 means that we should only reflect the style of the
 748     /// content under the caret.
 749     long GetCaretPositionForDefaultStyle() const { return m_caretPositionForDefaultStyle; }
 750
 751     /// Set the caret position for the default style that the user is selecting.
 752     void SetCaretPositionForDefaultStyle(long pos) { m_caretPositionForDefaultStyle = pos; }
 753
 754     /// Should the UI reflect the default style chosen by the user, rather than the style under
 755     /// the caret?
 756     bool IsDefaultStyleShowing() const { return m_caretPositionForDefaultStyle != -2; }
 757
 758     /// Convenience function that tells the control to start reflecting the default
 759     /// style, since the user is changing it.
 760     void SetAndShowDefaultStyle(const wxTextAttr& attr)
 761     {
 762         SetDefaultStyle(attr);
 763         SetCaretPositionForDefaultStyle(GetCaretPosition());
 764     }
 765
 766     /// Get the first visible point in the window
 767     wxPoint GetFirstVisiblePoint() const;
 768
 769 // Implementation
 770
 771      /// Font names take a long time to retrieve, so cache them (on demand)
 772      static const wxArrayString& GetAvailableFontNames();
 773      static void ClearAvailableFontNames();
 774
 775      WX_FORWARD_TO_SCROLL_HELPER()
 776
 777 // Overrides
 778 protected:
 779
 780     virtual wxSize DoGetBestSize() const ;
 781
 782     virtual void DoSetValue(const wxString& value, int flags = 0);
 783
 784     virtual void DoThaw();
 785
 786
 787 // Data members
 788 private:
 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_flags(0), m_position(-1), m_oldStyleSheet(NULL), m_newStyleSheet(NULL),
 853         m_char((wxChar) 0)
 854         { }
 855
 856     wxRichTextEvent(const wxRichTextEvent& event)
 857         : wxNotifyEvent(event),
 858         m_flags(event.m_flags), m_position(-1),
 859         m_oldStyleSheet(event.m_oldStyleSheet), m_newStyleSheet(event.m_newStyleSheet),
 860         m_char((wxChar) 0)
 861         { }
 862
 863     long GetPosition() const { return m_position; }
 864     void SetPosition(long pos) { m_position = pos; }
 865
 866     int GetFlags() const { return m_flags; }
 867     void SetFlags(int flags) { m_flags = flags; }
 868
 869     wxRichTextStyleSheet* GetOldStyleSheet() const { return m_oldStyleSheet; }
 870     void SetOldStyleSheet(wxRichTextStyleSheet* sheet) { m_oldStyleSheet = sheet; }
 871
 872     wxRichTextStyleSheet* GetNewStyleSheet() const { return m_newStyleSheet; }
 873     void SetNewStyleSheet(wxRichTextStyleSheet* sheet) { m_newStyleSheet = sheet; }
 874
 875     const wxRichTextRange& GetRange() const { return m_range; }
 876     void SetRange(const wxRichTextRange& range) { m_range = range; }
 877
 878     wxChar GetCharacter() const { return m_char; }
 879     void SetCharacter(wxChar ch) { m_char = ch; }
 880
 881     virtual wxEvent *Clone() const { return new wxRichTextEvent(*this); }
 882
 883 protected:
 884     int                     m_flags;
 885     long                    m_position;
 886     wxRichTextStyleSheet*   m_oldStyleSheet;
 887     wxRichTextStyleSheet*   m_newStyleSheet;
 888     wxRichTextRange         m_range;
 889     wxChar                  m_char;
 890
 891 private:
 892     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxRichTextEvent)
 893 };
 894
 895 /*!
 896  * wxRichTextCtrl events
 897  */
 898 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_LEFT_CLICK, wxRichTextEvent );
 899 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_RIGHT_CLICK, wxRichTextEvent );
 900 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_MIDDLE_CLICK, wxRichTextEvent );
 901 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_LEFT_DCLICK, wxRichTextEvent );
 902 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_RETURN, wxRichTextEvent );
 903 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_CHARACTER, wxRichTextEvent );
 904 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_DELETE, wxRichTextEvent );
 905
 906 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGING, wxRichTextEvent );
 907 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGED, wxRichTextEvent );
 908 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_STYLESHEET_REPLACING, wxRichTextEvent );
 909 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_STYLESHEET_REPLACED, wxRichTextEvent );
 910
 911 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_CONTENT_INSERTED, wxRichTextEvent );
 912 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_CONTENT_DELETED, wxRichTextEvent );
 913 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_STYLE_CHANGED, wxRichTextEvent );
 914 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_SELECTION_CHANGED, wxRichTextEvent );
 915 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_BUFFER_RESET, wxRichTextEvent );
 916
 917 typedef void (wxEvtHandler::*wxRichTextEventFunction)(wxRichTextEvent&);
 918
 919 #define wxRichTextEventHandler(func) \
 920     wxEVENT_HANDLER_CAST(wxRichTextEventFunction, func)
 921
 922 #define EVT_RICHTEXT_LEFT_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_LEFT_CLICK, id, -1, wxRichTextEventHandler( fn ), NULL ),
 923 #define EVT_RICHTEXT_RIGHT_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_RIGHT_CLICK, id, -1, wxRichTextEventHandler( fn ), NULL ),
 924 #define EVT_RICHTEXT_MIDDLE_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_MIDDLE_CLICK, id, -1, wxRichTextEventHandler( fn ), NULL ),
 925 #define EVT_RICHTEXT_LEFT_DCLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_LEFT_DCLICK, id, -1, wxRichTextEventHandler( fn ), NULL ),
 926 #define EVT_RICHTEXT_RETURN(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_RETURN, id, -1, wxRichTextEventHandler( fn ), NULL ),
 927 #define EVT_RICHTEXT_CHARACTER(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_CHARACTER, id, -1, wxRichTextEventHandler( fn ), NULL ),
 928 #define EVT_RICHTEXT_DELETE(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_DELETE, id, -1, wxRichTextEventHandler( fn ), NULL ),
 929
 930 #define EVT_RICHTEXT_STYLESHEET_CHANGING(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGING, id, -1, wxRichTextEventHandler( fn ), NULL ),
 931 #define EVT_RICHTEXT_STYLESHEET_CHANGED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGED, id, -1, wxRichTextEventHandler( fn ), NULL ),
 932 #define EVT_RICHTEXT_STYLESHEET_REPLACING(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_STYLESHEET_REPLACING, id, -1, wxRichTextEventHandler( fn ), NULL ),
 933 #define EVT_RICHTEXT_STYLESHEET_REPLACED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_STYLESHEET_REPLACED, id, -1, wxRichTextEventHandler( fn ), NULL ),
 934
 935 #define EVT_RICHTEXT_CONTENT_INSERTED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_CONTENT_INSERTED, id, -1, wxRichTextEventHandler( fn ), NULL ),
 936 #define EVT_RICHTEXT_CONTENT_DELETED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_CONTENT_DELETED, id, -1, wxRichTextEventHandler( fn ), NULL ),
 937 #define EVT_RICHTEXT_STYLE_CHANGED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_STYLE_CHANGED, id, -1, wxRichTextEventHandler( fn ), NULL ),
 938 #define EVT_RICHTEXT_SELECTION_CHANGED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_SELECTION_CHANGED, id, -1, wxRichTextEventHandler( fn ), NULL ),
 939 #define EVT_RICHTEXT_BUFFER_RESET(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_BUFFER_RESET, id, -1, wxRichTextEventHandler( fn ), NULL ),
 940
 941 #endif
 942     // wxUSE_RICHTEXT
 943
 944 #endif
 945     // _WX_RICHTEXTCTRL_H_