Add documentation of wxFileSelectorEx() and wx{Load,Save}FileSelector().

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

diff --git a/interface/wx/richtext/richtextctrl.h b/interface/wx/richtext/richtextctrl.h
index baf58d29a6456117c5ceded43263cb94a0ce3780..b341941c6099cafe386a7891c69ea0b75cf9ee9c 100644 (file)
--- a/interface/wx/richtext/richtextctrl.h
+++ b/interface/wx/richtext/richtextctrl.h
@@ -111,7 +111,7 @@ public:
         Adds appropriate menu items for the current container and clicked on object
         (and container's parent, if appropriate).
     */
         Adds appropriate menu items for the current container and clicked on object
         (and container's parent, if appropriate).
     */

-    int AddItems(wxRichTextObject* container, wxRichTextObject* obj);
+    int AddItems(wxRichTextCtrl* ctrl, wxRichTextObject* container, wxRichTextObject* obj);

 
     /**
         Clears the items.
 
     /**
         Clears the items.


@@ -392,24 +392,44 @@ public:
     void SetCaretAtLineStart(bool atStart) { m_caretAtLineStart = atStart; }
 
     /**
     void SetCaretAtLineStart(bool atStart) { m_caretAtLineStart = atStart; }
 
     /**

-        Returns @true if we are dragging a selection.
+        Returns @true if we are extending a selection.

     */
     bool GetDragging() const { return m_dragging; }
 
     /**
     */
     bool GetDragging() const { return m_dragging; }
 
     /**

-        Sets a flag to remember if we are dragging a selection.
+        Sets a flag to remember if we are extending a selection.

     */
     void SetDragging(bool dragging) { m_dragging = dragging; }
 
     /**
     */
     void SetDragging(bool dragging) { m_dragging = dragging; }
 
     /**

-        Returns the drag start position.
+        Are we trying to start Drag'n'Drop?

     */
     */

-    const wxPoint& GetDragStart() const { return m_dragStart; }
+    bool GetPreDrag() const { return m_preDrag; }

 
     /**
 
     /**

-        Sets the drag start position.
+        Set if we're trying to start Drag'n'Drop

     */
     */

-    void SetDragStart(const wxPoint& pt) { m_dragStart = pt; }
+    void SetPreDrag(bool pd) { m_preDrag = pd; }
+
+    /**
+        Get the possible Drag'n'Drop start point
+    */
+    const wxPoint GetDragStartPoint() const { return m_dragStartPoint; }
+
+    /**
+        Set the possible Drag'n'Drop start point
+    */
+    void SetDragStartPoint(wxPoint sp) { m_dragStartPoint = sp; }
+
+    /**
+        Get the possible Drag'n'Drop start time
+    */
+    const wxDateTime GetDragStartTime() const { return m_dragStartTime; }
+
+    /**
+        Set the possible Drag'n'Drop start time
+    */
+    void SetDragStartTime(wxDateTime st) { m_dragStartTime = st; }

 
 #if wxRICHTEXT_BUFFERED_PAINTING
     //@{
 
 #if wxRICHTEXT_BUFFERED_PAINTING
     //@{


@@ -471,8 +491,15 @@ public:
     */
     wxRichTextParagraphLayoutBox* GetFocusObject() const { return m_focusObject; }
 
     */
     wxRichTextParagraphLayoutBox* GetFocusObject() const { return m_focusObject; }
 

+    /**
+        Setter for m_focusObject.
+    */
+    void StoreFocusObject(wxRichTextParagraphLayoutBox* obj);
+

     /**
         Sets the wxRichTextObject object that currently has the editing focus.
     /**
         Sets the wxRichTextObject object that currently has the editing focus.

+        @param setCaretPosition
+            Optionally set the caret position.

     */
     bool SetFocusObject(wxRichTextParagraphLayoutBox* obj, bool setCaretPosition = true);
 
     */
     bool SetFocusObject(wxRichTextParagraphLayoutBox* obj, bool setCaretPosition = true);
 


@@ -783,6 +810,28 @@ public:
     virtual bool PromoteList(int promoteBy, const wxRichTextRange& range, const wxString& defName, 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);
     //@}
 

+    /**
+        Sets the properties for the given range, passing flags to determine how the
+        attributes are set. You can merge properties or replace them.
+
+        The end point of range is specified as the last character position of the span
+        of text, plus one. So, for example, to set the properties for a character at
+        position 5, use the range (5,6).
+
+        @a flags may contain a bit list of the following values:
+        - wxRICHTEXT_SETSPROPERTIES_NONE: no flag.
+        - wxRICHTEXT_SETPROPERTIES_WITH_UNDO: specifies that this operation should be
+          undoable.
+        - wxRICHTEXT_SETPROPERTIES_PARAGRAPHS_ONLY: specifies that the properties should only be
+          applied to paragraphs, and not the content.
+        - wxRICHTEXT_SETPROPERTIES_CHARACTERS_ONLY: specifies that the properties should only be
+          applied to characters, and not the paragraph.
+        - wxRICHTEXT_SETPROPERTIES_RESET: resets (clears) the existing properties before applying
+          the new properties.
+        - wxRICHTEXT_SETPROPERTIES_REMOVE: removes the specified properties.
+    */
+    virtual bool SetProperties(const wxRichTextRange& range, const wxRichTextProperties& properties, int flags = wxRICHTEXT_SETPROPERTIES_WITH_UNDO);
+

     /**
         Deletes the content within the given range.
     */
     /**
         Deletes the content within the given range.
     */


@@ -813,6 +862,11 @@ public:
     virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt,
                                             wxTextCoord *col,
                                             wxTextCoord *row) const;
     virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt,
                                             wxTextCoord *col,
                                             wxTextCoord *row) const;

+
+    /**
+        Finds the container at the given point, which is assumed to be in client coordinates.
+    */
+    wxRichTextParagraphLayoutBox* FindContainerAtPoint(const wxPoint pt, long& position, int& hit, wxRichTextObject* hitObj, int flags = 0);

     //@}
 
 // Clipboard operations
     //@}
 
 // Clipboard operations


@@ -1449,42 +1503,53 @@ public:
     }
 
     /**
     }
 
     /**

-        Returns @true if all of the selection is bold.
+        Returns @true if all of the selection, or the content at the caret position, is bold.

     */
     virtual bool IsSelectionBold();
 
     /**
     */
     virtual bool IsSelectionBold();
 
     /**

-        Returns @true if all of the selection is italic.
+        Returns @true if all of the selection, or the content at the caret position, is italic.

     */
     virtual bool IsSelectionItalics();
 
     /**
     */
     virtual bool IsSelectionItalics();
 
     /**

-        Returns @true if all of the selection is underlined.
+        Returns @true if all of the selection, or the content at the caret position, is underlined.

     */
     virtual bool IsSelectionUnderlined();
 
     */
     virtual bool IsSelectionUnderlined();
 

+    /**
+        Returns @true if all of the selection, or the content at the current caret position, has the supplied wxTextAttrEffects flag(s).
+    */
+    virtual bool DoesSelectionHaveTextEffectFlag(int flag);
+

     /**
         Returns @true if all of the selection is aligned according to the specified flag.
     */
     virtual bool IsSelectionAligned(wxTextAttrAlignment alignment);
 
     /**
     /**
         Returns @true if all of the selection is aligned according to the specified flag.
     */
     virtual bool IsSelectionAligned(wxTextAttrAlignment alignment);
 
     /**

-        Apples bold to the selection (undoable).
+        Apples bold to the selection or the default style (undoable).

     */
     virtual bool ApplyBoldToSelection();
 
     /**
     */
     virtual bool ApplyBoldToSelection();
 
     /**

-        Applies italic to the selection (undoable).
+        Applies italic to the selection or the default style (undoable).

     */
     virtual bool ApplyItalicToSelection();
 
     /**
     */
     virtual bool ApplyItalicToSelection();
 
     /**

-        Applies underline to the selection (undoable).
+        Applies underline to the selection or the default style (undoable).

     */
     virtual bool ApplyUnderlineToSelection();
 
     /**
     */
     virtual bool ApplyUnderlineToSelection();
 
     /**

-        Applies the given alignment to the selection (undoable).
+        Applies one or more wxTextAttrEffects flags to the selection (undoable).
+        If there is no selection, it is applied to the default style.
+    */
+    virtual bool ApplyTextEffectToSelection(int flags);
+
+    /**
+        Applies the given alignment to the selection or the default style (undoable).

         For alignment values, see wxTextAttr.
     */
     virtual bool ApplyAlignmentToSelection(wxTextAttrAlignment alignment);
         For alignment values, see wxTextAttr.
     */
     virtual bool ApplyAlignmentToSelection(wxTextAttrAlignment alignment);


@@ -1526,6 +1591,60 @@ public:
     */
     bool ApplyStyleSheet(wxRichTextStyleSheet* styleSheet = NULL);
 
     */
     bool ApplyStyleSheet(wxRichTextStyleSheet* styleSheet = NULL);
 

+    /**
+        Shows the given context menu, optionally adding appropriate property-editing commands for the current position in the object hierarchy.
+    */
+    virtual bool ShowContextMenu(wxMenu* menu, const wxPoint& pt, bool addPropertyCommands);
+
+    /**
+        Prepares the context menu, optionally adding appropriate property-editing commands.
+        Returns the number of property commands added.
+    */
+    virtual int PrepareContextMenu(wxMenu* menu, const wxPoint& pt, bool addPropertyCommands);
+
+    /**
+        Returns @true if we can edit the object's properties via a GUI.
+    */
+    virtual bool CanEditProperties(wxRichTextObject* obj) const;
+
+    /**
+        Edits the object's properties via a GUI.
+    */
+    virtual bool EditProperties(wxRichTextObject* obj, wxWindow* parent);
+
+    /**
+        Gets the object's properties menu label.
+    */
+    virtual wxString GetPropertiesMenuLabel(wxRichTextObject* obj);
+
+    /**
+        Prepares the content just before insertion (or after buffer reset). Called by the same function in wxRichTextBuffer.
+        Currently is only called if undo mode is on.
+    */
+    virtual void PrepareContent(wxRichTextParagraphLayoutBox& WXUNUSED(container)) {}
+
+    /**
+        Can we delete this range?
+        Sends an event to the control.
+    */
+    virtual bool CanDeleteRange(wxRichTextParagraphLayoutBox& container, const wxRichTextRange& range) const;
+
+    /**
+        Can we insert content at this position?
+        Sends an event to the control.
+    */
+    virtual bool CanInsertContent(wxRichTextParagraphLayoutBox& container, long pos) const;
+
+    /**
+        Enable or disable the vertical scrollbar.
+    */
+    virtual void EnableVerticalScrollbar(bool enable);
+
+    /**
+        Returns @true if the vertical scrollbar is enabled.
+    */
+    virtual bool GetVerticalScrollbarEnabled() const;
+

 // Command handlers
 
     /**
 // Command handlers
 
     /**


@@ -1917,6 +2036,11 @@ public:
     long FindCaretPositionForCharacterPosition(long position, int hitTestFlags, wxRichTextParagraphLayoutBox* container,
                                                    bool& caretLineStart);
 
     long FindCaretPositionForCharacterPosition(long position, int hitTestFlags, wxRichTextParagraphLayoutBox* container,
                                                    bool& caretLineStart);
 

+    /**
+        Processes mouse movement in order to change the cursor
+    */
+    virtual bool ProcessMouseMovement(wxRichTextParagraphLayoutBox* container, wxRichTextObject* obj, long position, const wxPoint& pos);
+

     /**
         Font names take a long time to retrieve, so cache them (on demand).
     */
     /**
         Font names take a long time to retrieve, so cache them (on demand).
     */


@@ -1969,7 +2093,7 @@ protected:
 
 
 // Data members
 
 
 // Data members

-private:
+protected:

 #if wxRICHTEXT_BUFFERED_PAINTING
     /// Buffer bitmap
     wxBitmap                m_bufferBitmap;
 #if wxRICHTEXT_BUFFERED_PAINTING
     /// Buffer bitmap
     wxBitmap                m_bufferBitmap;


@@ -2011,9 +2135,6 @@ private:
     /// Are we dragging a selection?
     bool                    m_dragging;
 
     /// Are we dragging a selection?
     bool                    m_dragging;
 

-    /// Start position for drag
-    wxPoint                 m_dragStart;
-

     /// Do we need full layout in idle?
     bool                    m_fullLayoutRequired;
     wxLongLong              m_fullLayoutTime;
     /// Do we need full layout in idle?
     bool                    m_fullLayoutRequired;
     wxLongLong              m_fullLayoutTime;


@@ -2050,7 +2171,7 @@ private:
         Process a @c wxEVT_COMMAND_RICHTEXT_MIDDLE_CLICK event, generated when the user
         releases the middle mouse button over an object.
     @event{EVT_RICHTEXT_LEFT_DCLICK(id, func)}
         Process a @c wxEVT_COMMAND_RICHTEXT_MIDDLE_CLICK event, generated when the user
         releases the middle mouse button over an object.
     @event{EVT_RICHTEXT_LEFT_DCLICK(id, func)}

-        Process a @c wxEVT_COMMAND_RICHTEXT_DLEFT_CLICK event, generated when the user
+        Process a @c wxEVT_COMMAND_RICHTEXT_LEFT_DCLICK event, generated when the user

         double-clicks an object.
     @event{EVT_RICHTEXT_RETURN(id, func)}
         Process a @c wxEVT_COMMAND_RICHTEXT_RETURN event, generated when the user
         double-clicks an object.
     @event{EVT_RICHTEXT_RETURN(id, func)}
         Process a @c wxEVT_COMMAND_RICHTEXT_RETURN event, generated when the user


@@ -2081,6 +2202,9 @@ private:
         when the control's stylesheet has been replaced, for example when a file
         is loaded into the control.
         Valid event functions: GetOldStyleSheet, GetNewStyleSheet.
         when the control's stylesheet has been replaced, for example when a file
         is loaded into the control.
         Valid event functions: GetOldStyleSheet, GetNewStyleSheet.

+    @event{EVT_RICHTEXT_PROPERTIES_CHANGED(id, func)}
+        Process a @c wxEVT_COMMAND_RICHTEXT_PROPERTIES_CHANGED event, generated when
+        properties have been applied to the control. Valid event functions: GetPosition, GetRange.

     @event{EVT_RICHTEXT_CONTENT_INSERTED(id, func)}
         Process a @c wxEVT_COMMAND_RICHTEXT_CONTENT_INSERTED event, generated when
         content has been inserted into the control.
     @event{EVT_RICHTEXT_CONTENT_INSERTED(id, func)}
         Process a @c wxEVT_COMMAND_RICHTEXT_CONTENT_INSERTED event, generated when
         content has been inserted into the control.


@@ -2133,7 +2257,7 @@ public:
         { }
 
     /**
         { }
 
     /**

-        Returns the buffer position at which the event occured.
+        Returns the buffer position at which the event occurred.

     */
     long GetPosition() const { return m_position; }
 
     */
     long GetPosition() const { return m_position; }