From: Mattia Barbon <mbarbon@cpan.org>
Date: Fri, 15 Feb 2002 21:50:50 +0000 (+0000)
Subject: Updated docs for wxProcessEvent
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/9722642d5d29a39c9b7ab3d0a07e773ea0c8829a

Updated docs for wxProcessEvent
wxPerl docs updates
some minor fixes


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@14242 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---

diff --git a/docs/latex/wx/config.tex b/docs/latex/wx/config.tex
index 6ae7706b42..f349c6f0fd 100644
--- a/docs/latex/wx/config.tex
+++ b/docs/latex/wx/config.tex
@@ -308,7 +308,7 @@ config file:
   # the following syntax is valud only under Windows
   UserData = %windir%\\data.dat
 \end{verbatim}
-
+% $ % help EMACS syntax highlighting...
 the call to \tt{config->Read("UserData")} will return something like
 \tt{"/home/zeitlin/data"} if you're lucky enough to run a Linux system ;-)
 
@@ -479,6 +479,9 @@ Gets the first group.
 consisting of the continue flag, the value string, and the index for
 the next call.}
 
+\perlnote{In wxPerl this method takes no arguments and returns a 3-element
+list {\tt ( continue, str, index )}.}
+
 \membersection{wxConfigBase::GetFirstEntry}\label{wxconfigbasegetfirstentry}
 
 \constfunc{bool}{GetFirstEntry}{\param{wxString\& }{str}, \param{long\&}{ index}}
@@ -489,6 +492,9 @@ Gets the first entry.
 consisting of the continue flag, the value string, and the index for
 the next call.}
 
+\perlnote{In wxPerl this method takes no arguments and returns a 3-element
+list {\tt ( continue, str, index )}.}
+
 \membersection{wxConfigBase::GetNextGroup}\label{wxconfigbasegetnextgroup}
 
 \constfunc{bool}{GetNextGroup}{\param{wxString\& }{str}, \param{long\&}{ index}}
@@ -499,6 +505,9 @@ Gets the next group.
 consisting of the continue flag, the value string, and the index for
 the next call.}
 
+\perlnote{In wxPerl this method only takes the {\tt index} parameter
+and returns a 3-element list {\tt ( continue, str, index )}.}
+
 \membersection{wxConfigBase::GetNextEntry}\label{wxconfigbasegetnextentry}
 
 \constfunc{bool}{GetNextEntry}{\param{wxString\& }{str}, \param{long\&}{ index}}
@@ -509,6 +518,9 @@ Gets the next entry.
 consisting of the continue flag, the value string, and the index for
 the next call.}
 
+\perlnote{In wxPerl this method only takes the {\tt index} parameter
+and returns a 3-element list {\tt ( continue, str, index )}.}
+
 \membersection{wxConfigBase::GetNumberOfEntries}\label{wxconfigbasegetnumberofentries}
 
 \constfunc{uint }{GetNumberOfEntries}{\param{bool }{bRecursive = FALSE}}
@@ -639,6 +651,15 @@ implements the following methods:\par
 \end{twocollist}}
 }
 
+\perlnote{In place of a single overloaded method, wxPerl uses:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{{\bf Read(key, default="")}}{Returns a string}
+\twocolitem{{\bf ReadInt(key, default=0)}}{Returns an integer}
+\twocolitem{{\bf ReadFloat(key, default=0.0)}}{Returns a floating point number}
+\twocolitem{{\bf ReadBool(key, default=0)}}{Returns a boolean}
+\end{twocollist}
+}}
+
 \membersection{wxConfigBase::RenameEntry}\label{wxconfigbaserenameentry}
 
 \func{bool}{RenameEntry}{\param{const wxString\& }{ oldName}, \param{const wxString\& }{ newName}}
@@ -729,3 +750,11 @@ implements the following methods:\par
 \end{twocollist}}
 }
 
+\perlnote{In place of a single overloaded method, wxPerl uses:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{{\bf Write(key, value)}}{Writes a string}
+\twocolitem{{\bf WriteInt(key, value)}}{Writes an integer}
+\twocolitem{{\bf WriteFloat(key, value)}}{Writes a floating point number}
+\twocolitem{{\bf WriteBool(key, value)}}{Writes a boolean}
+\end{twocollist}
+}}
diff --git a/docs/latex/wx/function.tex b/docs/latex/wx/function.tex
index 35eeebcb3e..3195976b5d 100644
--- a/docs/latex/wx/function.tex
+++ b/docs/latex/wx/function.tex
@@ -430,8 +430,16 @@ processes.
 
 \func{long}{wxExecute}{\param{const wxString\& }{command}, \param{wxArrayString\& }{output}}
 
+\perlnote{In wxPerl this function only takes the {\tt command} argument,
+and returns a 2-element list {\tt ( status, output )}, where {\tt output} is
+an array reference.}
+
 \func{long}{wxExecute}{\param{const wxString\& }{command}, \param{wxArrayString\& }{output}, \param{wxArrayString\& }{errors}}
 
+\perlnote{In wxPerl this function only takes the {\tt command} argument,
+and returns a 3-element list {\tt ( status, output, errors )}, where
+{\tt output} and {\tt errors} are array references.}
+
 Executes another program in Unix or Windows.
 
 The first form takes a command string, such as {\tt "emacs file.txt"}.
@@ -3370,7 +3378,7 @@ because it will not be executed in release mode at all.
 \func{}{wxASSERT\_MIN\_BITSIZE}{\param{}{type}, \param{}{size}}
 
 This macro results in a 
-\helpref{compile time assertion failure}{wxCOMPILE\_TIME\_ASSERT} if the size
+\helpref{compile time assertion failure}{wxcompiletimeassert} if the size
 of the given type {\it type} is less than {\it size} bits.
 
 You may use it like this, for example:
@@ -3399,7 +3407,7 @@ Assert macro with message. An error message will be generated if the condition i
 \func{}{wxCOMPILE\_TIME\_ASSERT}{\param{}{condition}, \param{}{msg}}
 
 Using {\tt wxCOMPILE\_TIME\_ASSERT} results in a compilation error if the
-specified {\it condition| is false. The compiler error message should include
+specified {\it condition} is false. The compiler error message should include
 the {\it msg} identifier - please note that it must be a valid C++ identifier
 and not a string unlike in the other cases.
 
diff --git a/docs/latex/wx/grid.tex b/docs/latex/wx/grid.tex
index f99e99099d..1ffe177d10 100644
--- a/docs/latex/wx/grid.tex
+++ b/docs/latex/wx/grid.tex
@@ -400,6 +400,9 @@ grid cell at the specified location.
 Horizontal alignment will be one of wxALIGN\_LEFT, wxALIGN\_CENTRE or wxALIGN\_RIGHT. \\
 Vertical alignment will be one of wxALIGN\_TOP, wxALIGN\_CENTRE or wxALIGN\_BOTTOM.
 
+\perlnote{This method only takes the parameters {\tt row} and {\tt col} and
+returns a 2-element list {\tt ( horiz, vert )}.}
+
 \membersection{wxGrid::GetCellBackgroundColour}\label{wxgridgetcellbackgroundcolour}
 
 \func{wxColour}{GetCellBackgroundColour}{\param{int }{row}, \param{int }{col}}
@@ -462,6 +465,9 @@ Sets the arguments to the current column label alignment values.
 Horizontal alignment will be one of wxLEFT, wxCENTRE or wxRIGHT. \\
 Vertical alignment will be one of wxTOP, wxCENTRE or wxBOTTOM.
 
+\perlnote{This method takes no parameters and
+returns a 2-element list {\tt ( horiz, vert )}.}
+
 \membersection{wxGrid::GetColLabelSize}\label{wxgridgetcollabelsize}
 
 \func{int}{GetColLabelSize}{\void}
@@ -617,6 +623,9 @@ Sets the arguments to the current row label alignment values.
 Horizontal alignment will be one of wxLEFT, wxCENTRE or wxRIGHT. \\
 Vertical alignment will be one of wxTOP, wxCENTRE or wxBOTTOM.
 
+\perlnote{This method takes no parameters and
+returns a 2-element list {\tt ( horiz, vert )}.}
+
 \membersection{wxGrid::GetRowLabelSize}\label{wxgridgetrowlabelsize}
 
 \func{int}{GetRowLabelSize}{\void}
diff --git a/docs/latex/wx/gridattr.tex b/docs/latex/wx/gridattr.tex
index ca95c4c5a2..0ad74b1840 100644
--- a/docs/latex/wx/gridattr.tex
+++ b/docs/latex/wx/gridattr.tex
@@ -138,6 +138,8 @@ accessors
 
 \constfunc{void}{GetAlignment}{\param{int* }{hAlign}, \param{int* }{vAlign}}
 
+\perlnote{This method takes no parameters and
+returns a 2-element list {\tt ( hAlign, vAlign )}.}
 
 \membersection{wxGridCellAttr::GetRenderer}\label{wxgridcellattrgetrenderer}
 
diff --git a/docs/latex/wx/listctrl.tex b/docs/latex/wx/listctrl.tex
index 32fe36b1a8..ce63aa66be 100644
--- a/docs/latex/wx/listctrl.tex
+++ b/docs/latex/wx/listctrl.tex
@@ -474,7 +474,7 @@ this method. The first value is the item id and the second is the
 flags value mentioned above.}
 
 \perlnote{In wxPerl this method only takes the {\bf point} parameter
-  and returns a 2-element list ( item, flags ).}
+  and returns a 2-element list {\tt ( item, flags )}.}
 
 \membersection{wxListCtrl::InsertColumn}\label{wxlistctrlinsertcolumn}
 
diff --git a/docs/latex/wx/menu.tex b/docs/latex/wx/menu.tex
index 47c25c0dd6..fa1bf18c49 100644
--- a/docs/latex/wx/menu.tex
+++ b/docs/latex/wx/menu.tex
@@ -236,7 +236,7 @@ optionally, the (sub)menu it belongs to.
 
 \perlnote{In wxPerl this method takes just the {\tt id} parameter;
 in scalar context it returns the associated {\tt Wx::MenuItem}, in list
-context it returns a 2-element list ( item, submenu )}
+context it returns a 2-element list {\tt ( item, submenu )}}
 
 \wxheading{Parameters}
 
diff --git a/docs/latex/wx/process.tex b/docs/latex/wx/process.tex
index 2994063100..78908e4820 100644
--- a/docs/latex/wx/process.tex
+++ b/docs/latex/wx/process.tex
@@ -23,6 +23,9 @@ to call its \helpref{Redirect}{wxprocessredirect} method before passing it to
 the streams corresponding to the child process stdandard output, input and
 error output respectively.
 
+\perlnote{In wxPerl this class has an additional {\tt Destroy} method,
+for explicit destruction.}
+
 \wxheading{Derived from}
 
 \helpref{wxEvtHandler}{wxevthandler}
@@ -159,7 +162,7 @@ enum wxKillError
 \helpref{wxKill}{wxkill},\rtfsp
 \helpref{Exec sample}{sampleexec}
 
-\membersection{wxProcess::Kill}\label{wxprocessexists}
+\membersection{wxProcess::Exists}\label{wxprocessexists}
 
 \func{static bool}{Exists}{\param{int}{ pid}}
 
diff --git a/docs/latex/wx/procevt.tex b/docs/latex/wx/procevt.tex
index 897b5b961c..fd88a750cb 100644
--- a/docs/latex/wx/procevt.tex
+++ b/docs/latex/wx/procevt.tex
@@ -32,25 +32,25 @@ or a window to receive the event.}
 
 \membersection{wxProcessEvent::wxProcessEvent}
 
-\func{}{wxProcessEvent}{\param{int }{id = 0}, \param{int }{pid = 0}}
+\func{}{wxProcessEvent}{\param{int }{id = 0}, \param{int }{pid = 0}, \param{int }{exitcode = 0}}
 
-Constructor. Takes a wxProcessObject or window id, and a process id.
-
-\membersection{wxProcessEvent::m\_pid}
-
-\member{int}{m\_pid}
-
-Contains the process id.
+Constructor. Takes a wxProcessObject or window id, a process id and an
+exit status.
 
+%\membersection{wxProcessEvent::m\_pid}
+%
+%\member{int}{m\_pid}
+%
+%Contains the process id.
+%
 \membersection{wxProcessEvent::GetPid}\label{wxprocesseventgetpid}
 
 \constfunc{int}{GetPid}{\void}
 
 Returns the process id.
 
-\membersection{wxProcessEvent::SetPid}\label{wxprocesseventsetpid}
-
-\func{void}{SetPid}{\param{int}{ pid}}
+\membersection{wxProcessEvent::GetExitCode}\label{wxprocesseventgetexitcode}
 
-Sets the process id.
+\func{int}{GetExitCode}{\void}
 
+Returns the exist status.
diff --git a/docs/latex/wx/treectrl.tex b/docs/latex/wx/treectrl.tex
index 18b1155954..76b0f77a5f 100644
--- a/docs/latex/wx/treectrl.tex
+++ b/docs/latex/wx/treectrl.tex
@@ -350,7 +350,7 @@ Returns an invalid tree item if there are no further children.
 value are both returned as a tuple containing the two values.}
 
 \perlnote{In wxPerl this method only takes the {\tt item} parameter, and
-  returns a 2-element list ( item, cookie ).}
+  returns a 2-element list {\tt ( item, cookie )}.}
 
 \membersection{wxTreeCtrl::GetFirstVisibleItem}\label{wxtreectrlgetfirstvisibleitem}
 
@@ -454,7 +454,7 @@ Returns an invalid tree item if there are no further children.
 value are both returned as a tuple containing the two values.}
 
 \perlnote{In wxPerl this method returns a 2-element list
-  ( item, cookie ), instead of modifying its parameters.}
+  {\tt ( item, cookie )}, instead of modifying its parameters.}
 
 \membersection{wxTreeCtrl::GetNextSibling}\label{wxtreectrlgetnextsibling}
 
@@ -570,7 +570,7 @@ id at this point plus extra information {\it flags}. {\it flags} is a bitlist of
 returned as a tuple.}
 
 \perlnote{In wxPerl this method only takes the {\tt point} parameter
-  and returns a 2-element list ( item, flags ).}
+  and returns a 2-element list {\tt ( item, flags )}.}
 
 \membersection{wxTreeCtrl::InsertItem}\label{wxtreectrlinsertitem}