X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/29e1cfc224726d7a1a4411ae0570c1df14666955..2e25e7b7629b9c362d1fc689b536032a35441b8c:/docs/latex/wx/text.tex diff --git a/docs/latex/wx/text.tex b/docs/latex/wx/text.tex index d7bbb815c5..cc05b73006 100644 --- a/docs/latex/wx/text.tex +++ b/docs/latex/wx/text.tex @@ -105,6 +105,8 @@ you can still use Ctrl-Enter to pass to the next control from the keyboard.} \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\_RICH2}}{Use rich text control version 2.0 or 3.0 +under Win32, 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.} @@ -112,6 +114,9 @@ under Win32 only and requires wxTE\_RICH.} 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+.} +\twocolitem{\windowstyle{wxTE\_DONTWRAP}}{Same as {\tt wxHSCROLL} style.} +\twocolitem{\windowstyle{wxTE\_LINEWRAP}}{Wrap the lines too long to be shown entirely at any position (wxUniv only currently)} +\twocolitem{\windowstyle{wxTE\_WORDWRAP}}{Wrap the lines too long to be shown entirely at word boundaries only (wxUniv only currently)} \end{twocollist} See also \helpref{window styles overview}{windowstyles} and @@ -255,8 +260,8 @@ into the control than the limit set by Default constructor. \func{}{wxTextCtrl}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id},\rtfsp -\param{const wxString\& }{value = ``"}, \param{const wxPoint\& }{pos}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp -\param{long}{ style = 0}, \param{const wxValidator\& }{validator}, \param{const wxString\& }{name = ``text"}} +\param{const wxString\& }{value = ``"}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp +\param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = wxTextCtrlNameStr}} Constructor, creating and showing a text control. @@ -280,7 +285,8 @@ 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. +The horizontal scrollbar ({\bf wxHSCROLL} 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 @@ -370,8 +376,8 @@ Copies the selected text to the clipboard under Motif and MS Windows. \membersection{wxTextCtrl::Create}\label{wxtextctrlcreate} \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id},\rtfsp -\param{const wxString\& }{value = ``"}, \param{const wxPoint\& }{pos}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp -\param{long}{ style = 0}, \param{const wxValidator\& }{validator}, \param{const wxString\& }{name = ``text"}} +\param{const wxString\& }{value = ``"}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp +\param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = wxTextCtrlNameStr}} Creates the text control for two-step construction. Derived classes should call or replace this function. See \helpref{wxTextCtrl::wxTextCtrl}{wxtextctrlconstr}\rtfsp @@ -475,9 +481,24 @@ 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::GetRange}\label{wxtextctrlgetrange} + +\constfunc{virtual wxString}{GetRange}{\param{long}{ from}, \param{long}{ to}} + +Returns the string containing the text staring in the positions {\it from} and +up to {\it to} in the control. The positions must have been returned by another +wxTextCtrl method. + +Please note that the positions in a multiline wxTextCtrl do {\bf not} +correspond to the indices in the string returned by +\helpref{GetValue}{wxtextctrlgetvalue} because of the different new line +representations ({\tt CR} or {\tt CR LF}) and so this method should be used to +obtain the correct results instead of extracting parts of the entire value. It +may also be more efficient, especially if the control contains a lot of data. + \membersection{wxTextCtrl::GetSelection}\label{wxtextctrlgetselection} -\func{virtual void}{GetSelection}{\param{long*}{ from}, \param{long*}{ to}} +\constfunc{virtual void}{GetSelection}{\param{long*}{ from}, \param{long*}{ to}} Gets the current selection span. If the returned values are equal, there was no selection. @@ -516,6 +537,15 @@ 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::IsEditable}\label{wxtextctrliseditable} + +\constfunc{bool}{IsEditable}{\void} + +Returns {\tt TRUE} if the controls contents may be edited by user (note that it +always can be changed by the program), i.e. if the control hasn't been put in +read-only mode by a previous call to +\helpref{SetEditable}{wxtextctrlseteditable}. + \membersection{wxTextCtrl::IsModified}\label{wxtextctrlismodified} \constfunc{bool}{IsModified}{\void} @@ -709,6 +739,10 @@ Makes the text item editable or read-only, overriding the {\bf wxTE\_READONLY} f \docparam{editable}{If {\tt TRUE}, the control is editable. If {\tt FALSE}, the control is read-only.} +\wxheading{See also} + +\helpref{IsEditable}{wxtextctrliseditable} + \membersection{wxTextCtrl::SetInsertionPoint}\label{wxtextctrlsetinsertionpoint} \func{virtual void}{SetInsertionPoint}{\param{long}{ pos}}