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
This commit is contained in:
Mattia Barbon
2002-02-15 21:50:50 +00:00
parent 4125131be6
commit 9722642d5d
9 changed files with 72 additions and 21 deletions

View File

@@ -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}
}}