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