clarified the parameters of MB2WC and WC2MB a little in the docs/headers

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

diff --git a/docs/latex/wx/caret.tex b/docs/latex/wx/caret.tex
index 474b9c4557b39079dc4ce4829cbda7483e4a6229..42eb260dec3538e023c15fd652d6020fb446f22e 100644 (file)
--- a/docs/latex/wx/caret.tex
+++ b/docs/latex/wx/caret.tex
@@ -6,7 +6,7 @@
 %% Created:     20.06.00
 %% RCS-ID:      $Id$
 %% Copyright:   (c) Vadim Zeitlin
-%% License:     wxWindows license
+%% License:     wxWidgets license
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxCaret}}\label{wxcaret}
@@ -72,6 +72,15 @@ for all carets, so this functions is static).
 
 Get the caret position (in pixels).
 
+\perlnote{In wxPerl there are two methods instead of a single overloaded
+method:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{{\bf GetPosition()}}{Returns a Wx::Point}
+\twocolitem{{\bf GetPositionXY()}}{Returns a 2-element list
+ {\tt ( x, y )}}
+\end{twocollist}
+}}
+
 \membersection{wxCaret::GetSize}\label{wxcaretgetsize}
 
 \constfunc{void}{GetSize}{\param{int* }{width}, \param{int* }{height}}
@@ -80,6 +89,15 @@ Get the caret position (in pixels).
 
 Get the caret size.
 
+\perlnote{In wxPerl there are two methods instead of a single overloaded
+method:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{{\bf GetSize()}}{Returns a Wx::Size}
+\twocolitem{{\bf GetSizeWH()}}{Returns a 2-element list
+ {\tt ( width, height )}}
+\end{twocollist}
+}}
+
 \membersection{wxCaret::GetWindow}\label{wxcaretgetwindow}
 
 \constfunc{wxWindow*}{GetWindow}{\void}
@@ -90,21 +108,21 @@ Get the window the caret is associated with.
 
 \func{void}{Hide}{\void}
 
-Same as \helpref{wxCaret::Show(FALSE)}{wxcaretshow}.
+Same as \helpref{wxCaret::Show(false)}{wxcaretshow}.
 
 \membersection{wxCaret::IsOk}\label{wxcaretisok}
 
 \constfunc{bool}{IsOk}{\void}
 
-Returns TRUE if the caret was created successfully.
+Returns true if the caret was created successfully.
 
 \membersection{wxCaret::IsVisible}\label{wxcaretisvisible}
 
 \constfunc{bool}{IsVisible}{\void}
 
-Returns TRUE if the caret is visible and FALSE if it is permanently
+Returns true if the caret is visible and false if it is permanently
 hidden (if it is is blinking and not shown currently but will be after the
-next blink, this method still returns TRUE).
+next blink, this method still returns true).
 
 \membersection{wxCaret::Move}\label{wxcaretmove}
 
@@ -140,7 +158,7 @@ Changes the size of the caret.
 
 \membersection{wxCaret::Show}\label{wxcaretshow}
 
-\func{void}{Show}{\param{bool }{show = TRUE}}
+\func{void}{Show}{\param{bool }{show = true}}
 
 Shows or hides the caret. Notice that if the caret was hidden $N$ times, it
 must be shown $N$ times as well to reappear on the screen.