X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9e3229b777e8c4b97daa4402f76591fe3dea0dc0..b13cd66e42c77e1c71585e67eeab6560b38178b3:/docs/latex/wx/text.tex diff --git a/docs/latex/wx/text.tex b/docs/latex/wx/text.tex index cc05b73006..1e7459ff47 100644 --- a/docs/latex/wx/text.tex +++ b/docs/latex/wx/text.tex @@ -95,7 +95,7 @@ streambuf\\ the message wxEVENT\_TYPE\_TEXT\_ENTER\_COMMAND (otherwise pressing is either processed internally by the control or used for navigation between dialog controls).} -\twocolitem{\windowstyle{wxTE\_PROCESS\_TAB}}{The control will receieve +\twocolitem{\windowstyle{wxTE\_PROCESS\_TAB}}{The control will receive 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.} @@ -395,6 +395,20 @@ Copies the selected text to the clipboard and removes the selection. Resets the internal `modified' flag as if the current edits had been saved. +\membersection{wxTextCtrl::EmulateKeyPress} + +\func{bool}{EmulateKeyPress}{\param{const wxKeyEvent\& }{event}} + +This functions inserts into the control the character which would have been +inserted if the given key event had occured in the text control. The +{\it event} object should be the same as the one passed to {\tt EVT\_KEY\_DOWN} +handler previously by wxWindows. + +\wxheading{Return value} + +{\tt TRUE} if the event resulted in a change to the control, {\tt FALSE} +otherwise. + \membersection{wxTextCtrl::GetDefaultStyle}\label{wxtextctrlgetdefaultstyle} \constfunc{const wxTextAttr\& }{GetDefaultStyle}{\void} @@ -553,6 +567,28 @@ read-only mode by a previous call to Returns {\tt TRUE} if the text has been modified by user. Note that calling \helpref{SetValue}{wxtextctrlsetvalue} doesn't make the control modified. +\membersection{wxTextCtrl::IsMultiLine}\label{wxtextctrlismultiline} + +\constfunc{bool}{IsMultiLine}{\void} + +Returns {\tt TRUE} if this is a multi line edit control and {\tt FALSE} +otherwise. + +\wxheading{See also} + +\helpref{IsSingleLine}{wxtextctrlissingleline} + +\membersection{wxTextCtrl::IsSingleLine}\label{wxtextctrlissingleline} + +\constfunc{bool}{IsSingleLine}{\void} + +Returns {\tt TRUE} if this is a single line edit control and {\tt FALSE} +otherwise. + +\wxheading{See also} + +\helpref{IsMultiLine}{wxtextctrlissingleline} + \membersection{wxTextCtrl::LoadFile}\label{wxtextctrlloadfile} \func{bool}{LoadFile}{\param{const wxString\& }{ filename}} @@ -567,33 +603,35 @@ Loads and displays the named file, if it exists. {\tt TRUE} if successful, {\tt FALSE} otherwise. -\membersection{wxTextCtrl::OnChar}\label{wxtextctrlonchar} - -\func{void}{OnChar}{\param{wxKeyEvent\& }{event}} - -Default handler for character input. - -\wxheading{Remarks} - -It is possible to intercept character -input by overriding this member. Call this function -to let the default behaviour take place; not calling -it results in the character being ignored. You can -replace the {\it keyCode} member of {\it event} to -translate keystrokes. - -Note that Windows and Motif have different ways -of implementing the default behaviour. In Windows, -calling wxTextCtrl::OnChar immediately -processes the character. In Motif, -calling this function simply sets a flag -to let default processing happen. This might affect -the way in which you write your OnChar function -on different platforms. - -\wxheading{See also} - -\helpref{wxKeyEvent}{wxkeyevent} +% VZ: commenting this out as: (a) the docs are wrong (you can't replace +% anything), (b) wxTextCtrl doesn't have any OnChar() anyhow +%% \membersection{wxTextCtrl::OnChar}\label{wxtextctrlonchar} +%% +%% \func{void}{OnChar}{\param{wxKeyEvent\& }{event}} +%% +%% Default handler for character input. +%% +%% \wxheading{Remarks} +%% +%% It is possible to intercept character +%% input by overriding this member. Call this function +%% to let the default behaviour take place; not calling +%% it results in the character being ignored. You can +%% replace the {\it keyCode} member of {\it event} to +%% translate keystrokes. +%% +%% Note that Windows and Motif have different ways +%% of implementing the default behaviour. In Windows, +%% calling wxTextCtrl::OnChar immediately +%% processes the character. In Motif, +%% calling this function simply sets a flag +%% to let default processing happen. This might affect +%% the way in which you write your OnChar function +%% on different platforms. +%% +%% \wxheading{See also} +%% +%% \helpref{wxKeyEvent}{wxkeyevent} \membersection{wxTextCtrl::OnDropFiles}\label{wxtextctrlondropfiles} @@ -768,7 +806,7 @@ 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 +If {\it len} is $0$, the previously set max length limit, if any, is discarded and the user may enter as much text as the underlying native text control widget supports (typically at least 32Kb).