Clarified difference between SetInsertionPoint and MoveCaret.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@62022 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/interface/wx/richtext/richtextctrl.h b/interface/wx/richtext/richtextctrl.h
index d7f4147ef3c43a72beeba1a16a9b5df8b607f28f..d6710e470b206a29af477a776485dc83344cec38 100644 (file)
--- a/interface/wx/richtext/richtextctrl.h
+++ b/interface/wx/richtext/richtextctrl.h
@@ -953,6 +953,9 @@ public:
 
     /**
         Move the caret to the given character position.
 
     /**
         Move the caret to the given character position.

+
+        Please note that this does not update the current editing style
+        from the new position; to do that, call wxRichTextCtrl::SetInsertionPoint instead.

     */
     virtual bool MoveCaret(long pos, bool showAtLineStart = false);
 
     */
     virtual bool MoveCaret(long pos, bool showAtLineStart = false);
 


@@ -1254,8 +1257,13 @@ public:
     virtual void SetBasicStyle(const wxTextAttr& style);
 
     /**
     virtual void SetBasicStyle(const wxTextAttr& style);
 
     /**

+        Sets the caret position.
+

         The caret position is the character position just before the caret.
         A value of -1 means the caret is at the start of the buffer.
         The caret position is the character position just before the caret.
         A value of -1 means the caret is at the start of the buffer.

+        Please note that this does not update the current editing style
+        from the new position or cause the actual caret to be refreshed; to do that,
+        call wxRichTextCtrl::SetInsertionPoint instead.

     */
     void SetCaretPosition(long position,
                           bool showAtLineStart = false);
     */
     void SetCaretPosition(long position,
                           bool showAtLineStart = false);


@@ -1302,7 +1310,8 @@ public:
     void SetHandlerFlags(int flags);
 
     /**
     void SetHandlerFlags(int flags);
 
     /**

-        Sets the insertion point.
+        Sets the insertion point and causes the current editing style to be taken from
+        the new position (unlike wxRichTextCtrl::SetCaretPosition).

     */
     virtual void SetInsertionPoint(long pos);
 
     */
     virtual void SetInsertionPoint(long pos);