X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/d3c7fc996a73e9f6a83067bc28a3c5581a3fee65..42eba91294e1c374908b63bdc5f22a5c4c29f110:/include/wx/richtext/richtextctrl.h diff --git a/include/wx/richtext/richtextctrl.h b/include/wx/richtext/richtextctrl.h index a2abcbd989..1e0e289712 100644 --- a/include/wx/richtext/richtextctrl.h +++ b/include/wx/richtext/richtextctrl.h @@ -19,15 +19,15 @@ #include "wx/scrolwin.h" #include "wx/caret.h" -#if wxCHECK_VERSION(2,7,0) -#define wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE 0 +#include "wx/textctrl.h" + +#if !defined(__WXGTK__) && !defined(__WXMAC__) +#define wxRICHTEXT_BUFFERED_PAINTING 1 #else -#define wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE 0 +#define wxRICHTEXT_BUFFERED_PAINTING 0 #endif -#if wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE -#include "wx/textctrl.h" -#endif +class WXDLLIMPEXP_RICHTEXT wxRichTextStyleDefinition; /*! * Styles and flags @@ -84,12 +84,8 @@ * wxRichTextCtrl class declaration */ -class WXDLLIMPEXP_RICHTEXT wxRichTextCtrl: -#if wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE - public wxTextCtrlBase, wxScrollHelper -#else - public wxScrolledWindow -#endif +class WXDLLIMPEXP_RICHTEXT wxRichTextCtrl : public wxTextCtrlBase, + public wxScrollHelper { DECLARE_CLASS( wxRichTextCtrl ) DECLARE_EVENT_TABLE() @@ -116,7 +112,6 @@ public: // Accessors virtual wxString GetValue() const; - virtual void SetValue(const wxString& value); virtual wxString GetRange(long from, long to) const; @@ -156,8 +151,8 @@ public: virtual void Remove(long from, long to); // load/save the controls contents from/to the file - virtual bool LoadFile(const wxString& file, int type = wxRICHTEXT_TYPE_ANY); - virtual bool SaveFile(const wxString& file = wxEmptyString, int type = wxRICHTEXT_TYPE_ANY); + virtual bool DoLoadFile(const wxString& file, int fileType); + virtual bool DoSaveFile(const wxString& file = wxEmptyString, int fileType = wxRICHTEXT_TYPE_ANY); // sets/clears the dirty flag virtual void MarkDirty(); @@ -178,9 +173,22 @@ public: virtual bool SetStyle(long start, long end, const wxTextAttr& style); virtual bool SetStyle(long start, long end, const wxTextAttrEx& style); virtual bool SetStyle(const wxRichTextRange& range, const wxRichTextAttr& style); - virtual bool GetStyle(long position, wxTextAttr& style) const; - virtual bool GetStyle(long position, wxTextAttrEx& style) const; - virtual bool GetStyle(long position, wxRichTextAttr& style) const; + virtual bool GetStyle(long position, wxTextAttr& style); + virtual bool GetStyle(long position, wxTextAttrEx& style); + virtual bool GetStyle(long position, wxRichTextAttr& style); + + // extended style setting operation with flags including: + // wxRICHTEXT_SETSTYLE_WITH_UNDO, wxRICHTEXT_SETSTYLE_OPTIMIZE, wxRICHTEXT_SETSTYLE_PARAGRAPHS_ONLY, wxRICHTEXT_SETSTYLE_CHARACTERS_ONLY + // see richtextbuffer.h for more details. + virtual bool SetStyleEx(long start, long end, const wxTextAttrEx& style, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO); + virtual bool SetStyleEx(const wxRichTextRange& range, const wxTextAttrEx& style, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO); + virtual bool SetStyleEx(const wxRichTextRange& range, const wxRichTextAttr& style, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO); + + /// Get the content (uncombined) attributes for this position. + virtual bool GetUncombinedStyle(long position, wxTextAttr& style); + virtual bool GetUncombinedStyle(long position, wxTextAttrEx& style); + virtual bool GetUncombinedStyle(long position, wxRichTextAttr& style); + virtual bool SetDefaultStyle(const wxTextAttrEx& style); virtual bool SetDefaultStyle(const wxTextAttr& style); @@ -377,9 +385,20 @@ public: /// Clear the selection virtual void SelectNone(); + /// Select the word at the given character position + virtual bool SelectWord(long position); + /// Get/set the selection range in character positions. -1, -1 means no selection. - const wxRichTextRange& GetSelectionRange() const { return m_selectionRange; } - void SetSelectionRange(const wxRichTextRange& range) { m_selectionRange = range; } + /// The range is in API convention, i.e. a single character selection is denoted + /// by (n, n+1) + wxRichTextRange GetSelectionRange() const; + void SetSelectionRange(const wxRichTextRange& range); + + /// Get/set the selection range in character positions. -1, -1 means no selection. + /// The range is in internal format, i.e. a single character selection is denoted + /// by (n, n) + const wxRichTextRange& GetInternalSelectionRange() const { return m_selectionRange; } + void SetInternalSelectionRange(const wxRichTextRange& range) { m_selectionRange = range; } /// Add a new paragraph of text to the end of the buffer virtual wxRichTextRange AddParagraph(const wxString& text); @@ -485,16 +504,16 @@ public: } /// Is all of the selection bold? - virtual bool IsSelectionBold() const; + virtual bool IsSelectionBold(); /// Is all of the selection italics? - virtual bool IsSelectionItalics() const; + virtual bool IsSelectionItalics(); /// Is all of the selection underlined? - virtual bool IsSelectionUnderlined() const; + virtual bool IsSelectionUnderlined(); /// Is all of the selection aligned according to the specified flag? - virtual bool IsSelectionAligned(wxTextAttrAlignment alignment) const; + virtual bool IsSelectionAligned(wxTextAttrAlignment alignment); /// Apply bold to the selection virtual bool ApplyBoldToSelection(); @@ -508,10 +527,16 @@ public: /// Apply alignment to the selection virtual bool ApplyAlignmentToSelection(wxTextAttrAlignment alignment); + /// Apply a named style to the selection + virtual bool ApplyStyle(wxRichTextStyleDefinition* def); + /// Set style sheet, if any. void SetStyleSheet(wxRichTextStyleSheet* styleSheet) { GetBuffer().SetStyleSheet(styleSheet); } wxRichTextStyleSheet* GetStyleSheet() const { return GetBuffer().GetStyleSheet(); } + /// Apply the style sheet to the buffer, for example if the styles have changed. + bool ApplyStyleSheet(wxRichTextStyleSheet* styleSheet = NULL); + // Command handlers void Command(wxCommandEvent& event); @@ -577,8 +602,6 @@ public: /// Scrolling void OnScroll(wxScrollWinEvent& event); -// Implementation - /// Set font, and also default attributes virtual bool SetFont(const wxFont& font); @@ -591,26 +614,16 @@ public: /// Paint the background virtual void PaintBackground(wxDC& dc); +#if wxRICHTEXT_BUFFERED_PAINTING /// Recreate buffer bitmap if necessary virtual bool RecreateBuffer(const wxSize& size = wxDefaultSize); +#endif /// Set the selection virtual void DoSetSelection(long from, long to, bool scrollCaret = true); /// Write text - virtual void DoWriteText(const wxString& value, bool selectionOnly = true); - - /// Send an update event - virtual bool SendUpdateEvent(); - - /// Init command event - void InitCommandEvent(wxCommandEvent& event) const; - - /// do the window-specific processing after processing the update event - // (duplicated code from wxTextCtrlBase) -#if !wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE - virtual void DoUpdateWindowUI(wxUpdateUIEvent& event); -#endif + virtual void DoWriteText(const wxString& value, int flags = 0); /// Should we inherit colours? virtual bool ShouldInheritColours() const { return false; } @@ -630,6 +643,11 @@ public: void SetCaretPosition(long position, bool showAtLineStart = false) ; long GetCaretPosition() const { return m_caretPosition; } + /// The adjusted caret position is the character position adjusted to take + /// into account whether we're at the start of a paragraph, in which case + /// style information should be taken from the next position, not current one. + long GetAdjustedCaretPosition(long caretPos) const; + /// Move caret one visual step forward: this may mean setting a flag /// and keeping the same position if we're going from the end of one line /// to the start of the next, which may be the exact same caret position. @@ -673,36 +691,64 @@ public: /// Returns the first visible position in the current view long GetFirstVisiblePosition() const; -#if wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE + /// Returns the caret position since the default formatting was changed. As + /// soon as this position changes, we no longer reflect the default style + /// in the UI. A value of -2 means that we should only reflect the style of the + /// content under the caret. + long GetCaretPositionForDefaultStyle() const { return m_caretPositionForDefaultStyle; } + + /// Set the caret position for the default style that the user is selecting. + void SetCaretPositionForDefaultStyle(long pos) { m_caretPositionForDefaultStyle = pos; } + + /// Should the UI reflect the default style chosen by the user, rather than the style under + /// the caret? + bool IsDefaultStyleShowing() const { return m_caretPositionForDefaultStyle != -2; } + + /// Convenience function that tells the control to start reflecting the default + /// style, since the user is changing it. + void SetAndShowDefaultStyle(const wxRichTextAttr& attr) + { + SetDefaultStyle(attr); + SetCaretPositionForDefaultStyle(GetCaretPosition()); + } + +// Implementation + WX_FORWARD_TO_SCROLL_HELPER() -#endif // Overrides protected: virtual wxSize DoGetBestSize() const ; + virtual void DoSetValue(const wxString& value, int flags = 0); + + // Data members private: /// Allows nested Freeze/Thaw int m_freezeCount; +#if wxRICHTEXT_BUFFERED_PAINTING /// Buffer bitmap wxBitmap m_bufferBitmap; +#endif /// Text buffer wxRichTextBuffer m_buffer; - /// Filename - wxString m_filename; - wxMenu* m_contextMenu; /// Caret position (1 less than the character position, so -1 is the /// first caret position). long m_caretPosition; + /// Caret position when the default formatting has been changed. As + /// soon as this position changes, we no longer reflect the default style + /// in the UI. + long m_caretPositionForDefaultStyle; + /// Selection range in character positions. -2, -2 means no selection. wxRichTextRange m_selectionRange;