Missing header.

[wxWidgets.git] / include / wx / richtext / richtextctrl.h

diff --git a/include/wx/richtext/richtextctrl.h b/include/wx/richtext/richtextctrl.h
index 407fc1cb95151ef81ac75be93a36a9a62fcfeed4..b008d5d984e382ea177b2f474ff8944ec548d08e 100644 (file)
--- a/include/wx/richtext/richtextctrl.h
+++ b/include/wx/richtext/richtextctrl.h
@@ -12,21 +12,25 @@
 #ifndef _WX_RICHTEXTCTRL_H_
 #define _WX_RICHTEXTCTRL_H_
 
 #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"
 
 
 #if wxUSE_RICHTEXT
 
 #include "wx/scrolwin.h"
 #include "wx/caret.h"
 

-#include "wx/richtext/richtextbuffer.h"
-

 #if wxCHECK_VERSION(2,7,0)
 #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
 
 #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
  */
 /*!
  * Styles and flags
  */


@@ -82,9 +86,9 @@
  * wxRichTextCtrl class declaration
  */
 
  * wxRichTextCtrl class declaration
  */
 

-class WXDLLIMPEXP_ADV wxRichTextCtrl:
+class WXDLLIMPEXP_RICHTEXT wxRichTextCtrl:

 #if wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE
 #if wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE

- public wxTextCtrlBase, wxScrollHelper
+ public wxTextCtrlBase, public wxScrollHelper

 #else
  public wxScrolledWindow
 #endif
 #else
  public wxScrolledWindow
 #endif


@@ -96,14 +100,14 @@ public:
 // Constructors
 
     wxRichTextCtrl( );
 // 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 );
         long style = wxRE_MULTILINE );

-    ~wxRichTextCtrl( );
+    virtual ~wxRichTextCtrl( );

 
 // Operations
 
     /// Creation
 
 // 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
         long style = wxRE_MULTILINE );
 
     /// Member initialisation


@@ -173,14 +177,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
     // 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 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 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;
 
     // 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
 
     // 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 +239,7 @@ public:
     virtual void Freeze();
 
     /// Call Thaw to refresh
     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; }
 
     /// Call Thaw to refresh
     virtual bool IsFrozen() const { return m_freezeCount > 0; }


@@ -383,7 +391,7 @@ public:
 
     /// Layout the buffer: which we must do before certain operations, such as
     /// setting the caret position.
 
     /// 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);
 
     /// Move the caret to the given character position
     virtual bool MoveCaret(long pos, bool showAtLineStart = false);


@@ -502,13 +510,16 @@ public:
     /// Apply alignment to the selection
     virtual bool ApplyAlignmentToSelection(wxTextAttrAlignment alignment);
 
     /// 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(); }
 
 // Command handlers
 
     /// Set style sheet, if any.
     void SetStyleSheet(wxRichTextStyleSheet* styleSheet) { GetBuffer().SetStyleSheet(styleSheet); }
     wxRichTextStyleSheet* GetStyleSheet() const { return GetBuffer().GetStyleSheet(); }
 
 // Command handlers
 

-    void Command(wxCommandEvent & event);
+    void Command(wxCommandEvent& event);

     void OnDropFiles(wxDropFilesEvent& event);
 
     void OnCut(wxCommandEvent& event);
     void OnDropFiles(wxDropFilesEvent& event);
 
     void OnCut(wxCommandEvent& event);


@@ -568,6 +579,9 @@ public:
     /// Idle-time processing
     void OnIdle(wxIdleEvent& event);
 
     /// Idle-time processing
     void OnIdle(wxIdleEvent& event);
 

+    /// Scrolling
+    void OnScroll(wxScrollWinEvent& event);
+

 // Implementation
 
     /// Set font, and also default attributes
 // Implementation
 
     /// Set font, and also default attributes


@@ -577,7 +591,7 @@ public:
     virtual void SetupScrollbars(bool atTop = false);
 
     /// Keyboard navigation
     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);
 
     /// Paint the background
     virtual void PaintBackground(wxDC& dc);


@@ -598,7 +612,10 @@ public:
     void InitCommandEvent(wxCommandEvent& event) const;
 
     /// do the window-specific processing after processing the update 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);
     virtual void DoUpdateWindowUI(wxUpdateUIEvent& event);

+#endif

 
     /// Should we inherit colours?
     virtual bool ShouldInheritColours() const { return false; }
 
     /// Should we inherit colours?
     virtual bool ShouldInheritColours() const { return false; }


@@ -618,6 +635,11 @@ public:
     void SetCaretPosition(long position, bool showAtLineStart = false) ;
     long GetCaretPosition() const { return m_caretPosition; }
 
     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.
     /// 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.


@@ -661,7 +683,33 @@ public:
     /// Returns the first visible position in the current view
     long GetFirstVisiblePosition() const;
 
     /// 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());
+    }
+
+#if wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE
+     WX_FORWARD_TO_SCROLL_HELPER()
+#endif
+

 // Overrides
 // Overrides

+protected:

 
     virtual wxSize DoGetBestSize() const ;
 
 
     virtual wxSize DoGetBestSize() const ;
 


@@ -686,6 +734,11 @@ private:
     /// first caret position).
     long                    m_caretPosition;
 
     /// 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;
 
     /// Selection range in character positions. -2, -2 means no selection.
     wxRichTextRange         m_selectionRange;
 


@@ -719,7 +772,7 @@ private:
  * wxRichTextEvent - the event class for wxRichTextCtrl notifications
  */
 
  * 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)
 {
 public:
     wxRichTextEvent(wxEventType commandType = wxEVT_NULL, int winid = 0)


@@ -753,13 +806,13 @@ private:
  */
 
 BEGIN_DECLARE_EVENT_TYPES()
  */
 
 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&);
 END_DECLARE_EVENT_TYPES()
 
 typedef void (wxEvtHandler::*wxRichTextEventFunction)(wxRichTextEvent&);