updated and expanded wxLog docs

[wxWidgets.git] / docs / latex / wx / text.tex

diff --git a/docs/latex/wx/text.tex b/docs/latex/wx/text.tex
index 673c697d595e21fb944e519514a038f3cd906317..09e9b045fae30caf85394da744b366e03ca4cd7d 100644 (file)
--- a/docs/latex/wx/text.tex
+++ b/docs/latex/wx/text.tex
@@ -1,7 +1,7 @@
 \section{\class{wxTextCtrl}}\label{wxtextctrl}
 
 A text control allows text to be displayed and edited. It may be
 \section{\class{wxTextCtrl}}\label{wxtextctrl}
 
 A text control allows text to be displayed and edited. It may be

-single line or multiline.
+single line or multi-line.

 
 \wxheading{Derived from}
 
 
 \wxheading{Derived from}
 


@@ -11,26 +11,44 @@ streambuf\\
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 

+\wxheading{Include files}
+
+<wx/textctrl.h>
+

 \wxheading{Window styles}
 
 \twocolwidtha{5cm}
 \begin{twocollist}\itemsep=0pt
 \wxheading{Window styles}
 
 \twocolwidtha{5cm}
 \begin{twocollist}\itemsep=0pt

-\twocolitem{\windowstyle{wxTE\_PROCESS\_ENTER}}{The callback function will
-receive the message wxEVENT\_TYPE\_TEXT\_ENTER\_COMMAND. Note
-that this will break tab traversal for this panel item under
-Windows.}
+\twocolitem{\windowstyle{wxTE\_PROCESS\_ENTER}}{The control will generate
+the message wxEVENT\_TYPE\_TEXT\_ENTER\_COMMAND (otherwise pressing <Enter> is
+either processed internally by the control or used for navigation between
+dialog controls).}
+\twocolitem{\windowstyle{wxTE\_PROCESS\_TAB}}{The control will receieve
+EVT\_CHAR messages for TAB pressed - normally, TAB is used for passing to the
+next control in a dialog instead. For the control created with this style,
+you can still use Ctrl-Enter to pass to the next control from the keyboard.}

 \twocolitem{\windowstyle{wxTE\_MULTILINE}}{The text control allows multiple lines.}
 \twocolitem{\windowstyle{wxTE\_PASSWORD}}{The text will be echoed as asterisks.}
 \twocolitem{\windowstyle{wxTE\_READONLY}}{The text will not be user-editable.}
 \twocolitem{\windowstyle{wxTE\_MULTILINE}}{The text control allows multiple lines.}
 \twocolitem{\windowstyle{wxTE\_PASSWORD}}{The text will be echoed as asterisks.}
 \twocolitem{\windowstyle{wxTE\_READONLY}}{The text will not be user-editable.}

-\twocolitem{\windowstyle{wxHSCROLL}}{A vertical scrollbar will be present.}
+\twocolitem{\windowstyle{wxTE\_RICH}}{Use rich text control under Win32, this
+allows to have more than 64Kb of text in the control even under Win9x. This
+style is ignored under other platforms.}
+\twocolitem{\windowstyle{wxTE\_AUTO\_URL}}{Highlight the URLs and generate the
+wxTextUrlEvents when mouse events occur over them. This style is supported
+under Win32 only and requires wxTE\_RICH.}
+\twocolitem{\windowstyle{wxTE\_NOHIDESEL}}{By default, the Windows text control
+doesn't show the selection when it doesn't have focus - use this style to force
+it to always show it. It doesn't do anything under other platforms.}
+\twocolitem{\windowstyle{wxHSCROLL}}{A horizontal scrollbar will be created. No effect under GTK+.}

 \end{twocollist}
 
 \end{twocollist}
 

-See also \helpref{window styles overview}{windowstyles}.
+See also \helpref{window styles overview}{windowstyles} and
+\helpref{wxTextCtrl::wxTextCtrl}{wxtextctrlconstr}.

 
 

-\wxheading{Remarks}
+\wxheading{wxTextCtrl and C++ streams}

 
 

-This class multiply-inherits from {\bf streambuf} where compilers allow, allowing code such
-as the following:
+This class multiply-inherits from {\bf streambuf} where compilers allow,
+allowing code such as the following:

 
 {\small%
 \begin{verbatim}
 
 {\small%
 \begin{verbatim}


@@ -43,26 +61,87 @@ as the following:
 \end{verbatim}
 }%
 
 \end{verbatim}
 }%
 

-If your compiler does not support derivation from {\bf streambuf} and gives a compile error, define the symbol {\bf NO\_TEXT\_WINDOW\_STREAM} in the
+If your compiler does not support derivation from {\bf streambuf} and gives a
+compile error, define the symbol {\bf NO\_TEXT\_WINDOW\_STREAM} in the

 wxTextCtrl header file.
 
 wxTextCtrl header file.
 

+Note that independently of this setting you can always use wxTextCtrl itself
+in a stream-like manner:
+
+{\small%
+\begin{verbatim}
+  wxTextCtrl *control = new wxTextCtrl(...);
+
+  *control << 123.456 << " some text\n";
+\end{verbatim}
+}%
+
+always works. However the possibility to create an ostream associated with
+wxTextCtrl may be useful if you need to redirect the output of a function
+taking an ostream as parameter to a text control.
+
+Another commonly requested need is to redirect {\bf std::cout} to the text
+control. This could be done in the following way:
+
+{\small%
+\begin{verbatim}
+  #include <iostream>
+
+  wxTextCtrl *control = new wxTextCtrl(...);
+
+  std::streambuf *sbOld = std::cout.rdbuf();
+  std::cout.rdbuf(*control);
+
+  // use cout as usual, the output appears in the text control
+  ...
+
+  std::cout.rdbuf(sbOld);
+\end{verbatim}
+}%
+
+But wxWindows provides a convenient class to make it even simpler so instead
+you may just do
+
+{\small%
+\begin{verbatim}
+  #include <iostream>
+
+  wxTextCtrl *control = new wxTextCtrl(...);
+
+  wxStreamToTextRedirector redirect(control);
+
+  // all output to cout goes into the text control until the exit from current
+  // scope
+\end{verbatim}
+}%
+
+See \helpref{wxStreamToTextRedirector}{wxstreamtotextredirector} for more
+details.
+

 \wxheading{Event handling}
 
 \wxheading{Event handling}
 

+The following commands are processed by default event handlers in wxTextCtrl: wxID\_CUT, wxID\_COPY,
+wxID\_PASTE, wxID\_UNDO, wxID\_REDO. The associated UI update events are also processed
+automatically, when the control has the focus.
+

 To process input from a text control, use these event handler macros to direct input to member
 functions that take a \helpref{wxCommandEvent}{wxcommandevent} argument.
 
 \twocolwidtha{7cm}%
 \begin{twocollist}\itemsep=0pt
 \twocolitem{{\bf EVT\_TEXT(id, func)}}{Respond to a wxEVT\_COMMAND\_TEXT\_UPDATED event,
 To process input from a text control, use these event handler macros to direct input to member
 functions that take a \helpref{wxCommandEvent}{wxcommandevent} argument.
 
 \twocolwidtha{7cm}%
 \begin{twocollist}\itemsep=0pt
 \twocolitem{{\bf EVT\_TEXT(id, func)}}{Respond to a wxEVT\_COMMAND\_TEXT\_UPDATED event,

-generated when the text changes.}
+generated when the text changes. Notice that this event will always be sent
+when the text controls contents changes - whether this is due to user input or
+comes from the program itself (for example, if SetValue() is called)}

 \twocolitem{{\bf EVT\_TEXT\_ENTER(id, func)}}{Respond to a wxEVT\_COMMAND\_TEXT\_ENTER event,
 generated when enter is pressed in a single-line text control.}
 \twocolitem{{\bf EVT\_TEXT\_ENTER(id, func)}}{Respond to a wxEVT\_COMMAND\_TEXT\_ENTER event,
 generated when enter is pressed in a single-line text control.}

+\twocolitem{{\bf EVT\_TEXT\_URL(id, func)}}{A mouse event occured over an URL
+in the text control (Win32 only)}
+\twocolitem{{\bf EVT\_TEXT\_MAXLEN(id, func)}}{User tried to enter more text
+into the control than the limit set by
+\helpref{SetMaxLength}{wxtextctrlsetmaxlength}.}

 \end{twocollist}%
 
 \end{twocollist}%
 

-%\wxheading{See also}
-%
-%\helpref{wxRichTextCtrl}{wxrichtextctrl}
-%

 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxTextCtrl::wxTextCtrl}\label{wxtextctrlconstr}
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxTextCtrl::wxTextCtrl}\label{wxtextctrlconstr}


@@ -97,9 +176,17 @@ Constructor, creating and showing a text control.
 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 

-Under Windows, if the {\bf wxTE\_MULTILINE} style is used, the window is implemented
-as a Windows rich text control with unlimited capacity. Otherwise, normal edit control limits
-apply.
+The horizontal scrollbar ({\bf wxTE\_HSCROLL} style flag) will only be created for multi-line text controls.
+Without a horizontal scrollbar, text lines that don't fit in the control's
+size will be wrapped (but no newline character is inserted). Single line
+controls don't have a horizontal scrollbar, the text is automatically scrolled
+so that the \helpref{insertion point}{wxtextctrlgetinsertionpoint} is always
+visible.
+
+% VZ: this is no longer true
+%Under Windows, if the {\bf wxTE\_MULTILINE} style is used, the window is implemented
+%as a Windows rich text control with unlimited capacity. Otherwise, normal edit control limits
+%apply.

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -111,6 +198,59 @@ apply.
 
 Destructor, destroying the text control.
 
 
 Destructor, destroying the text control.
 

+\membersection{wxTextCtrl::AppendText}\label{wxtextctrlappendtext}
+
+\func{void}{AppendText}{\param{const wxString\& }{ text}}
+
+Appends the text to the end of the text control.
+
+\wxheading{Parameters}
+
+\docparam{text}{Text to write to the text control.}
+
+\wxheading{Remarks}
+
+After the text is appended, the insertion point will be at the end of the text control. If this behaviour is not desired,
+the programmer should use \helpref{GetInsertionPoint}{wxtextctrlgetinsertionpoint} and \helpref{SetInsertionPoint}{wxtextctrlsetinsertionpoint}.
+
+\wxheading{See also}
+
+\helpref{wxTextCtrl::WriteText}{wxtextctrlwritetext}
+
+\membersection{wxTextCtrl::CanCopy}\label{wxtextctrlcancopy}
+
+\func{virtual bool}{CanCopy}{\void}
+
+Returns TRUE if the selection can be copied to the clipboard.
+
+\membersection{wxTextCtrl::CanCut}\label{wxtextctrlcancut}
+
+\func{virtual bool}{CanCut}{\void}
+
+Returns TRUE if the selection can be cut to the clipboard.
+
+\membersection{wxTextCtrl::CanPaste}\label{wxtextctrlcanpaste}
+
+\func{virtual bool}{CanPaste}{\void}
+
+Returns TRUE if the contents of the clipboard can be pasted into the
+text control. On some platforms (Motif, GTK) this is an approximation
+and returns TRUE if the control is editable, FALSE otherwise.
+
+\membersection{wxTextCtrl::CanRedo}\label{wxtextctrlcanredo}
+
+\func{virtual bool}{CanRedo}{\void}
+
+Returns TRUE if there is a redo facility available and the last operation
+can be redone.
+
+\membersection{wxTextCtrl::CanUndo}\label{wxtextctrlcanundo}
+
+\func{virtual bool}{CanUndo}{\void}
+
+Returns TRUE if there is an undo facility available and the last operation
+can be undone.
+

 \membersection{wxTextCtrl::Clear}\label{wxtextctrlclear}
 
 \func{virtual void}{Clear}{\void}
 \membersection{wxTextCtrl::Clear}\label{wxtextctrlclear}
 
 \func{virtual void}{Clear}{\void}


@@ -149,19 +289,38 @@ Resets the internal `modified' flag as if the current edits had been saved.
 
 \constfunc{virtual long}{GetInsertionPoint}{\void}
 
 
 \constfunc{virtual long}{GetInsertionPoint}{\void}
 

-Returns the insertion point.
+Returns the insertion point. This is defined as the zero based index of the
+character position to the right of the insertion point. For example, if
+the insertion point is at the end of the text control, it is equal to
+both \helpref{GetValue()}{wxtextctrlgetvalue}.Length() and
+\helpref{GetLastPosition()}{wxtextctrlgetlastposition}.
+
+The following code snippet safely returns the character at the insertion
+point or the zero character if the point is at the end of the control.
+
+{\small%
+\begin{verbatim}
+  char GetCurrentChar(wxTextCtrl *tc) {
+    if (tc->GetInsertionPoint() == tc->GetLastPosition())
+      return '\0';
+    return tc->GetValue[tc->GetInsertionPoint()];
+  }
+\end{verbatim}
+}%

 
 \membersection{wxTextCtrl::GetLastPosition}\label{wxtextctrlgetlastposition}
 
 \constfunc{virtual long}{GetLastPosition}{\void}
 
 
 \membersection{wxTextCtrl::GetLastPosition}\label{wxtextctrlgetlastposition}
 
 \constfunc{virtual long}{GetLastPosition}{\void}
 

-Returns the last position in the text control.
+Returns the zero based index of the last position in the text control,
+which is equal to the number of characters in the control.

 
 \membersection{wxTextCtrl::GetLineLength}\label{wxtextctrlgetlinelength}
 
 \constfunc{int}{GetLineLength}{\param{long}{ lineNo}}
 
 
 \membersection{wxTextCtrl::GetLineLength}\label{wxtextctrlgetlinelength}
 
 \constfunc{int}{GetLineLength}{\param{long}{ lineNo}}
 

-Gets the length of the specified line.
+Gets the length of the specified line, not including any trailing newline
+character(s).

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 


@@ -175,7 +334,8 @@ The length of the line, or -1 if {\it lineNo} was invalid.
 
 \constfunc{wxString}{GetLineText}{\param{long}{ lineNo}}
 
 
 \constfunc{wxString}{GetLineText}{\param{long}{ lineNo}}
 

-Returns the contents of a given line in the text control.
+Returns the contents of a given line in the text control, not including
+any trailing newline character(s).

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 


@@ -191,11 +351,56 @@ The contents of the line.
 
 Returns the number of lines in the text control buffer.
 
 
 Returns the number of lines in the text control buffer.
 

+\wxheading{Remarks}
+
+Note that even empty text controls have one line (where the insertion point
+is), so GetNumberOfLines() never returns 0.
+
+For gtk\_text (multi-line) controls, the number of lines is
+calculated by actually counting newline characters in the buffer. You
+may wish to avoid using functions that work with line numbers if you are
+working with controls that contain large amounts of text.
+
+\membersection{wxTextCtrl::GetSelection}\label{wxtextctrlgetselection}
+
+\func{virtual void}{GetSelection}{\param{long*}{ from}, \param{long*}{ to}}
+
+Gets the current selection span. If the returned values are equal, there was
+no selection.
+
+Please note that the indices returned may be used with the other wxTextctrl
+methods but don't necessarily represent the correct indices into the string
+returned by \helpref{GetValue()}{wxtextctrlgetvalue} for multiline controls
+under Windows (at least,) you should use
+\helpref{GetStringSelection()}{wxtextctrlgetstringselection} to get the selected
+text.
+
+\wxheading{Parameters}
+
+\docparam{from}{The returned first position.}
+
+\docparam{to}{The returned last position.}
+
+\pythonnote{The wxPython version of this method returns a tuple
+consisting of the from and to values.}
+
+\perlnote{In wxPerl this method takes no parameter and returns a
+2-element list {\tt ( from, to )}.}
+
+\membersection{wxTextCtrl::GetStringSelection}\label{wxtextctrlgetstringselection}
+
+\func{virtual wxString}{GetStringSelection}{\void}
+
+Gets the text currently selected in the control. If there is no selection, the
+returned string is empty.
+

 \membersection{wxTextCtrl::GetValue}\label{wxtextctrlgetvalue}
 
 \constfunc{wxString}{GetValue}{\void}
 
 \membersection{wxTextCtrl::GetValue}\label{wxtextctrlgetvalue}
 
 \constfunc{wxString}{GetValue}{\void}
 

-Gets the contents of the control.
+Gets the contents of the control. Notice that for a multiline text control,
+the lines will be separated by (Unix-style) $\backslash$n characters, even under
+Windows where they are separated by a $\backslash$r$\backslash$n sequence in the native control.

 
 \membersection{wxTextCtrl::IsModified}\label{wxtextctrlismodified}
 
 
 \membersection{wxTextCtrl::IsModified}\label{wxtextctrlismodified}
 


@@ -256,6 +461,10 @@ is to load the first dropped file into the control.
 
 \docparam{event}{The drop files event.}
 
 
 \docparam{event}{The drop files event.}
 

+\wxheading{Remarks}
+
+This is not implemented on non-Windows platforms.
+

 \wxheading{See also}
 
 \helpref{wxDropFilesEvent}{wxdropfilesevent}
 \wxheading{See also}
 
 \helpref{wxDropFilesEvent}{wxdropfilesevent}


@@ -268,27 +477,47 @@ Pastes text from the clipboard to the text item.
 
 \membersection{wxTextCtrl::PositionToXY}\label{wxtextctrlpositiontoxy}
 
 
 \membersection{wxTextCtrl::PositionToXY}\label{wxtextctrlpositiontoxy}
 

-\constfunc{long}{PositionToXY}{\param{long }{pos}, \param{long *}{x}, \param{long *}{y}}
+\constfunc{bool}{PositionToXY}{\param{long }{pos}, \param{long *}{x}, \param{long *}{y}}

 
 

-Converts given character and line position to a position.
+Converts given position to a zero-based column, line number pair.

 
 \wxheading{Parameters}
 
 \docparam{pos}{Position.}
 
 
 \wxheading{Parameters}
 
 \docparam{pos}{Position.}
 

-\docparam{x}{Receives character position.}
+\docparam{x}{Receives zero based column number.}
+
+\docparam{y}{Receives zero based line number.}

 
 

-\docparam{y}{Receives line position.}
+\wxheading{Return value}
+
+TRUE on success, FALSE on failure (most likely due to a too large position
+parameter).

 
 \wxheading{See also}
 
 \helpref{wxTextCtrl::XYToPosition}{wxtextctrlxytoposition}
 
 
 \wxheading{See also}
 
 \helpref{wxTextCtrl::XYToPosition}{wxtextctrlxytoposition}
 

+\pythonnote{In Python, PositionToXY() returns a tuple containing the x and
+y values, so (x,y) = PositionToXY() is equivalent to the call described
+above.}
+
+\perlnote{In wxPerl this method only takes the {\tt pos} parameter, and
+returns a 2-element list {\tt ( x, y )}.}
+
+\membersection{wxTextCtrl::Redo}\label{wxtextctrlredo}
+
+\func{virtual void}{Redo}{\void}
+
+If there is a redo facility and the last operation can be redone, redoes the last operation. Does nothing
+if there is no redo facility.
+

 \membersection{wxTextCtrl::Remove}\label{wxtextctrlremove}
 
 \func{virtual void}{Remove}{\param{long}{ from}, \param{long}{ to}}
 
 \membersection{wxTextCtrl::Remove}\label{wxtextctrlremove}
 
 \func{virtual void}{Remove}{\param{long}{ from}, \param{long}{ to}}
 

-Removes the text between the two positions.
+Removes the text starting at the first given position up to (but not including)
+the character at the last position.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 


@@ -300,7 +529,8 @@ Removes the text between the two positions.
 
 \func{virtual void}{Replace}{\param{long}{ from}, \param{long}{ to}, \param{const wxString\& }{value}}
 
 
 \func{virtual void}{Replace}{\param{long}{ from}, \param{long}{ to}, \param{const wxString\& }{value}}
 

-Replaces the text between two positions with the given text.
+Replaces the text starting at the first position up to (but not including)
+the character at the last position with the given text.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 


@@ -318,7 +548,7 @@ Saves the contents of the control in a text file.
 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\docparam{filename}{The name of file in which to save the text.}
+\docparam{filename}{The name of the file in which to save the text.}

 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 


@@ -328,7 +558,7 @@ TRUE if the operation was successful, FALSE otherwise.
 
 \func{virtual void}{SetEditable}{\param{const bool}{ editable}}
 
 
 \func{virtual void}{SetEditable}{\param{const bool}{ editable}}
 

-Makes the text item editable or read-only.
+Makes the text item editable or read-only, overriding the {\bf wxTE\_READONLY} flag.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 


@@ -338,7 +568,7 @@ Makes the text item editable or read-only.
 
 \func{virtual void}{SetInsertionPoint}{\param{long}{ pos}}
 
 
 \func{virtual void}{SetInsertionPoint}{\param{long}{ pos}}
 

-Sets the insertion point. Windows only. ??
+Sets the insertion point at the given position.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 


@@ -348,13 +578,38 @@ Sets the insertion point. Windows only. ??
 
 \func{virtual void}{SetInsertionPointEnd}{\void}
 
 
 \func{virtual void}{SetInsertionPointEnd}{\void}
 

-Sets the insertion point at the end of the text control.
+Sets the insertion point at the end of the text control. This is equivalent
+to \helpref{SetInsertionPoint}{wxtextctrlsetinsertionpoint}(\helpref{GetLastPosition}{wxtextctrlgetlastposition}()).
+
+\membersection{wxTextCtrl::SetMaxLength}\label{wxtextctrlsetmaxlength}
+
+\func{virtual void}{SetMaxLength}{\param{unsigned long }{len}}
+
+This function sets the maximum number of characters the user can enter into the
+control. In other words, it allows to limit the text value length to {\it len}
+not counting the terminating {\tt NUL} character.
+
+If {\it len} is $0$, the previously set max length limi, if any, is discarded
+and the user may enter as much text as the underlying native text control
+widget supports (typically at least 32Kb).
+
+If the user tries to enter more characters into the text control when it
+already is filled up to the maximal length, a
+{\tt wxEVT\_COMMAND\_TEXT\_MAXLEN} event is sent to notify the program about it
+(giving it the possibility to show an explanatory message, for example) and the
+extra input is discarded.
+
+Note that this function may only be used with single line text controls.
+
+\wxheading{Compatibility}
+
+Only implemented in wxMSW/wxGTK starting with wxWindows 2.3.2.

 
 \membersection{wxTextCtrl::SetSelection}\label{wxtextctrlsetselection}
 
 \func{virtual void}{SetSelection}{\param{long}{ from}, \param{long}{ to}}
 
 
 \membersection{wxTextCtrl::SetSelection}\label{wxtextctrlsetselection}
 
 \func{virtual void}{SetSelection}{\param{long}{ from}, \param{long}{ to}}
 

-Selects the text between the two positions.
+Selects the text starting at the first position up to (but not including) the character at the last position.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 


@@ -366,7 +621,7 @@ Selects the text between the two positions.
 
 \func{virtual void}{SetValue}{\param{const wxString\& }{ value}}
 
 
 \func{virtual void}{SetValue}{\param{const wxString\& }{ value}}
 

-Sets the text value.
+Sets the text value and marks the control as not-modified.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 


@@ -382,11 +637,18 @@ Makes the line containing the given position visible.
 
 \docparam{pos}{The position that should be visible.}
 
 
 \docparam{pos}{The position that should be visible.}
 

+\membersection{wxTextCtrl::Undo}\label{wxtextctrlundo}
+
+\func{virtual void}{Undo}{\void}
+
+If there is an undo facility and the last operation can be undone, undoes the last operation. Does nothing
+if there is no undo facility.
+

 \membersection{wxTextCtrl::WriteText}\label{wxtextctrlwritetext}
 
 \func{void}{WriteText}{\param{const wxString\& }{ text}}
 
 \membersection{wxTextCtrl::WriteText}\label{wxtextctrlwritetext}
 
 \func{void}{WriteText}{\param{const wxString\& }{ text}}
 

-Writes the text into the text control at the current position.
+Writes the text into the text control at the current insertion position.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 


@@ -396,20 +658,21 @@ Writes the text into the text control at the current position.
 
 Newlines in the text string
 are the only control characters allowed, and they will cause appropriate
 
 Newlines in the text string
 are the only control characters allowed, and they will cause appropriate

-line breaks.  See \helpref{wxTextCtrl::\cinsert}{wxtextctrlinsert} for more convenient ways of writing to the
-window.
+line breaks.  See \helpref{wxTextCtrl::\cinsert}{wxtextctrlinsert} and \helpref{wxTextCtrl::AppendText}{wxtextctrlappendtext} for more convenient ways of writing to the window.
+
+After the write operation, the insertion point will be at the end of the inserted text, so subsequent write operations will be appended. To append text after the user may have interacted with the control, call \helpref{wxTextCtrl::SetInsertionPointEnd}{wxtextctrlsetinsertionpointend} before writing.

 
 \membersection{wxTextCtrl::XYToPosition}\label{wxtextctrlxytoposition}
 
 \func{long}{XYToPosition}{\param{long}{ x}, \param{long}{ y}}
 
 
 \membersection{wxTextCtrl::XYToPosition}\label{wxtextctrlxytoposition}
 
 \func{long}{XYToPosition}{\param{long}{ x}, \param{long}{ y}}
 

-Converts the given character and line position to a position.
+Converts the given zero based column and line number to a position.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\docparam{x}{The character position.}
+\docparam{x}{The column number.}

 
 

-\docparam{y}{The line position.}
+\docparam{y}{The line number.}

 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 


@@ -429,7 +692,7 @@ The position value.
 
 \func{wxTextCtrl\&}{operator \cinsert}{\param{char}{ c}}
 
 
 \func{wxTextCtrl\&}{operator \cinsert}{\param{char}{ c}}
 

-Operator definitions for writing to a text control, for example:
+Operator definitions for appending to a text control, for example:

 
 \begin{verbatim}
   wxTextCtrl *wnd = new wxTextCtrl(my_frame);
 
 \begin{verbatim}
   wxTextCtrl *wnd = new wxTextCtrl(my_frame);


@@ -437,4 +700,3 @@ Operator definitions for writing to a text control, for example:
   (*wnd) << "Welcome to text control number " << 1 << ".\n";
 \end{verbatim}
 
   (*wnd) << "Welcome to text control number " << 1 << ".\n";
 \end{verbatim}
 

-