X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/33c0ca829f08f59965d5e43aed676ad10121d351..a60a5499953215f46062de58c0fe5df7b3a27a60:/include/wx/richtext/richtextctrl.h diff --git a/include/wx/richtext/richtextctrl.h b/include/wx/richtext/richtextctrl.h index 61f0ddb250..15c1d3791a 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_ADV 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() @@ -98,14 +94,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 @@ -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(); @@ -175,14 +170,48 @@ 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); + + // 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); // TODO: change to GetDefaultStyle if we merge wxTextAttr and wxTextAttrEx virtual const wxTextAttrEx& GetDefaultStyleEx() const; + virtual const wxTextAttr& GetDefaultStyle() const; + + /// Set list style + virtual bool SetListStyle(const wxRichTextRange& range, wxRichTextListStyleDefinition* def, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom = 1, int specifiedLevel = -1); + virtual bool SetListStyle(const wxRichTextRange& range, const wxString& defName, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom = 1, int specifiedLevel = -1); + + /// Clear list for given range + virtual bool ClearListStyle(const wxRichTextRange& range, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO); + + /// Number/renumber any list elements in the given range + /// def/defName can be NULL/empty to indicate that the existing list style should be used. + virtual bool NumberList(const wxRichTextRange& range, wxRichTextListStyleDefinition* def = NULL, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom = 1, int specifiedLevel = -1); + virtual bool NumberList(const wxRichTextRange& range, const wxString& defName, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom = 1, int specifiedLevel = -1); + + /// Promote the list items within the given range. promoteBy can be a positive or negative number, e.g. 1 or -1 + /// def/defName can be NULL/empty to indicate that the existing list style should be used. + virtual bool PromoteList(int promoteBy, const wxRichTextRange& range, wxRichTextListStyleDefinition* def = NULL, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int specifiedLevel = -1); + virtual bool PromoteList(int promoteBy, const wxRichTextRange& range, const wxString& defName, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int specifiedLevel = -1); // 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 @@ -355,6 +384,13 @@ public: /// End symbol bullet bool EndSymbolBullet() { return GetBuffer().EndSymbolBullet(); } + /// Begin standard bullet + bool BeginStandardBullet(const wxString& bulletName, int leftIndent, int leftSubIndent, int bulletStyle = wxTEXT_ATTR_BULLET_STYLE_STANDARD) + { return GetBuffer().BeginStandardBullet(bulletName, leftIndent, leftSubIndent, bulletStyle); } + + /// End standard bullet + bool EndStandardBullet() { return GetBuffer().EndStandardBullet(); } + /// Begin named character style bool BeginCharacterStyle(const wxString& characterStyle) { return GetBuffer().BeginCharacterStyle(characterStyle); } @@ -367,15 +403,32 @@ public: /// End named character style bool EndParagraphStyle() { return GetBuffer().EndParagraphStyle(); } + /// Begin named list style + bool BeginListStyle(const wxString& listStyle, int level = 1, int number = 1) { return GetBuffer().BeginListStyle(listStyle, level, number); } + + /// End named character style + bool EndListStyle() { return GetBuffer().EndListStyle(); } + /// Sets the default style to the style under the cursor bool SetDefaultStyleToCursorStyle(); /// 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); @@ -481,16 +534,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(); @@ -504,13 +557,25 @@ public: /// Apply alignment to the selection virtual bool ApplyAlignmentToSelection(wxTextAttrAlignment alignment); - /// Set style sheet, if any. + /// 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(); } + /// Push style sheet to top of stack + bool PushStyleSheet(wxRichTextStyleSheet* styleSheet) { return GetBuffer().PushStyleSheet(styleSheet); } + + /// Pop style sheet from top of stack + wxRichTextStyleSheet* PopStyleSheet() { return GetBuffer().PopStyleSheet(); } + + /// 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); @@ -573,12 +638,6 @@ public: /// Scrolling void OnScroll(wxScrollWinEvent& event); -// Implementation - -#if wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE - WX_FORWARD_TO_SCROLL_HELPER() -#endif - /// Set font, and also default attributes virtual bool SetFont(const wxFont& font); @@ -591,23 +650,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 - virtual void DoUpdateWindowUI(wxUpdateUIEvent& event); + virtual void DoWriteText(const wxString& value, int flags = 0); /// Should we inherit colours? virtual bool ShouldInheritColours() const { return false; } @@ -627,6 +679,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. @@ -670,31 +727,68 @@ 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 + + /// Font names take a long time to retrieve, so cache them (on demand) + static const wxArrayString& GetAvailableFontNames(); + static void ClearAvailableFontNames(); + + WX_FORWARD_TO_SCROLL_HELPER() + // 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; @@ -722,13 +816,15 @@ private: /// Threshold for doing delayed layout long m_delayedLayoutThreshold; + + static wxArrayString sm_availableFontNames; }; /*! * 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) @@ -762,13 +858,13 @@ private: */ BEGIN_DECLARE_EVENT_TYPES() - DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_RICHTEXT_ITEM_SELECTED, 2600) - DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_RICHTEXT_ITEM_DESELECTED, 2601) - DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_RICHTEXT_LEFT_CLICK, 2602) - DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_RICHTEXT_RIGHT_CLICK, 2603) - DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_RICHTEXT_MIDDLE_CLICK, 2604) - DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_RICHTEXT_LEFT_DCLICK, 2605) - DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, 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&); @@ -786,4 +882,3 @@ typedef void (wxEvtHandler::*wxRichTextEventFunction)(wxRichTextEvent&); #endif // _WX_RICHTEXTCTRL_H_ -