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