X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/461fb267e6401cb9fae35bc8bb1ae359b9631817..4116fac052b9b6f7963b4acf2721a24075692454:/docs/latex/wx/text.tex diff --git a/docs/latex/wx/text.tex b/docs/latex/wx/text.tex index 8aa7927cfb..27d4a062ae 100644 --- a/docs/latex/wx/text.tex +++ b/docs/latex/wx/text.tex @@ -23,7 +23,7 @@ No base class control. \texttt{wxTextCoord} contains the index of a column or a row in the control. -Note that alghough both of these types should probably have been unsigned, due +Note that although both of these types should probably have been unsigned, due to backwards compatibility reasons, are defined as \texttt{long} currently. Their use (instead of plain \texttt{long}) is still encouraged as it makes the code more readable. @@ -132,6 +132,14 @@ Return the text font specified by this attribute. Returns the left indent in tenths of a millimetre. +\membersection{wxTextAttr::GetLeftSubIndent}\label{wxtextattrgetleftsubindent} + +\constfunc{int}{GetLeftSubIndent}{\void} + +Returns the left sub indent for all lines but the first line in a paragraph in +tenths of a millimetre. + + \membersection{wxTextAttr::GetRightIndent}\label{wxtextattrgetrightindent} \constfunc{int}{GetRightIndent}{\void} @@ -219,9 +227,11 @@ Sets the text font. \membersection{wxTextAttr::SetLeftIndent}\label{wxtextattrsetleftindent} -\func{void}{SetLeftIndent}{\param{int }{indent}} +\func{void}{SetLeftIndent}{\param{int }{indent}, \param{int }{subIndent = 0}} Sets the left indent in tenths of a millimetre. +subIndent sets the indent for all lines but the first line in a paragraph +relative to the first line. \membersection{wxTextAttr::SetRightIndent}\label{wxtextattrsetrightindent} @@ -270,18 +280,18 @@ streambuf\\ \twocolwidtha{5cm} \begin{twocollist}\itemsep=0pt \twocolitem{\windowstyle{wxTE\_PROCESS\_ENTER}}{The control will generate -the message wxEVENT\_TYPE\_TEXT\_ENTER\_COMMAND (otherwise pressing Enter key +the event wxEVT\_COMMAND\_TEXT\_ENTER (otherwise pressing Enter key is either processed internally by the control or used for navigation between dialog controls).} \twocolitem{\windowstyle{wxTE\_PROCESS\_TAB}}{The control will receive -EVT\_CHAR messages for TAB pressed - normally, TAB is used for passing to the +wxEVT\_CHAR events 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{wxTE\_RICH}}{Use rich text control under Win32, this -allows to have more than 64Kb of text in the control even under Win9x. 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} @@ -292,17 +302,17 @@ 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 and -used, so that text won't be wrapped. No effect under GTK+.} +used, so that text won't be wrapped. No effect under wxGTK1.} \twocolitem{\windowstyle{wxTE\_LEFT}}{The text in the control will be left-justified (default).} -\twocolitem{\windowstyle{wxTE\_CENTRE}}{The text in the control will be centered.} -\twocolitem{\windowstyle{wxTE\_RIGHT}}{The text in the control will be right-justified.} +\twocolitem{\windowstyle{wxTE\_CENTRE}}{The text in the control will be centered (currently wxMSW and wxGTK2 only).} +\twocolitem{\windowstyle{wxTE\_RIGHT}}{The text in the control will be right-justified (currently wxMSW and wxGTK2 only).} \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 -\helpref{wxTextCtrl::wxTextCtrl}{wxtextctrlconstr}. +\helpref{wxTextCtrl::wxTextCtrl}{wxtextctrlctor}. \wxheading{wxTextCtrl text format} @@ -413,7 +423,7 @@ control. This could be done in the following way: \end{verbatim} }% -But wxWindows provides a convenient class to make it even simpler so instead +But wxWidgets provides a convenient class to make it even simpler so instead you may just do {\small% @@ -460,7 +470,7 @@ into the control than the limit set by \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxTextCtrl::wxTextCtrl}\label{wxtextctrlconstr} +\membersection{wxTextCtrl::wxTextCtrl}\label{wxtextctrlctor} \func{}{wxTextCtrl}{\void} @@ -510,7 +520,7 @@ visible. \helpref{wxTextCtrl::Create}{wxtextctrlcreate}, \helpref{wxValidator}{wxvalidator} -\membersection{wxTextCtrl::\destruct{wxTextCtrl}} +\membersection{wxTextCtrl::\destruct{wxTextCtrl}}\label{wxtextctrldtor} \func{}{\destruct{wxTextCtrl}}{\void} @@ -600,7 +610,7 @@ Copies the selected text to the clipboard under Motif and MS Windows. \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 +should call or replace this function. See \helpref{wxTextCtrl::wxTextCtrl}{wxtextctrlctor}\rtfsp for further details. @@ -611,21 +621,21 @@ for further details. Copies the selected text to the clipboard and removes the selection. -\membersection{wxTextCtrl::DiscardEdits} +\membersection{wxTextCtrl::DiscardEdits}\label{wxtextctrldiscardedits} \func{void}{DiscardEdits}{\void} Resets the internal `modified' flag as if the current edits had been saved. -\membersection{wxTextCtrl::EmulateKeyPress} +\membersection{wxTextCtrl::EmulateKeyPress}\label{wxtextctrlemulatekeypress} \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. +handler previously by wxWidgets. Please note that this function doesn't currently work correctly for all keys under any platform but MSW. @@ -813,15 +823,17 @@ sequence in the native control. This function finds the character at the specified position expressed in pixels. If the return code is not \texttt{wxTE\_HT\_UNKNOWN} the row and column of the character closest to this position are returned in the \arg{col} and -\arg{row} parameters (unless the pointers are \tt{NULL} which is allowed). +\arg{row} parameters (unless the pointers are {\tt NULL} which is allowed). -Please note that this function is currently only implemented in wxUniv and -wxMSW ports. +Please note that this function is currently only implemented in wxUniv, +wxMSW and wxGTK2 ports. \wxheading{See also} -\helpref{PositionToXY}{wxtextctrlpositiontoxy}, \helpref{XYToPosition}{wxtextctrlxytoposition}, +\helpref{PositionToXY}{wxtextctrlpositiontoxy}, \helpref{XYToPosition}{wxtextctrlxytoposition} +\perlnote{In wxPerl this function takes only the position argument and +returns a 3-element list \texttt{(result, col, row)}}. \membersection{wxTextCtrl::IsEditable}\label{wxtextctrliseditable} @@ -1104,11 +1116,11 @@ already is filled up to the maximal length, a (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. +Note that under GTK+, this function may only be used with single line text controls. \wxheading{Compatibility} -Only implemented in wxMSW/wxGTK starting with wxWindows 2.3.2. +Only implemented in wxMSW/wxGTK starting with wxWidgets 2.3.2. \membersection{wxTextCtrl::SetSelection}\label{wxtextctrlsetselection} @@ -1131,7 +1143,7 @@ in the control is selected. \func{bool}{SetStyle}{\param{long }{start}, \param{long }{end}, \param{const wxTextAttr\& }{style}} Changes the style of the given range. If any attribute within {\it style} is -not set, the correspondign attribute from \helpref{GetDefaultStyle()}{wxtextctrlgetdefaultstyle} is used. +not set, the corresponding attribute from \helpref{GetDefaultStyle()}{wxtextctrlgetdefaultstyle} is used. \wxheading{Parameters}