include/wx/richtext/richtextctrl.h

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