X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a660d684eda27638bca0384b2058911a31c8e845..db67d86dd1de506a5bb14dd59e9c45230120758a:/docs/latex/wx/expr.tex diff --git a/docs/latex/wx/expr.tex b/docs/latex/wx/expr.tex index b6fd3020a4..83381dfdde 100644 --- a/docs/latex/wx/expr.tex +++ b/docs/latex/wx/expr.tex @@ -8,6 +8,10 @@ or list, and lists can be nested. None +\wxheading{Include files} + + + \wxheading{See also} \helpref{wxExpr overview}{exproverview}, \helpref{wxExprDatabase}{wxexprdatabase} @@ -42,8 +46,8 @@ Construct a floating point expression. Construct a list expression. The list's nodes' data should themselves be {\bf wxExpr}s. -The current version of this library no longer uses the {\bf wxList} -internally, so this constructor turns the list into its internal +wxExpr no longer uses the {\bf wxList} internally, +so this constructor turns the list into its internal format (assuming a non-nested list) and then deletes the supplied list. @@ -283,17 +287,9 @@ typedef enum { Returns the word value of the expression. -\membersection{wxExpr::WriteLispExpr}\label{wxexprwritelistexpr} - -\func{void}{WriteLispExpr}{\param{ostream\&}{ stream}} - -Writes the expression or clause to the given stream in LISP format. -Not normally needed, since the whole {\bf wxExprDatabase} will usually -be written at once. Lists are enclosed in parentheses will no commas. - -\membersection{wxExpr::WritePrologClause}\label{wxexprwriteprologclause} +\membersection{wxExpr::WriteClause}\label{wxexprwriteprologclause} -\func{void}{WritePrologClause}{\param{ostream\&}{ stream}} +\func{void}{WriteClause}{\param{FILE *}{ stream}} Writes the clause to the given stream in Prolog format. Not normally needed, since the whole {\bf wxExprDatabase} will usually be written at once. The format is: @@ -302,7 +298,7 @@ full stop. \membersection{wxExpr::WriteExpr}\label{wxexprwriteexpr} -\func{void}{WriteExpr}{\param{ostream\&}{ stream}} +\func{void}{WriteExpr}{\param{FILE *}{ stream}} Writes the expression (not clause) to the given stream in Prolog format. Not normally needed, since the whole {\bf wxExprDatabase} will @@ -356,13 +352,13 @@ Construct a new, unhashed database, with an optional error handler. The error handler must be a function returning a bool and taking an integer and a string argument. When an error occurs when reading or writing a database, this function is called. The error is given as the first argument (currently one of WXEXPR\_ERROR\_GENERAL, -WXEXPR\_ERROR\_SYNTAX) and an error message is given as the second argument. If FALSE +WXEXPR\_ERROR\_SYNTAX) and an error message is given as the second argument. If false is returned by the error handler, processing of the wxExpr operation stops. Another way of handling errors is simply to call \helpref{wxExprDatabase::GetErrorCount}{wxexprdatabasegeterrorcount} after the operation, to check whether errors have occurred, instead of installing an error handler. If the error count is more than zero, \helpref{wxExprDatabase::Write}{wxexprdatabasewrite} and -\rtfsp\helpref{wxExprDatabase::Read}{wxexprdatabaseread} will return FALSE to +\rtfsp\helpref{wxExprDatabase::Read}{wxexprdatabaseread} will return false to the application. For example: @@ -374,13 +370,12 @@ bool myErrorHandler(int err, chat *msg) { wxMessageBox(msg, "Syntax error"); } - return FALSE; + return false; } wxExprDatabase database(myErrorHandler); \end{verbatim} - \func{}{wxExprDatabase}{\param{wxExprType}{ type}, \param{const wxString\&}{attribute}, \rtfsp\param{int}{ size = 500}, \param{proioErrorHandler}{ handler = 0}} @@ -481,24 +476,20 @@ in the database constructor having the given string value. \func{bool}{Read}{\param{const wxString\&}{ filename}} -Reads in the given file, returning TRUE if successful. +Reads in the given file, returning true if successful. \membersection{wxExprDatabase::ReadFromString}\label{wxexprdatabasereadfromstring} \func{bool}{ReadFromString}{\param{const wxString\&}{ buffer}} -Reads a Prolog database from the given string buffer, returning TRUE if +Reads a Prolog database from the given string buffer, returning true if successful. -\membersection{wxExprDatabase::WriteLisp}\label{wxexprdatabasewritelisp} - -\func{bool}{WriteLisp}{\param{ostream\& }{stream}} - -Writes the database as a LISP-format file. - \membersection{wxExprDatabase::Write}\label{wxexprdatabasewrite} -\func{bool}{Write}{\param{ostream\& }{stream}} +\func{bool}{Write}{\param{FILE *}{stream}} + +\func{bool}{Write}{\param{const wxString\&}{ filename}} Writes the database as a Prolog-format file.