interface revisions

[wxWidgets.git] / interface / wx / textctrl.h

diff --git a/interface/wx/textctrl.h b/interface/wx/textctrl.h
index dd0cad1d1e21d897013b80bce0dfc68466baff31..be226d3b26131fcbd71781016e31ef29f3162a5c 100644 (file)
--- a/interface/wx/textctrl.h
+++ b/interface/wx/textctrl.h
@@ -1001,7 +1001,7 @@ public:
 
     @library{wxcore}
     @category{ctrl}
-    <!-- @appearance{textctrl.png} -->
+    @appearance{textctrl.png}
 
     @see wxTextCtrl::Create, wxValidator
 */
@@ -1069,7 +1069,7 @@ public:
 
         @see WriteText()
     */
-    void AppendText(const wxString& text);
+    virtual void AppendText(const wxString& text);
 
     /**
         Call this function to enable auto-completion of the text typed in a
@@ -1087,7 +1087,7 @@ public:
 
         @see AutoCompleteFileNames()
     */
-    bool AutoComplete(const wxArrayString& choices);
+    virtual bool AutoComplete(const wxArrayString& choices);
 
     /**
         Call this function to enable auto-completion of the text typed in a
@@ -1105,17 +1105,17 @@ public:
 
         @see AutoComplete()
     */
-    bool AutoCompleteFileNames();
+    virtual bool AutoCompleteFileNames();
 
     /**
         Returns @true if the selection can be copied to the clipboard.
     */
-    virtual bool CanCopy();
+    virtual bool CanCopy() const;
 
     /**
         Returns @true if the selection can be cut to the clipboard.
     */
-    virtual bool CanCut();
+    virtual bool CanCut() const;
 
     /**
         Returns @true if the contents of the clipboard can be pasted into the
@@ -1124,26 +1124,32 @@ public:
         On some platforms (Motif, GTK) this is an approximation and returns
         @true if the control is editable, @false otherwise.
     */
-    virtual bool CanPaste();
+    virtual bool CanPaste() const;
 
     /**
         Returns @true if there is a redo facility available and the last
         operation can be redone.
     */
-    virtual bool CanRedo();
+    virtual bool CanRedo() const;
 
     /**
         Returns @true if there is an undo facility available and the last
         operation can be undone.
     */
-    virtual bool CanUndo();
+    virtual bool CanUndo() const;
 
     /**
-        Sets the text value and marks the control as not-modified (which means
-        that IsModified() would return @false immediately after the call to SetValue()).
+        Sets the new text control value.
+
+        It also marks the control as not-modified which means that IsModified()
+        would return @false immediately after the call to SetValue().
+
+        The insertion point is set to the start of the control (i.e. position
+        0) by this function.
 
         This functions does not generate the @c wxEVT_COMMAND_TEXT_UPDATED
         event but otherwise is identical to SetValue().
+
         See @ref overview_eventhandling_prog for more information.
 
         @since 2.7.1
@@ -1320,7 +1326,7 @@ public:
 
         If there is no selection, the returned string is empty.
     */
-    virtual wxString GetStringSelection();
+    virtual wxString GetStringSelection() const;
 
     /**
         Returns the style at this position in the text control.
@@ -1545,7 +1551,7 @@ public:
         Sets the insertion point at the given position.
 
         @param pos
-            Position to set.
+            Position to set, in the range from 0 to GetLastPosition() inclusive.
     */
     virtual void SetInsertionPoint(long pos);
 
@@ -1630,11 +1636,17 @@ public:
     virtual bool SetStyle(long start, long end, const wxTextAttr& style);
 
     /**
-        Sets the text value and marks the control as not-modified (which means
-        that IsModified() would return @false immediately after the call to SetValue()).
+        Sets the new text control value.
+       
+        It also marks the control as not-modified which means that IsModified()
+        would return @false immediately after the call to SetValue().
+
+        The insertion point is set to the start of the control (i.e. position
+        0) by this function.
 
-        Note that this function generates a @c wxEVT_COMMAND_TEXT_UPDATED
-        event, to avoid this you can use ChangeValue() instead.
+        Note that, unlike most other functions changing the controls values,
+        this function generates a @c wxEVT_COMMAND_TEXT_UPDATED event. To avoid
+        this you can use ChangeValue() instead.
 
         @param value
             The new value to set. It may contain newline characters if the text