X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7fe8059f5825e58af0864e5933e43e5f0526bc76..b5e31cc8e2c4e5399548a637e3b9705d37a19335:/include/wx/richtext/richtextctrl.h diff --git a/include/wx/richtext/richtextctrl.h b/include/wx/richtext/richtextctrl.h index a1e9c69772..a2abcbd989 100644 --- a/include/wx/richtext/richtextctrl.h +++ b/include/wx/richtext/richtextctrl.h @@ -12,21 +12,23 @@ #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 #else #define wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE 0 #endif +#if wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE +#include "wx/textctrl.h" +#endif + /*! * Styles and flags */ @@ -57,6 +59,10 @@ #define wxRICHTEXT_DEFAULT_TYPE_COLOUR wxColour(0, 0, 200) #define wxRICHTEXT_DEFAULT_FOCUS_RECT_COLOUR wxColour(100, 80, 80) #define wxRICHTEXT_DEFAULT_CARET_WIDTH 2 +// Minimum buffer size before delayed layout kicks in +#define wxRICHTEXT_DEFAULT_DELAYED_LAYOUT_THRESHOLD 20000 +// Milliseconds before layout occurs after resize +#define wxRICHTEXT_DEFAULT_LAYOUT_INTERVAL 50 /*! * Forward declarations @@ -78,7 +84,7 @@ * wxRichTextCtrl class declaration */ -class WXDLLIMPEXP_ADV wxRichTextCtrl: +class WXDLLIMPEXP_RICHTEXT wxRichTextCtrl: #if wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE public wxTextCtrlBase, wxScrollHelper #else @@ -92,14 +98,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 @@ -136,6 +142,12 @@ public: /// Set filename void SetFilename(const wxString& filename) { m_filename = filename; } + /// Set the threshold in character positions for doing layout optimization during sizing + void SetDelayedLayoutThreshold(long threshold) { m_delayedLayoutThreshold = threshold; } + + /// Get the threshold in character positions for doing layout optimization during sizing + long GetDelayedLayoutThreshold() const { return m_delayedLayoutThreshold; } + // Operations // editing @@ -163,14 +175,18 @@ 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, wxTextAttr& style) const; virtual bool GetStyle(long position, wxTextAttrEx& style) const; virtual bool GetStyle(long position, wxRichTextAttr& style) const; 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 @@ -221,7 +237,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; } @@ -373,7 +389,7 @@ public: /// Layout the buffer: which we must do before certain operations, such as /// setting the caret position. - virtual bool Layout(); + virtual bool LayoutContent(bool onlyVisibleRect = false); /// Move the caret to the given character position virtual bool MoveCaret(long pos, bool showAtLineStart = false); @@ -498,7 +514,7 @@ public: // Command handlers - void Command(wxCommandEvent & event); + void Command(wxCommandEvent& event); void OnDropFiles(wxDropFilesEvent& event); void OnCut(wxCommandEvent& event); @@ -555,16 +571,22 @@ public: void OnSetFocus(wxFocusEvent& event); void OnKillFocus(wxFocusEvent& event); + /// Idle-time processing + void OnIdle(wxIdleEvent& event); + + /// Scrolling + void OnScroll(wxScrollWinEvent& event); + // Implementation /// Set font, and also default attributes virtual bool SetFont(const wxFont& font); /// Set up scrollbars, e.g. after a resize - virtual void SetupScrollbars(); + 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); @@ -585,7 +607,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; } @@ -633,10 +658,10 @@ public: bool DeleteSelectedContent(long* newPos= NULL); /// Transform logical to physical - wxPoint GetPhysicalPoint(const wxPoint& ptLogical); + wxPoint GetPhysicalPoint(const wxPoint& ptLogical) const; /// Transform physical to logical - wxPoint GetLogicalPoint(const wxPoint& ptPhysical); + wxPoint GetLogicalPoint(const wxPoint& ptPhysical) const; /// Finds the caret position for the next word. Direction /// is 1 (forward) or -1 (backwards). @@ -645,7 +670,15 @@ public: /// Is the given position visible on the screen? bool IsPositionVisible(long pos) const; + /// Returns the first visible position in the current view + long GetFirstVisiblePosition() const; + +#if wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE + WX_FORWARD_TO_SCROLL_HELPER() +#endif + // Overrides +protected: virtual wxSize DoGetBestSize() const ; @@ -689,13 +722,21 @@ private: /// Start position for drag wxPoint m_dragStart; + + /// Do we need full layout in idle? + bool m_fullLayoutRequired; + wxLongLong m_fullLayoutTime; + long m_fullLayoutSavedPosition; + + /// Threshold for doing delayed layout + long m_delayedLayoutThreshold; }; /*! * 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) @@ -729,13 +770,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&);