added and documented SplitVolume() and GetPathTerminators(); corrected SetPath()...

[wxWidgets.git] / docs / latex / wx / text.tex

diff --git a/docs/latex/wx/text.tex b/docs/latex/wx/text.tex
index 8aa7927cfb13770dd9e36621ee7df0b30c43dac5..93129cdabc4406411e126b945682a8faee620dd0 100644 (file)
--- a/docs/latex/wx/text.tex
+++ b/docs/latex/wx/text.tex
@@ -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}
@@ -281,7 +291,7 @@ you can still use Ctrl-Enter to pass to the next control from the keyboard.}
 \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}
@@ -294,8 +304,8 @@ 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+.}
 \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).}
@@ -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%
@@ -625,7 +635,7 @@ Resets the internal `modified' flag as if the current edits had been saved.
 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}
 
@@ -1108,7 +1120,7 @@ Note that 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}