X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ca8b28f2efff34b9939035a7aeb1de1e3ac98a0c..0e300ddd7d91d46e3d9fcbbefe916b0fda6fcbbc:/docs/latex/wx/text.tex

diff --git a/docs/latex/wx/text.tex b/docs/latex/wx/text.tex
index 54395fae08..724f33a98c 100644
--- a/docs/latex/wx/text.tex
+++ b/docs/latex/wx/text.tex
@@ -19,14 +19,24 @@ streambuf\\
 
 \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{wxHSCROLL}}{A horizontal scrollbar will be created.}
+\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{wxHSCROLL}}{A horizontal scrollbar will be created. No effect under GTK+.}
 \end{twocollist}
 
 See also \helpref{window styles overview}{windowstyles} and 
@@ -34,7 +44,8 @@ See also \helpref{window styles overview}{windowstyles} and
 
 \wxheading{Remarks}
 
-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}
@@ -47,20 +58,36 @@ This class multiply-inherits from {\bf streambuf} where compilers allow, allowin
 \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
-wxTextCtrl header file.
+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.
+
+% VZ: it is wrong to say that C++ iostreams are deprecated, we need a better
+%     wording here - disabling this for now
+%Note that any use of C++ iostreams (including this one) is deprecated and might
+%get completely removed in the future.
 
 \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,
-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\_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}%
 
 %\wxheading{See also}
@@ -101,16 +128,17 @@ Constructor, creating and showing a text control.
 
 \wxheading{Remarks}
 
-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 
+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 
+so that the \helpref{insertion point}{wxtextctrlgetinsertionpoint} is always
 visible.
 
-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.
+% 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}
 
@@ -216,8 +244,8 @@ Resets the internal `modified' flag as if the current edits had been saved.
 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}. 
+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.
@@ -228,7 +256,7 @@ point or the zero character if the point is at the end of the control.
     if (tc->GetInsertionPoint() == tc->GetLastPosition())
       return '\0';
     return tc->GetValue[tc->GetInsertionPoint()];
-  }	
+  }
 \end{verbatim}
 }%
 
@@ -236,14 +264,14 @@ point or the zero character if the point is at the end of the control.
 
 \constfunc{virtual long}{GetLastPosition}{\void}
 
-Returns the zero based index of 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}}
 
-Gets the length of the specified line, not including any trailing newline 
+Gets the length of the specified line, not including any trailing newline
 character(s).
 
 \wxheading{Parameters}
@@ -298,11 +326,19 @@ no selection.
 
 \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::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}
 
@@ -365,7 +401,7 @@ is to load the first dropped file into the control.
 
 \wxheading{Remarks}
 
-This is not yet implemented for the GTK.
+This is not implemented on non-Windows platforms.
 
 \wxheading{See also}
 
@@ -379,7 +415,7 @@ Pastes text from the clipboard to the text item.
 
 \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 position to a zero-based column, line number pair.
 
@@ -393,7 +429,7 @@ Converts given position to a zero-based column, line number pair.
 
 \wxheading{Return value}
 
-Non-zero on success, zero on failure (most likely due to a too large position
+TRUE on success, FALSE on failure (most likely due to a too large position
 parameter).
 
 \wxheading{See also}
@@ -404,6 +440,9 @@ parameter).
 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}
@@ -428,7 +467,7 @@ the character at the last position.
 
 \func{virtual void}{Replace}{\param{long}{ from}, \param{long}{ to}, \param{const wxString\& }{value}}
 
-Replaces the text starting at the first position up to (but not including) 
+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}
@@ -457,8 +496,7 @@ TRUE if the operation was successful, FALSE otherwise.
 
 \func{virtual void}{SetEditable}{\param{const bool}{ editable}}
 
-Makes the text item editable or read-only, overriding the {\bf wxTE\_READONLY}
-flag.
+Makes the text item editable or read-only, overriding the {\bf wxTE\_READONLY} flag.
 
 \wxheading{Parameters}
 
@@ -481,6 +519,30 @@ Sets the insertion point at the given position.
 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}}
@@ -497,7 +559,7 @@ Selects the text starting at the first position up to (but not including) the ch
 
 \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}
 
@@ -524,7 +586,7 @@ if there is no undo facility.
 
 \func{void}{WriteText}{\param{const wxString\& }{ text}}
 
-Writes the text into the text control at the current insertion position. 
+Writes the text into the text control at the current insertion position.
 
 \wxheading{Parameters}