X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a1665b22b07c572a240f9d83783044e3e4f9cb0e..34bbbc276dc470014c8d200cfbbf7f588076aeaf:/docs/latex/wx/text.tex diff --git a/docs/latex/wx/text.tex b/docs/latex/wx/text.tex index d2e831e459..fff6a22f19 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} @@ -311,11 +315,16 @@ no selection. \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} @@ -378,7 +387,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} @@ -417,6 +426,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} @@ -470,8 +482,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} @@ -510,7 +521,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}