X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/c50f1fb9226d9260454ccb9c8a67d0be23c2827f..80d2803f703d1b238f42725504f08266ef02defe:/docs/latex/wx/text.tex diff --git a/docs/latex/wx/text.tex b/docs/latex/wx/text.tex index d0324945c5..657aa9ec13 100644 --- a/docs/latex/wx/text.tex +++ b/docs/latex/wx/text.tex @@ -30,15 +30,16 @@ 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{wxHSCROLL}}{A horizontal scrollbar will be created. No effect under GTK+.} \end{twocollist} -See also \helpref{window styles overview}{windowstyles} and +See also \helpref{window styles overview}{windowstyles} and \helpref{wxTextCtrl::wxTextCtrl}{wxtextctrlconstr}. \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} @@ -51,8 +52,11 @@ 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. + +Note that any use of C++ iostreams (including this one) deprecated and might get completely removed +in the future. \wxheading{Event handling} @@ -66,7 +70,9 @@ 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.} \end{twocollist}% @@ -313,7 +319,9 @@ consisting of the from and to values.} \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} @@ -376,7 +384,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} @@ -390,7 +398,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. @@ -404,7 +412,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} @@ -468,8 +476,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} @@ -508,7 +515,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}