X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/c59f6793fb6c116e6b9abdaca4de0c4a08a0e5b0..2586d4a12176c79b2c34859c95db17cf45b54204:/include/wx/richtext/richtextctrl.h?ds=inline diff --git a/include/wx/richtext/richtextctrl.h b/include/wx/richtext/richtextctrl.h index 4f61ba36d2..bf1e62bafd 100644 --- a/include/wx/richtext/richtextctrl.h +++ b/include/wx/richtext/richtextctrl.h @@ -12,21 +12,25 @@ #ifndef _WX_RICHTEXTCTRL_H_ #define _WX_RICHTEXTCTRL_H_ -#include "wx/textctrl.h" +#include "wx/richtext/richtextbuffer.h" #if wxUSE_RICHTEXT #include "wx/scrolwin.h" #include "wx/caret.h" -#include "wx/richtext/richtextbuffer.h" - #if wxCHECK_VERSION(2,7,0) -#define wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE 0 +#define wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE 1 #else #define wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE 0 #endif +#if wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE +#include "wx/textctrl.h" +#endif + +class WXDLLIMPEXP_RICHTEXT wxRichTextStyleDefinition; + /*! * Styles and flags */ @@ -82,9 +86,9 @@ * wxRichTextCtrl class declaration */ -class WXDLLIMPEXP_ADV wxRichTextCtrl: +class WXDLLIMPEXP_RICHTEXT wxRichTextCtrl: #if wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE - public wxTextCtrlBase, wxScrollHelper + public wxTextCtrlBase, public wxScrollHelper #else public wxScrolledWindow #endif @@ -96,14 +100,14 @@ public: // Constructors wxRichTextCtrl( ); - wxRichTextCtrl( wxWindow* parent, wxWindowID id = -1, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, + wxRichTextCtrl( wxWindow* parent, wxWindowID id = -1, const wxString& value = wxEmptyString, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = wxRE_MULTILINE ); - ~wxRichTextCtrl( ); + virtual ~wxRichTextCtrl( ); // Operations /// Creation - bool Create( wxWindow* parent, wxWindowID id = -1, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, + bool Create( wxWindow* parent, wxWindowID id = -1, const wxString& value = wxEmptyString, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = wxRE_MULTILINE ); /// Member initialisation @@ -153,9 +157,14 @@ public: virtual void Replace(long from, long to, const wxString& value); virtual void Remove(long from, long to); +#if !wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE + bool LoadFile(const wxString& file, int fileType = wxRICHTEXT_TYPE_ANY); + bool SaveFile(const wxString& file = wxEmptyString, int fileType = wxRICHTEXT_TYPE_ANY); +#endif + // 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(); @@ -173,14 +182,24 @@ public: // text control under some platforms supports the text styles: these // methods allow to apply the given text style to the given selection or to // set/get the style which will be used for all appended text + 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, 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); + + /// 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); // TODO: change to GetDefaultStyle if we merge wxTextAttr and wxTextAttrEx virtual const wxTextAttrEx& GetDefaultStyleEx() const; + virtual const wxTextAttr& GetDefaultStyle() const; // translate between the position (which is just an index in the text ctrl // considering all its contents as a single strings) and (x, y) coordinates @@ -231,7 +250,7 @@ public: virtual void Freeze(); /// Call Thaw to refresh - virtual void Thaw(bool refresh = true); + virtual void Thaw(); /// Call Thaw to refresh virtual bool IsFrozen() const { return m_freezeCount > 0; } @@ -372,8 +391,16 @@ public: virtual void SelectNone(); /// 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); @@ -383,7 +410,7 @@ public: /// Layout the buffer: which we must do before certain operations, such as /// setting the caret position. - virtual bool Layout(bool onlyVisibleRect = false); + virtual bool LayoutContent(bool onlyVisibleRect = false); /// Move the caret to the given character position virtual bool MoveCaret(long pos, bool showAtLineStart = false); @@ -479,16 +506,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(); @@ -502,13 +529,19 @@ public: /// Apply alignment to the selection virtual bool ApplyAlignmentToSelection(wxTextAttrAlignment alignment); + /// Apply a named style to the selection + virtual void 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); + void Command(wxCommandEvent& event); void OnDropFiles(wxDropFilesEvent& event); void OnCut(wxCommandEvent& event); @@ -571,8 +604,6 @@ public: /// Scrolling void OnScroll(wxScrollWinEvent& event); -// Implementation - /// Set font, and also default attributes virtual bool SetFont(const wxFont& font); @@ -580,7 +611,7 @@ public: virtual void SetupScrollbars(bool atTop = false); /// Keyboard navigation - virtual bool Navigate(int keyCode, int flags); + virtual bool KeyboardNavigate(int keyCode, int flags); /// Paint the background virtual void PaintBackground(wxDC& dc); @@ -601,7 +632,10 @@ public: 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 /// Should we inherit colours? virtual bool ShouldInheritColours() const { return false; } @@ -621,6 +655,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. @@ -664,7 +703,35 @@ public: /// Returns the first visible position in the current view long GetFirstVisiblePosition() const; + /// 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 + +#if wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE + WX_FORWARD_TO_SCROLL_HELPER() +#endif + // Overrides +protected: virtual wxSize DoGetBestSize() const ; @@ -680,8 +747,10 @@ private: /// Text buffer wxRichTextBuffer m_buffer; +#if !wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE /// Filename wxString m_filename; +#endif wxMenu* m_contextMenu; @@ -689,6 +758,11 @@ private: /// 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; @@ -722,7 +796,7 @@ private: * wxRichTextEvent - the event class for wxRichTextCtrl notifications */ -class WXDLLIMPEXP_ADV wxRichTextEvent : public wxNotifyEvent +class WXDLLIMPEXP_RICHTEXT wxRichTextEvent : public wxNotifyEvent { public: wxRichTextEvent(wxEventType commandType = wxEVT_NULL, int winid = 0) @@ -756,13 +830,13 @@ private: */ BEGIN_DECLARE_EVENT_TYPES() - DECLARE_EVENT_TYPE(wxEVT_COMMAND_RICHTEXT_ITEM_SELECTED, 2600) - DECLARE_EVENT_TYPE(wxEVT_COMMAND_RICHTEXT_ITEM_DESELECTED, 2601) - DECLARE_EVENT_TYPE(wxEVT_COMMAND_RICHTEXT_LEFT_CLICK, 2602) - DECLARE_EVENT_TYPE(wxEVT_COMMAND_RICHTEXT_RIGHT_CLICK, 2603) - DECLARE_EVENT_TYPE(wxEVT_COMMAND_RICHTEXT_MIDDLE_CLICK, 2604) - DECLARE_EVENT_TYPE(wxEVT_COMMAND_RICHTEXT_LEFT_DCLICK, 2605) - DECLARE_EVENT_TYPE(wxEVT_COMMAND_RICHTEXT_RETURN, 2606) + DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_ITEM_SELECTED, 2600) + DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_ITEM_DESELECTED, 2601) + DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_LEFT_CLICK, 2602) + DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_RIGHT_CLICK, 2603) + DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_MIDDLE_CLICK, 2604) + DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_LEFT_DCLICK, 2605) + DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_RETURN, 2606) END_DECLARE_EVENT_TYPES() typedef void (wxEvtHandler::*wxRichTextEventFunction)(wxRichTextEvent&); @@ -780,4 +854,3 @@ typedef void (wxEvtHandler::*wxRichTextEventFunction)(wxRichTextEvent&); #endif // _WX_RICHTEXTCTRL_H_ -