From 7de202a64d19bb125d338b179948402bcd48dc24 Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Tue, 7 Oct 2008 11:34:46 +0000 Subject: [PATCH] document that Set/ChangeValue() set the insertion point to 0 git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@56145 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- interface/wx/textctrl.h | 26 +++++++++++++++++++------- 1 file changed, 19 insertions(+), 7 deletions(-) diff --git a/interface/wx/textctrl.h b/interface/wx/textctrl.h index dd0cad1d1e..1130fc7913 100644 --- a/interface/wx/textctrl.h +++ b/interface/wx/textctrl.h @@ -1139,11 +1139,17 @@ public: virtual bool CanUndo(); /** - 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 @@ -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 -- 2.45.2