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 6ae7706b4282df8d3163885efc2438d15ec82f10..f349c6f0fdd1c2800a87b3bfa36a33a8d8736367 100644 (file)
--- 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}
   # 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 ;-)
 
 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.}
 
 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}}
 \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.}
 
 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}}
 \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.}
 
 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}}
 \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.}
 
 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}}
 \membersection{wxConfigBase::GetNumberOfEntries}\label{wxconfigbasegetnumberofentries}
 
 \constfunc{uint }{GetNumberOfEntries}{\param{bool }{bRecursive = FALSE}}


@@ -639,6 +651,15 @@ implements the following methods:\par
 \end{twocollist}}
 }
 
 \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}}
 \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}}
 }
 
 \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 35eeebcb3ee44e066b672640d1583391008afef1..3195976b5ddaf7cf9f1204e109ed04e30f7a2688 100644 (file)
--- 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}}
 
 
 \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}}
 
 \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"}.
 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 
 \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:
 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
 \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.
 
 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 f99e99099deaa01e4492c8e6aab173d1fc10c9f9..1ffe177d109658e69cddf108d06b6adf44abd719 100644 (file)
--- 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.
 
 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}}
 \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.
 
 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}
 \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.
 
 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}
 \membersection{wxGrid::GetRowLabelSize}\label{wxgridgetrowlabelsize}
 
 \func{int}{GetRowLabelSize}{\void}

diff --git a/docs/latex/wx/gridattr.tex b/docs/latex/wx/gridattr.tex
index ca95c4c5a2b60e405e6854547a9203350014966f..0ad74b18401f7854505b06432e2359717ae4e626 100644 (file)
--- 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}}
 
 
 \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}
 
 
 \membersection{wxGridCellAttr::GetRenderer}\label{wxgridcellattrgetrenderer}
 

diff --git a/docs/latex/wx/listctrl.tex b/docs/latex/wx/listctrl.tex
index 32fe36b1a88925be12695cb96c5ef642a697ae86..ce63aa66bea979521e7456cfa026abfd7ed5910a 100644 (file)
--- 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
 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}
 
 
 \membersection{wxListCtrl::InsertColumn}\label{wxlistctrlinsertcolumn}
 

diff --git a/docs/latex/wx/menu.tex b/docs/latex/wx/menu.tex
index 47c25c0dd6c5f520b4a9bd9dc4e9694dbfcbe93a..fa1bf18c4908d99af1e77e1fdbc6b9449dcffaad 100644 (file)
--- 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
 
 \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}
 
 
 \wxheading{Parameters}
 

diff --git a/docs/latex/wx/process.tex b/docs/latex/wx/process.tex
index 2994063100756b3b99866e98455656545475aee3..78908e482060ba691d321a6bbcc8752bcf29d5e3 100644 (file)
--- 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.
 
 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}
 \wxheading{Derived from}
 
 \helpref{wxEvtHandler}{wxevthandler}


@@ -159,7 +162,7 @@ enum wxKillError
 \helpref{wxKill}{wxkill},\rtfsp
 \helpref{Exec sample}{sampleexec}
 
 \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}}
 
 
 \func{static bool}{Exists}{\param{int}{ pid}}
 

diff --git a/docs/latex/wx/procevt.tex b/docs/latex/wx/procevt.tex
index 897b5b961c311cfc453d81ea5bf54a1cd6ae7b78..fd88a750cbe03290021cd8ef90a5288d95c6b3d3 100644 (file)
--- 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}
 
 
 \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::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 18b11559540d9d3f375cde9f577d2bb84180179c..76b0f77a5fece3915bb8df64592f8f7c8a184e47 100644 (file)
--- 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
 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}
 
 
 \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
 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}
 
 
 \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
 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}
 
 
 \membersection{wxTreeCtrl::InsertItem}\label{wxtreectrlinsertitem}