structure of the main wxWindows hierarchy. See also the 'utils'
hierarchy. The first place to look for documentation about
these tools and libraries is under the wxWindows 'docs' hierarchy,
-for example \tt{docs/htmlhelp/fl.chm}.
+for example {\tt docs/htmlhelp/fl.chm}.
For other user-contributed packages, please see the Contributions page
on the \urlref{wxWindows Web site}{http://www.wxwindows.org}.
Help files. In many cases, you may wish to use the wxWindows HTML
Help classes from within your application, but this provides a
handy stand-alone viewer. See \helpref{wxHTML Notes}{wxhtml} for more details.
-You can find it in \tt{samples/html/helpview}.
+You can find it in {\tt samples/html/helpview}.
\item[{\bf Tex2RTF}]
Supplied with wxWindows is a utility called Tex2RTF for converting\rtfsp
Help RTF formats. Tex2RTF is used for the wxWindows manuals and can be used independently
by authors wishing to create on-line and printed manuals from the same\rtfsp
\LaTeX\ source. Please see the separate documentation for Tex2RTF.
-You can find it under \tt{utils/tex2rtf}.
+You can find it under {\tt utils/tex2rtf}.
\item[{\bf Helpgen}]
Helpgen takes C++ header files and generates a Tex2RTF-compatible
Dialog Editor allows interactive construction of dialogs using
absolute positioning, producing WXR output files. This tool is generally deprecated
in favour of sizer-based tools. You can find Dialog Editor
-in \tt{utils/dialoged}.
+in {\tt utils/dialoged}.
\item[{\bf XRC resource system}]
This is the sizer-aware replacement for the WXR resource system, and uses
XML-based resource specifications that can be generated by tools
such as \urlref{wxDesigner}{http://www.roebling.de} and XRC's own wxrcedit.
-You can find this in \tt{contrib/src/xrc}, \tt{contrib/include/wx/xrc}, \tt{contrib/samples/xrc}, and \tt{contrib/utils/wxrcedit}.
+You can find this in {\tt contrib/src/xrc}, {\tt contrib/include/wx/xrc}, {\tt contrib/samples/xrc}, and {\tt contrib/utils/wxrcedit}.
For more information, see the \helpref{XML-based resource system overview}{xrcoverview}.
\item[{\bf Object Graphics Library}]
OGL defines an API for applications that need to display objects connected by lines.
The objects can be moved around and interacted with.
-You can find this in \tt{contrib/src/ogl}, \tt{contrib/include/wx/ogl}, and \tt{contrib/samples/ogl}.
+You can find this in {\tt contrib/src/ogl}, {\tt contrib/include/wx/ogl}, and {\tt contrib/samples/ogl}.
\item[{\bf Frame Layout library}]
FL provides sophisticated pane dragging and docking facilities.
-You can find this in \tt{contrib/src/fl}, \tt{contrib/include/wx/fl}, and \tt{contrib/samples/fl}.
+You can find this in {\tt contrib/src/fl}, {\tt contrib/include/wx/fl}, and {\tt contrib/samples/fl}.
\item[{\bf Gizmos library}]
Gizmos is a collection of useful widgets and other classes. Classes include wxLEDNumberCtrl,
wxEditableListBox, wxMultiCellCanvas.
-You can find this in \tt{contrib/src/fl}, \tt{contrib/include/wx/fl}, and \tt{contrib/samples/fl}.
+You can find this in {\tt contrib/src/fl}, {\tt contrib/include/wx/fl}, and {\tt contrib/samples/fl}.
\item[{\bf Net library}]
Net is a collection of very simple mail and web related classes. Currently
there is only wxEmail, which makes it easy to send email messages via MAPI on Windows or sendmail on Unix.
-You can find this in \tt{contrib/src/net} and \tt{contrib/include/wx/net}.
+You can find this in {\tt contrib/src/net} and {\tt contrib/include/wx/net}.
\item[{\bf Animate library}]
Animate allows you to load animated GIFs and play them on a window. The library can be extended
to use other animation formats.
-You can find this in \tt{contrib/src/animate}, \tt{contrib/include/wx/animate}, and \tt{contrib/samples/animate}.
+You can find this in {\tt contrib/src/animate}, {\tt contrib/include/wx/animate}, and {\tt contrib/samples/animate}.
\item[{\bf Canvas library}]
Canvas supports high-level, double-buffered drawing operations with transformations.
-You can find this in \tt{contrib/src/canvas}, \tt{contrib/include/wx/canvas}, and \tt{contrib/samples/canvas}.
+You can find this in {\tt contrib/src/canvas}, {\tt contrib/include/wx/canvas}, and {\tt contrib/samples/canvas}.
\item[{\bf MMedia library}]
Mmedia supports a variety of multimedia functionality. The status of this library is currently unclear.
-You can find this in \tt{contrib/src/mmedia}, \tt{contrib/include/wx/mmedia}, and \tt{contrib/samples/mmedia}.
+You can find this in {\tt contrib/src/mmedia}, {\tt contrib/include/wx/mmedia}, and {\tt contrib/samples/mmedia}.
\item[{\bf Styled Text Control library}]
STC is a wrapper around Scintilla, a syntax-highlighting text editor.
-You can find this in \tt{contrib/src/stc}, \tt{contrib/include/wx/stc}, and \tt{contrib/samples/stc}.
+You can find this in {\tt contrib/src/stc}, {\tt contrib/include/wx/stc}, and {\tt contrib/samples/stc}.
\item[{\bf Plot}]
Plot is a simple curve plotting library.
-You can find this in \tt{contrib/src/plot}, \tt{contrib/include/wx/plot}, and \tt{contrib/samples/plot}.
+You can find this in {\tt contrib/src/plot}, {\tt contrib/include/wx/plot}, and {\tt contrib/samples/plot}.
\end{description}
\chapter{Programming strategies}\label{strategies}
\membersection{wxCalendarEvent::GetDate}{wxcalendareventgetdate}
-\constfunc{const wxDateTime&}{GetDate}{\void}
+\constfunc{const wxDateTime\&}{GetDate}{\void}
Returns the date. This function may be called for all event types except
{\tt EVT\_CALENDAR\_WEEKDAY\_CLICKED} one for which it doesn't make sense.
change in the near future). To work with other types: for {\it int} or {\it
bool} you can work with function taking/returning {\it long} and just use the
casts. Better yet, just use {\it long} for all variables which you're going to
-save in the config file: chances are that \tt{sizeof(bool) == sizeof(int) == sizeof(long)} anyhow on your system. For {\it float}, {\it double} and, in
+save in the config file: chances are that {\tt sizeof(bool) == sizeof(int) == sizeof(long)} anyhow on your system. For {\it float}, {\it double} and, in
general, any other type you'd have to translate them to/from string
representation and use string functions.
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 ;-)
Although this feature is very useful, it may be annoying if you read a value
which containts '\$' or '\%' symbols (\% is used for environment variables
\membersection{wxDateTime::SetToCurrent}\label{wxdatetimesettocurrent}
-\func{wxDateTime&}{SetToCurrent}{\void}
+\func{wxDateTime\&}{SetToCurrent}{\void}
Sets the date and time of to the current values. Same as assigning the result
of \helpref{Now()}{wxdatetimenow} to this object.
\membersection{wxDateTime::IsEqualTo}\label{wxdatetimeisequalto}
-\constfunc{bool}{IsEqualTo}{\param{const wxDateTime& }{datetime}}
+\constfunc{bool}{IsEqualTo}{\param{const wxDateTime\& }{datetime}}
Returns {\tt TRUE} if the two dates are strictly identical.
\membersection{wxDateTime::IsEarlierThan}\label{wxdatetimeisearlierthan}
-\constfunc{bool}{IsEarlierThan}{\param{const wxDateTime& }{datetime}}
+\constfunc{bool}{IsEarlierThan}{\param{const wxDateTime\& }{datetime}}
Returns {\tt TRUE} if this date precedes the given one.
\membersection{wxDateTime::IsLaterThan}\label{wxdatetimeislaterthan}
-\constfunc{bool}{IsLaterThan}{\param{const wxDateTime& }{datetime}}
+\constfunc{bool}{IsLaterThan}{\param{const wxDateTime\& }{datetime}}
Returns {\tt TRUE} if this date is later than the given one.
\membersection{wxDateTime::IsStrictlyBetween}\label{wxdatetimeisstrictlybetween}
-\constfunc{bool}{IsStrictlyBetween}{\param{const wxDateTime& }{t1}, \param{const wxDateTime& }{t2}}
+\constfunc{bool}{IsStrictlyBetween}{\param{const wxDateTime\& }{t1}, \param{const wxDateTime\& }{t2}}
Returns {\tt TRUE} if this date lies strictly between the two others,
\membersection{wxDateTime::IsBetween}\label{wxdatetimeisbetween}
-\constfunc{bool}{IsBetween}{\param{const wxDateTime& }{t1}, \param{const wxDateTime& }{t2}}
+\constfunc{bool}{IsBetween}{\param{const wxDateTime\& }{t1}, \param{const wxDateTime\& }{t2}}
Returns {\tt TRUE} if \helpref{IsStrictlyBetween}{wxdatetimeisstrictlybetween}
is {\tt TRUE} or if the date is equal to one of the limi values.
\membersection{wxDateTime::IsSameDate}\label{wxdatetimeissamedate}
-\constfunc{bool}{IsSameDate}{\param{const wxDateTime& }{dt}}
+\constfunc{bool}{IsSameDate}{\param{const wxDateTime\& }{dt}}
Returns {\tt TRUE} if the date is the same without comparing the time parts.
\membersection{wxDateTime::IsSameTime}\label{wxdatetimeissametime}
-\constfunc{bool}{IsSameTime}{\param{const wxDateTime& }{dt}}
+\constfunc{bool}{IsSameTime}{\param{const wxDateTime\& }{dt}}
Returns {\tt TRUE} if the time is the same (although dates may differ).
error situation occurs. This function only works in DEBUG builds
-\func{bool}{wxDbSqlLog}{\param{wxDbSqlLogState }{state}, \param{const wxString &}{filename = SQL\_LOG\_FILENAME}}
+\func{bool}{wxDbSqlLog}{\param{wxDbSqlLogState }{state}, \param{const wxString \&}{filename = SQL\_LOG\_FILENAME}}
\wxheading{Remarks}
Default constructor.
-\func{}{wxDb}{\param{const HENV &}{aHenv}, \param{bool }{FwdOnlyCursors=(bool)wxODBC\_FWD\_ONLY\_CURSORS}}
+\func{}{wxDb}{\param{const HENV \&}{aHenv}, \param{bool }{FwdOnlyCursors=(bool)wxODBC\_FWD\_ONLY\_CURSORS}}
Constructor, used to create an ODBC connection to a datasource.
\membersection{wxDb::Catalog}\label{wxdbcatalog}
-\func{bool}{Catalog}{\param{wxChar *}{ userID}, \param{const wxString &}{fileName =
+\func{bool}{Catalog}{\param{wxChar *}{ userID}, \param{const wxString \&}{fileName =
SQL\_CATALOG\_FILENAME}}
Allows a data "dictionary" of the datasource to be created, dumping pertinent
\membersection{wxDb::CreateView}\label{wxdbcreateviews}
-\func{bool}{CreateView}{\param{const wxString &}{ viewName},
-\param{const wxString &}{ colList}, \param{const wxString &}{pSqlStmt}}
+\func{bool}{CreateView}{\param{const wxString \&}{ viewName},
+\param{const wxString \&}{ colList}, \param{const wxString \&}{pSqlStmt}}
Creates a SQL VIEW of one or more tables in a single datasource. Note that
this function will only work against databases which support views (currently
\membersection{wxDb::DispAllErrors}\label{wxdbdispallerrors}
-\func{bool}{DispAllErrors}{\param{HENV}{ aHenv}, {\param}{HDBC}
-{ aHdbc = SQL\_NULL\_HDBC}, {\param}{HSTMT}{ aHstmt = SQL\_NULL\_HSTMT}}
+\func{bool}{DispAllErrors}{\param{HENV}{ aHenv}, \param{HDBC}{ aHdbc = SQL\_NULL\_HDBC}, \param{HSTMT}{ aHstmt = SQL\_NULL\_HSTMT}}
Used to log all database errors that occurred as a result of an executed
database command. This logging is automatic and also includes debug logging
\membersection{wxDb::DropView}\label{wxdbdropview}
-\func{bool}{DropView}{\param{const wxString &}{viewName}}
+\func{bool}{DropView}{\param{const wxString \&}{viewName}}
Drops the data table view named in 'viewName'.
\membersection{wxDb::ExecSql}\label{wxdbexecsql}
-\func{bool}{ExecSql}{\param{const wxString &}{pSqlStmt}}
+\func{bool}{ExecSql}{\param{const wxString \&}{pSqlStmt}}
Allows a native SQL command to be executed directly against the datasource. In addition to being able to run any standard SQL command, use of this function allows a user to (potentially) utilize features specific to the datasource they are connected to that may not be available through ODBC. The ODBC driver will pass the specified command directly to the datasource.
\membersection{wxDb::GetColumnCount}\label{wxdbgetcolumncount}
-\func{int }{GetColumnCount}{\param{const wxString &}{tableName}, \param{const wxChar *}{userID}}
+\func{int }{GetColumnCount}{\param{const wxString \&}{tableName}, \param{const wxChar *}{userID}}
\wxheading{Parameters}
\membersection{wxDb::GetColumns}\label{wxdbgetcolumns}
-\func{wxDbColInf *}{GetColumns}{\param{const wxString &}{tableName}, \param{UWORD *}{numCols}, \param{const wxChar *}{userID=NULL}}
+\func{wxDbColInf *}{GetColumns}{\param{const wxString \&}{tableName}, \param{UWORD *}{numCols}, \param{const wxChar *}{userID=NULL}}
\func{wxDbColInf *}{GetColumns}{\param{wxChar *}{tableName[]}, \param{const wxChar *}{userID}}
\membersection{wxDb::GetDatasourceName}\label{wxdbgetdatasourcename}
-\func{const wxString &}{GetDatasourceName}{\void}
+\func{const wxString \&}{GetDatasourceName}{\void}
Returns the ODBC datasource name.
\membersection{wxDb::GetKeyFields}\label{wxdbgetkeyfields}
-\func{int }{GetKeyFields}{\param{const wxString &}{tableName}, \param{wxDbColInf *}{colInf}, \param{UWORD }{nocols}}
+\func{int }{GetKeyFields}{\param{const wxString \&}{tableName}, \param{wxDbColInf *}{colInf}, \param{UWORD }{nocols}}
Used to determine which columns are members of primary or non-primary indexes on the specified table. If a column is a member of a foreign key for some other table, that information is detected also.
\membersection{wxDb::GetPassword}\label{wxdbgetpassword}
-\func{const wxString &}{GetPassword}{\void}
+\func{const wxString \&}{GetPassword}{\void}
Returns the password used to establish this connection to the datasource.
\membersection{wxDb::GetUsername}\label{wxdbgetusername}
-\func{const wxString &}{GetUsername}{\void}
+\func{const wxString \&}{GetUsername}{\void}
Returns the user name (uid) used to establish this connection to the
datasource.
\membersection{wxDb::Grant}\label{wxdbgrant}
-\func{bool}{Grant}{\param{int }{privileges}, \param{const wxString &}{tableName},
-\param{const wxString &}{userList = "PUBLIC"}}
+\func{bool}{Grant}{\param{int }{privileges}, \param{const wxString \&}{tableName},
+\param{const wxString \&}{userList = "PUBLIC"}}
Use this member function to GRANT privileges to users for accessing tables in
the datasource.
\membersection{wxDb::LogError}\label{wxdblogerror}
-\func{void}{LogError}{\param{const wxString &}{errMsg} \param{const wxString &}{SQLState=""}}
+\func{void}{LogError}{\param{const wxString \&}{errMsg} \param{const wxString \&}{SQLState=""}}
\docparam{errMsg}{Free-form text to display describing the error/text to be logged.}
\docparam{SQLState}{{\it OPTIONAL.} Native SQL state error. Default is 0.}
\membersection{wxDb::ModifyColumn}\label{wxdbmodifycolumn}
-\func{void}{ModifyColumn}{\param{const wxString &}{tableName} \param{const wxString &}{ColumnName}
-\param{int }{dataType} \param{ULONG }{columnLength=0} \param{const wxString &}{optionalParam=""}}
+\func{void}{ModifyColumn}{\param{const wxString \&}{tableName} \param{const wxString \&}{ColumnName}
+\param{int }{dataType} \param{ULONG }{columnLength=0} \param{const wxString \&}{optionalParam=""}}
Used to change certain properties of a column such as the length, or whether a column
allows NULLs or not.
\membersection{wxDb::Open}\label{wxdbopen}
-\func{bool}{Open}{\param{const wxString &}{Dsn}, \param{const wxString &}{Uid},
-\param{const wxString &}{AuthStr}}
+\func{bool}{Open}{\param{const wxString \&}{Dsn}, \param{const wxString \&}{Uid},
+\param{const wxString \&}{AuthStr}}
\func{bool}{Open}{\param{wxDb *}{copyDb}}
\membersection{wxDb::SetSqlLogging}\label{wxdbsetsqllogging}
-\func{bool}{SetSqlLogging}{\param{wxDbSqlLogState}{ state}, \param{const wxString &}{filename = SQL\_LOG\_FILENAME}, \param{bool }{ append = FALSE}}
+\func{bool}{SetSqlLogging}{\param{wxDbSqlLogState}{ state}, \param{const wxString \&}{filename = SQL\_LOG\_FILENAME}, \param{bool }{ append = FALSE}}
\wxheading{Parameters}
\membersection{wxDb::TableExists}\label{wxdbtableexists}
-\func{bool}{TableExists}{\param{const wxString &}{tableName}, \param{const wxChar *}{userID=NULL}, \param{const wxString &}{path=""}}
+\func{bool}{TableExists}{\param{const wxString \&}{tableName}, \param{const wxChar *}{userID=NULL}, \param{const wxString \&}{path=""}}
Checks the ODBC datasource for the existence of a table. If a {\it userID}
is specified, then the table must be accessible by that user (user must have
\membersection{wxDb::TablePrivileges}\label{wxdbtableprivileges}
-\func{bool}{TablePrivileges}{\param{const wxString &}{tableName}, \param{const wxString &}{priv},
+\func{bool}{TablePrivileges}{\param{const wxString \&}{tableName}, \param{const wxString \&}{priv},
\param{const wxChar *}{userID=NULL}, \param{const wxChar *}{schema=NULL},
-\param{const wxString &}{path=""}}
+\param{const wxString \&}{path=""}}
Checks the ODBC datasource for the existence of a table. If a {\it userID}
is specified, then the table must be accessible by that user (user must have
{\it tableName} may refer to a table, view, alias or synonym.}
\docparam{priv}{The table privilege being evaluated. May be one of the
following (or a datasource specific privilege):}
-
\begin{verbatim}
SELECT : The connected user is permitted to retrieve data for
one or more columns of the table.
\end{verbatim}
\docparam{userID}{{\it OPTIONAL.} User for which to determine if the privilege
specified to be checked is granted or not. Default is "".
-{\it userID} is evaluated as follows:
-
+{\it userID} is evaluated as follows:}
\begin{verbatim}
userID == NULL ... NOT ALLOWED!
userID == "" ... UserID set equal to 'this->uid'
userID != "" ... UserID set equal to 'userID'
\end{verbatim}
-}
+
\docparam{schema}{{\it OPTIONAL.} Owner of the table. Specify a userID when the datasource
you are connected to allows multiple unique tables with the same name to be
owned by different users. Specifying the table owner makes determination of the
-users privileges MUCH faster. Default is NULL. {\it userID} is evaluated as follows:
-
+users privileges MUCH faster. Default is NULL. {\it userID} is evaluated as follows:}
\begin{verbatim}
schema == NULL ... Any owner (DEFAULT)
schema == "" ... Owned by 'this->uid'
schema != "" ... Owned by userID specified in 'schema'
\end{verbatim}
-}
+
\docparam{path}{{\it OPTIONAL.} Path to the table. Default is "".
Currently unused.}
\membersection{wxDb::TranslateSqlState}\label{wxdbtranslatesqlstate}
-\func{int }{TranslateSqlState}{\param{const wxString &}{SQLState}}
+\func{int }{TranslateSqlState}{\param{const wxString \&}{SQLState}}
Converts an ODBC sqlstate to an internal error code.
\membersection{wxDb::WriteSqlLog}\label{wxdbwritesqllog}
-\func{bool}{WriteSqlLog}{\param{const wxString &}{logMsg}}
+\func{bool}{WriteSqlLog}{\param{const wxString \&}{logMsg}}
\wxheading{Parameters}
Default constructor.
-\func{}{wxDb}{\param{HENV }{henv}, \param{const wxString &}{dsn},
-\param{const wxString &}{userID=""}, \param{const wxString &}{password},
-\param{const wxString &}{defaultDir=""}, \param{const wxString &}{description=""},
-\param{const wxString &}{fileType=""}}
+\func{}{wxDb}{\param{HENV }{henv}, \param{const wxString \&}{dsn},
+\param{const wxString \&}{userID=""}, \param{const wxString \&}{password},
+\param{const wxString \&}{defaultDir=""}, \param{const wxString \&}{description=""},
+\param{const wxString \&}{fileType=""}}
Constructor which allows initial settings of all the classes member variables.
\membersection{wxDbConnectInf::SetAuthStr}\label{wxdbconnectinfsetauthstr}
-\func{\void}{SetAuthStr}{const wxString &authstr}
+\func{\void}{SetAuthStr}{const wxString \&authstr}
Accessor function to assign the password for this class
instance that will be used with the user ID.
\membersection{wxDbConnectInf::SetDefaultDir}\label{wxdbconnectinfsetdefaultdir}
-\func{\void}{SetDefaultDir}{const wxString &defDir}
+\func{\void}{SetDefaultDir}{const wxString \&defDir}
Accessor function to assign the default directory in which the datasource's data
table is stored. This directory is only used for file based datasources like
\membersection{wxDbConnectInf::SetDescription}\label{wxdbconnectinfsetdescription}
-\func{\void}{SetDescription}{const wxString &desc}
+\func{\void}{SetDescription}{const wxString \&desc}
Accessor function to assign the description assigned for this class
instance.
\membersection{wxDbConnectInf::SetDsn}\label{wxdbconnectinfsetdsn}
-\func{\void}{SetDsn}{const wxString &dsn}
+\func{\void}{SetDsn}{const wxString \&dsn}
Accessor function to assign the datasource name for this class instance.
\membersection{wxDbConnectInf::SetFileType}\label{wxdbconnectinfsetfiletype}
-\func{\void}{SetFileType}{const wxString &}
+\func{\void}{SetFileType}{const wxString \&}
Accessor function to return the filetype of the ODBC datasource assigned for
this class instance.
\membersection{wxDbConnectInf::SetPassword}\label{wxdbconnectinfsetpassword}
-\func{\void}{SetPassword}{const wxString &password}
+\func{\void}{SetPassword}{const wxString \&password}
Accessor function to assign the password for this class
instance that will be used with the user ID.
\membersection{wxDbConnectInf::SetUid}\label{wxdbconnectinfsetuid}
-\func{\void}{SetUid}{const wxString &uid}
+\func{\void}{SetUid}{const wxString \&uid}
Accessor function to set the user ID for this class instance.
\membersection{wxDbConnectInf::SetUserID}\label{wxdbconnectinfsetuserid}
-\func{\void}{SetUserID}{const wxString &userID}
+\func{\void}{SetUserID}{const wxString \&userID}
Accessor function to assign the user ID for this class instance.
\membersection{wxDbTable::wxDbTable}\label{wxdbtableconstr}
-\func{}{wxDbTable}{\param{wxDb *}{pwxDb}, \param{const wxString &}{tblName},
- \param{const UWORD }{numColumns}, \param{const wxString &}{qryTblName = ""},
- \param{bool }{qryOnly = !wxDB\_QUERY\_ONLY}, \param{const wxString &}{tblPath = ""}}
+\func{}{wxDbTable}{\param{wxDb *}{pwxDb}, \param{const wxString \&}{tblName},
+ \param{const UWORD }{numColumns}, \param{const wxString \&}{qryTblName = ""},
+ \param{bool }{qryOnly = !wxDB\_QUERY\_ONLY}, \param{const wxString \&}{tblPath = ""}}
Default constructor.
\membersection{wxDbTable::BuildDeleteStmt}\label{wxdbtablebuilddeletestmt}
-\func{void}{BuildDeleteStmt}{\param{wxString &}{pSqlStmt},
-\param{int }{typeOfDel}, \param{const wxString &}{pWhereClause=""}}
+\func{void}{BuildDeleteStmt}{\param{wxString \&}{pSqlStmt},
+\param{int }{typeOfDel}, \param{const wxString \&}{pWhereClause=""}}
Constructs the full SQL statement that can be used to delete all rows matching
the criteria in the pWhereClause.
\membersection{wxDbTable::BuildSelectStmt}\label{wxdbtablebuildselectstmt}
-\func{void}{BuildSelectStmt}{\param{wxString &}{pSqlStmt},
+\func{void}{BuildSelectStmt}{\param{wxString \&}{pSqlStmt},
\param{int }{typeOfSelect}, \param{bool }{distinct}}
Constructs the full SQL statement that can be used to select all rows matching
\membersection{wxDbTable::BuildUpdateStmt}\label{wxdbtablebuildupdatestmt}
-\func{void}{BuildUpdateStmt}{\param{wxString &}{pSqlStmt}, \param{int }{typeOfUpd},
-\param{const wxString &}{pWhereClause=""}}
+\func{void}{BuildUpdateStmt}{\param{wxString \&}{pSqlStmt}, \param{int }{typeOfUpd},
+\param{const wxString \&}{pWhereClause=""}}
Constructs the full SQL statement that can be used to update all rows matching
the criteria in the pWhereClause.
\membersection{wxDbTable::BuildWhereStmt}\label{wxdbtablebuildwherestmt}
-\func{void}{BuildSelectStmt}{\param{wxString &}{pWhereClause},
-\param{int }{typeOfWhere}, \param{const wxString &}{qualTableName=""},
+\func{void}{BuildSelectStmt}{\param{wxString \&}{pWhereClause},
+\param{int }{typeOfWhere}, \param{const wxString \&}{qualTableName=""},
\param{bool }{useLikeComparison=FALSE}}
Constructs the portion of a SQL statement which would follow the word 'WHERE'
\membersection{wxDbTable::Count}\label{wxdbtablecount}
-\func{ULONG }{Count}{\param{const wxString &}{args="*"}}
+\func{ULONG }{Count}{\param{const wxString \&}{args="*"}}
Returns the number of records which would be in the result set using the
current query parameters specified in the WHERE and FROM clauses.
\membersection{wxDbTable::CreateIndex}\label{wxdbtablecreateindex}
-\func{bool}{CreateIndex}{\param{const wxString &}{idxName}, \param{bool }{unique},
+\func{bool}{CreateIndex}{\param{const wxString \&}{idxName}, \param{bool }{unique},
\param{UWORD }{noIdxCols}, \param{wxDbIdxDef *}{pIdxDefs},
\param{bool }{attemptDrop=TRUE}}
\membersection{wxDbTable::DeleteWhere}\label{wxdbtabledeletewhere}
-\func{bool}{DeleteWhere}{\param{const wxString &}{pWhereClause}}
+\func{bool}{DeleteWhere}{\param{const wxString \&}{pWhereClause}}
Deletes all rows from the table which match the criteria specified in the
WHERE clause that is passed in.
\membersection{wxDbTable::DropIndex}\label{wxdbtabledropindex}
-\func{bool}{DropIndex}{\param{const wxString &}{idxName}}
+\func{bool}{DropIndex}{\param{const wxString \&}{idxName}}
Allows an index on the associated table to be dropped (deleted) if the user
login has sufficient privileges to do so.
\membersection{wxDbTable::From}\label{wxdbtablefrom}
-\func{const wxString &}{From}{}
+\func{const wxString \&}{From}{}
-\func{void}{From}{\param{const wxString &}{From}}
+\func{void}{From}{\param{const wxString \&}{From}}
Accessor function for the private class member wxDbTable::from. Can be used
as a synonym for \helpref{wxDbTable::GetFromClause}{wxdbtablegetfromclause}
\membersection{wxDbTable::GetFromClause}\label{wxdbtablegetfromclause}
-\func{const wxString &}{GetFromClause}{}
+\func{const wxString \&}{GetFromClause}{}
Accessor function that returns the current FROM setting assigned with the
\helpref{wxDbTable::SetFromClause}{wxdbtablesetfromclause}.
\membersection{wxDbTable::GetOrderByClause}\label{wxdbtablegetorderbyclause}
-\func{const wxString &}{GetOrderByClause}{}
+\func{const wxString \&}{GetOrderByClause}{}
Accessor function that returns the current ORDER BY setting assigned with
the \helpref{wxDbTable::SetOrderByClause}{wxdbtablesetorderbyclause}.
\membersection{wxDbTable::GetQueryTableName}\label{wxdbtablegetquerytablename}
-\func{const wxString &}{GetQueryTableName}{}
+\func{const wxString \&}{GetQueryTableName}{}
Accessor function that returns the name of the table/view that was indicated
as being the table/view to query against when this wxDbTable instance was
\membersection{wxDbTable::GetTableName}\label{wxdbtablegettablename}
-\func{const wxString &}{GetTableName}{}
+\func{const wxString \&}{GetTableName}{}
Accessor function that returns the name of the table that was indicated
as being the table that this wxDbTable instance was associated with.
\membersection{wxDbTable::GetTablePath}\label{wxdbtablegettablepath}
-\func{const wxString &}{GetTablePath}{}
+\func{const wxString \&}{GetTablePath}{}
Accessor function that returns the path to the data table that was indicated
during creation of this wxDbTable instance.
\membersection{wxDbTable::GetWhereClause}\label{wxdbtablegetwhereclause}
-\func{const wxString &}{GetWhereClause}{}
+\func{const wxString \&}{GetWhereClause}{}
Accessor function that returns the current WHERE setting assigned with the
\helpref{wxDbTable::SetWhereClause}{wxdbtablesetwhereclause}
\membersection{wxDbTable::OrderBy}\label{wxdbtableorderby}
-\func{const wxString &}{OrderBy}{}
+\func{const wxString \&}{OrderBy}{}
-\func{void}{OrderBy}{\param{const wxString &}{OrderBy}}
+\func{void}{OrderBy}{\param{const wxString \&}{OrderBy}}
Accessor function for the private class member wxDbTable::orderBy. Can be
used as a synonym for
\membersection{wxDbTable::QueryBySqlStmt}\label{wxdbtablequerybysqlstmt}
-\func{bool}{QueryBySqlStmt}{\param{const wxString &}{pSqlStmt}}
+\func{bool}{QueryBySqlStmt}{\param{const wxString \&}{pSqlStmt}}
Performs a query against the datasource by accepting and passing verbatim the
SQL SELECT statement passed to the function.
\membersection{wxDbTable::SetColDefs}\label{wxdbtablesetcoldefs}
-\func{void}{SetColDefs}{\param{UWORD }{index}, \param{const wxString &}{fieldName},
+\func{void}{SetColDefs}{\param{UWORD }{index}, \param{const wxString \&}{fieldName},
\param{int }{dataType}, \param{void *}{pData}, \param{SWORD }{cType},
\param{int }{size}, \param{bool }{keyField = FALSE}, \param{bool }{upd = TRUE},
\param{bool }{insAllow = TRUE}, \param{bool }{derivedCol = FALSE}}
\membersection{wxDbTable::SetFromClause}\label{wxdbtablesetfromclause}
-\func{void}{SetFromClause}{\param{const wxString &}{From}}
+\func{void}{SetFromClause}{\param{const wxString \&}{From}}
Accessor function for setting the private class member wxDbTable::from
that indicates what other tables should be outer joined with the wxDbTable's
\func{bool}{SetColNull}{\param{UWORD }{colNo}, \param{bool }{set=TRUE}}
-\func{bool}{SetColNull}{\param{const wxString &}{colName},
+\func{bool}{SetColNull}{\param{const wxString \&}{colName},
\param{bool }{set=TRUE}}
Both forms of this function allow a member variable representing a column
\membersection{wxDbTable::SetOrderByClause}\label{wxdbtablesetorderbyclause}
-\func{void}{SetOrderByClause}{\param{const wxString &}{OrderBy}}
+\func{void}{SetOrderByClause}{\param{const wxString \&}{OrderBy}}
Accessor function for setting the private class member wxDbTable::orderBy
which determines sequence/ordering of the rows returned in the result set
\membersection{wxDbTable::SetWhereClause}\label{wxdbtablesetwhereclause}
-\func{void}{SetWhereClause}{\param{const wxString &}{Where}}
+\func{void}{SetWhereClause}{\param{const wxString \&}{Where}}
Accessor function for setting the private class member wxDbTable::where
that determines which rows are returned in the result set by the datasource.
\func{bool }{Update}{\void}
-\func{bool }{Update}{\param{const wxString &}{pSqlStmt}}
+\func{bool }{Update}{\param{const wxString \&}{pSqlStmt}}
The first form of this function will update the row that the current cursor
is currently positioned at with the values in the memory variables that
\membersection{wxDbTable::UpdateWhere}\label{wxdbtableupdatewhere}
-\func{bool}{UpdateWhere}{\param{const wxString &}{pWhereClause}}
+\func{bool}{UpdateWhere}{\param{const wxString \&}{pWhereClause}}
Performs updates to the base table of the wxDbTable object, updating only the
rows which match the criteria specified in the {\it pWhereClause}.
\membersection{wxDbTable::Where}\label{wxdbtablewhere}
-\func{const wxString &}{Where}{}
+\func{const wxString \&}{Where}{}
-\func{void}{Where}{\param{const wxString& }{Where}}
+\func{void}{Where}{\param{const wxString\& }{Where}}
Accessor function for the private class member wxDbTable::where. Can be used
as a synonym for \helpref{wxDbTable::GetWhereClause}{wxdbtablegetwhereclause}
\membersection{wxDir::HasFiles}\label{wxdirhasfiles}
-\func{bool}{HasFiles}{\param{const wxString& }{filespec = wxEmptyString}}
+\func{bool}{HasFiles}{\param{const wxString\& }{filespec = wxEmptyString}}
Returns {\tt TRUE} if the directory contains any files matching the given
{\it filespec}. If {\it filespec} is empty, look for any files at all. In any
\membersection{wxDir::HasSubDirs}\label{wxdirhassubdirs}
-\func{bool}{HasSubDirs}{\param{const wxString& }{dirspec = wxEmptyString}}
+\func{bool}{HasSubDirs}{\param{const wxString\& }{dirspec = wxEmptyString}}
Returns {\tt TRUE} if the directory contains any subdirectories (if a non
empty {\it filespec} is given, only check for directories matching it).
\membersection{wxDir::Traverse}\label{wxdirtraverse}
-\func{size\_t}{Traverse}{\param{wxDirTraverser& }{sink}, \param{const wxString& }{filespec = wxEmptyString}, \param{int }{flags = wxDIR\_DEFAULT}}
+\func{size\_t}{Traverse}{\param{wxDirTraverser\& }{sink}, \param{const wxString\& }{filespec = wxEmptyString}, \param{int }{flags = wxDIR\_DEFAULT}}
Enumerate all files and directories under the given directory recursively
calling the element of the provided \helpref{wxDirTraverser}{wxdirtraverser}
\membersection{wxDir::GetAllFiles}\label{wxdirgetallfiles}
-\func{static size\_t}{GetAllFiles}{\param{const wxString& }{dirname}, \param{wxArrayString *}{files}, \param{const wxString& }{filespec = wxEmptyString}, \param{int }{flags = wxDIR\_DEFAULT}}
+\func{static size\_t}{GetAllFiles}{\param{const wxString\& }{dirname}, \param{wxArrayString *}{files}, \param{const wxString\& }{filespec = wxEmptyString}, \param{int }{flags = wxDIR\_DEFAULT}}
The function appends the names of all the files under directory {\it dirname}
to the array {\it files} (note that its old contents is preserved). Only files
\membersection{wxDirTraverser::OnFile}\label{wxdirtraverseronfile}
-\func{virtual wxDirTraverseResult}{OnFile}{\param{const wxString& }{filename}}
+\func{virtual wxDirTraverseResult}{OnFile}{\param{const wxString\& }{filename}}
This function is called for each file. It may return {\tt wxDIR\_STOP} to abort
traversing (for example, if the file being searched is found) or
\membersection{wxDirTraverser::OnDir}\label{wxdirtraverserondir}
-\func{virtual wxDirTraverseResult}{OnDir}{\param{const wxString& }{dirname}}
+\func{virtual wxDirTraverseResult}{OnDir}{\param{const wxString\& }{dirname}}
This function is called for each directory. It may return {\tt wxSIR\_STOP}
to abort traversing completely, {\tt wxDIR\_IGNORE} to skip this directory but
\member{wxString}{m\_fileFilter}
-The file filter (such as \tt{*.txt}) to be used in file selector dialogs.
+The file filter (such as {\tt *.txt}) to be used in file selector dialogs.
\membersection{wxDocTemplate::m\_flags}
{\it descr} is a short description of what the template is for. This string will be displayed in the
file filter list of Windows file selectors.
-{\it filter} is an appropriate file filter such as \tt{*.txt}.
+{\it filter} is an appropriate file filter such as {\tt *.txt}.
{\it dir} is the default directory to use for file selectors.
Default constructor.
\func{}{wxDragImage}{\param{const wxBitmap\& }{image}, \param{const wxCursor\& }{cursor = wxNullCursor},
- \param{const wxPoint& }{cursorHotspot = wxPoint(0, 0)}}
+ \param{const wxPoint\& }{cursorHotspot = wxPoint(0, 0)}}
Constructs a drag image from a bitmap and optional cursor.
\func{}{wxDragImage}{\param{const wxIcon\& }{image}, \param{const wxCursor\& }{cursor = wxNullCursor},
- \param{const wxPoint& }{cursorHotspot = wxPoint(0, 0)}}
+ \param{const wxPoint\& }{cursorHotspot = wxPoint(0, 0)}}
Constructs a drag image from an icon and optional cursor.
\pythonnote{This constructor is called wxDragIcon in wxPython.}
\func{}{wxDragImage}{\param{const wxString\& }{text}, \param{const wxCursor\& }{cursor = wxNullCursor},
- \param{const wxPoint& }{cursorHotspot = wxPoint(0, 0)}}
+ \param{const wxPoint\& }{cursorHotspot = wxPoint(0, 0)}}
Constructs a drag image from a text string and optional cursor.
\pythonnote{This constructor is called wxDragListItem in wxPython.}
\func{}{wxDragImage}{\param{const wxCursor\& }{cursor = wxNullCursor},
- \param{const wxPoint& }{cursorHotspot = wxPoint(0, 0)}}
+ \param{const wxPoint\& }{cursorHotspot = wxPoint(0, 0)}}
Constructs a drag image an optional cursor. This constructor is only available for
wxGenericDragImage, and can be used when the application
\wxheading{Include files}
+\begin{verbatim}
#include <wx/fdrepdlg.h>
+\end{verbatim}
\wxheading{Derived from}
\wxheading{Include files}
+\begin{verbatim}
#include <wx/fdrepdlg.h>
+\end{verbatim}
\wxheading{Derived from}
\membersection{wxFFile::Write}\label{wxffilewrites}
-\func{bool}{Write}{\param{const wxString\& }{s}, \param{wxMBConv&}{ conv = wxConvLibc}}
+\func{bool}{Write}{\param{const wxString\& }{s}, \param{wxMBConv\&}{ conv = wxConvLibc}}
Writes the contents of the string to the file, returns TRUE on success.
\membersection{wxFile::Write}\label{wxfilewrites}
-\func{bool}{Write}{\param{const wxString\& }{s}, \param{wxMBConv&}{ conv = wxConvLibc}}
+\func{bool}{Write}{\param{const wxString\& }{s}, \param{wxMBConv\&}{ conv = wxConvLibc}}
Writes the contents of the string to the file, returns TRUE on success.
Get the string containing all the path separators for this format. For all
formats but {\tt wxPATH\_DOS} this string contains only one character but for
-DOS and Windows both {\tt '/'} and {\tt '\backslash'} may be used as
+DOS and Windows both {\tt '/'} and {\tt '\textbackslash'} may be used as
separators.
\wxheading{See also}
\func{bool}{wxResourceAddIdentifier}{\param{const wxString\& }{name}, \param{int }{value}}
Used for associating a name with an integer identifier (equivalent to dynamically\rtfsp
-\tt{#}defining a name to an integer). Unlikely to be used by an application except
+{\tt\#}defining a name to an integer). Unlikely to be used by an application except
perhaps for implementing resource functionality for interpreted languages.
\membersection{::wxResourceClear}\label{wxresourceclear}
\func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{char **}{xpm\_data}}
-Makes \tt{#}included XBM or XPM bitmap data known to the wxWindows resource system.
+Makes {\tt\#}included XBM or XPM bitmap data known to the wxWindows resource system.
This is required if other resources will use the bitmap data, since otherwise there
is no connection between names used in resources, and the global bitmap data.
The size parameter is just an hint, the table will resize automatically
to preserve performance.
-\func{}{wxHashMap}{\param{const wxHashMap&}{ map}}
+\func{}{wxHashMap}{\param{const wxHashMap\&}{ map}}
Copy constructor.
\membersection{wxHashMap::count}
-\constfunc{size\_type}{count}{\param{const key\_type&}{ key}}
+\constfunc{size\_type}{count}{\param{const key\_type\&}{ key}}
Counts the number of elements with the given key present in the map.
This function can actually return 0 or 1.
\membersection{wxHashMap::erase}
-\func{size\_type}{erase}{\param{const key\_type&}{ key}}
+\func{size\_type}{erase}{\param{const key\_type\&}{ key}}
Erases the element with the given key, and returns the number of element
erased ( either 0 or 1 ).
\membersection{wxHashMap::find}
-\func{iterator}{find}{\param{const key\_type&}{ key}}
+\func{iterator}{find}{\param{const key\_type\&}{ key}}
-\constfunc{const\_iterator}{find}{\param{const key\_type&}{ key}}
+\constfunc{const\_iterator}{find}{\param{const key\_type\&}{ key}}
If an element with the given key is present, the functions returns
an iterator pointing at that element, otherwise an invalid iterator
\membersection{wxHashMap::insert}
-\func{void}{insert}{\param{const value\_type&}{ v}}
+\func{void}{insert}{\param{const value\_type\&}{ v}}
Inserts the given value in the hash map.
\membersection{wxHashMap::operator[]}
-\func{mapped\_type&}{operator[]}{\param{const key\_type&}{ key}}
+\func{mapped\_type\&}{operator[]}{\param{const key\_type\&}{ key}}
Use it as an array subscript. The only difference is that if the
given key is not present in the hash map, an element with the
\wxheading{Contents file (.hhc)}
Contents file has HTML syntax and it can be parsed by regular HTML parser. It contains exactly one list
-(\tt{<ul>}....\tt{</ul>} statement):
+({\tt <ul>}....{\tt </ul>} statement):
\begin{verbatim}
<ul>
contents, {\it filename.htm} is HTML page name (relative to .hhp file) and {\it numeric\_id} is optional
- it is used only when you use \helpref{wxHtmlHelpController::Display(int)}{wxhtmlhelpcontrollerdisplay}
-Items in the list may be nested - one
\tt{<li>} statement may contain a \tt{<ul>} sub-statement:
+Items in the list may be nested - one
{\tt <li>} statement may contain a {\tt <ul>} sub-statement:
\begin{verbatim}
<ul>
which should only be used in advanced applications.
{\bf NB:} Currently the raw key codes are not supported by all ports, use
-{\tt #ifdef wxHAS\_RAW\_KEY\_CODES} to determine if this feature is available.
+{\tt\#ifdef wxHAS\_RAW\_KEY\_CODES} to determine if this feature is available.
\membersection{wxKeyEvent::GetRawKeyFlags}
platform-dependent and should only be used in advanced applications.
{\bf NB:} Currently the raw key flags are not supported by all ports, use
-{\tt #ifdef wxHAS\_RAW\_KEY\_CODES} to determine if this feature is available.
+{\tt \#ifdef wxHAS\_RAW\_KEY\_CODES} to determine if this feature is available.
\membersection{wxKeyEvent::GetX}
\definecolour{white}{255}{255}{255}%
%
\input psbox.tex
+\input ltx.tex
% Remove this for processing with dvi2ps instead of dvips
%\special{!/@scaleunit 1 def}
\parskip=10pt
\winhelponly{
\chapter{wxWindows class library reference}\label{winhelpcontents}
-\center{
+\centerline{
%\image{}{wxwin.wmf}
}%
Note that it is probably impossible to have a client window that scrolls as well as painting
a bitmap or pattern, since in {\bf OnScroll}, the scrollbar positions always return zero.
-(Solutions to: \tt{julian.smart@btopenworld.com}).
+(Solutions to: {\tt julian.smart@btopenworld.com}).
\wxheading{See also}
automatically unchecked.
{\bf NB:} Currently only implemented under Windows and GTK, use
-{\tt #if wxHAS\_RADIO\_MENU\_ITEMS} to test for availability of this feature.
+{\tt\#if wxHAS\_RADIO\_MENU\_ITEMS} to test for availability of this feature.
\wxheading{See also}
Flags for regex matching to be used with \helpref{Matches()}{wxregexmatches}.
These flags are mainly useful when doing several matches in a long string
-to prevent erroneous matches for {\tt '^'} and {\tt '\$'}:
+to prevent erroneous matches for {\tt '\textasciicircum'} and {\tt '\$'}:
\begin{verbatim}
enum
Here is what can be done:
\begin{twocollist}\itemsep=0pt
-\item{{\bf Addition}}{a wxTimeSpan or wxDateSpan can be added to wxDateTime
+\twocolitem{{\bf Addition}}{a wxTimeSpan or wxDateSpan can be added to wxDateTime
resulting in a new wxDateTime object and also 2 objects of the same span class
can be added together giving another object of the smae class.}
-\item{{\bf Substraction}}{the same types of operations as above are
+\twocolitem{{\bf Substraction}}{the same types of operations as above are
allowed and, additionally, a difference between two wxDateTime objects can be
taken and this will yield wxTimeSpan.}
-\item{{\bf Multiplication}}{a wxTimeSpan or wxDateSpan object can be
+\twocolitem{{\bf Multiplication}}{a wxTimeSpan or wxDateSpan object can be
multiplied by an integer number resulting in an object of the same type.}
-\item{{\bf Unary minus}}{a wxTimeSpan or wxDateSpan object may finally be
+\twocolitem{{\bf Unary minus}}{a wxTimeSpan or wxDateSpan object may finally be
negated giving an interval of the same magnitude but of opposite time
direction.}
\end{twocollist}
classes names and functions with a wxDb preface. Because this renaming would
affect applications written using the v2.0 names, this compile-time directive
was added to allow those programs written for v2.0 to still compile using the
-old naming conventions. These deprecated names are all #define'd to their
+old naming conventions. These deprecated names are all {\tt\#}define'd to their
corresponding new function names at the end of the db.cpp/dbtable.cpp source
files. These deprecated class/function names should not be used in future
development, as at some point in the future they will be removed. The default
snippets of code are shown to show the syntax of performing the step. A
complete code snippet is provided at the end of this overview that shows a
complete working flow of all these steps (see
-\helpref{wxODBC - Sample Code #1}{wxodbcsamplecode1}).
+\helpref{wxODBC - Sample Code {\tt\#}1}{wxodbcsamplecode1}).
{\bf Define datasource connection information}
hasn't been tested extensively. It might work for you or it might not: please
report the bugs/problems you have encountered in the latter case.
-\subsection{wxODBC - Sample Code #1}\label{wxodbcsamplecode1}
+\subsection{wxODBC - Sample Code {\tt\#}1}\label{wxodbcsamplecode1}
Simplest example of establishing/opening a connection to an ODBC datasource,
binding variables to the columns for read/write usage, opening an
Examples:
-\tt{SELECT * FROM Book}
+{\tt SELECT * FROM Book}
Selects all rows and columns from table Book.
-\tt{SELECT Title, RetailPriceAmount FROM Book WHERE RetailPriceAmount > 20.0}
+{\tt SELECT Title, RetailPriceAmount FROM Book WHERE RetailPriceAmount > 20.0}
Selects columns Title and RetailPriceAmount from table Book, returning only
the rows that match the WHERE clause.
-\tt{SELECT * FROM Book WHERE CatCode = 'LL' OR CatCode = 'RR'}
+{\tt SELECT * FROM Book WHERE CatCode = 'LL' OR CatCode = 'RR'}
Selects all columns from table Book, returning only
the rows that match the WHERE clause.
-\tt{SELECT * FROM Book WHERE CatCode IS NULL}
+{\tt SELECT * FROM Book WHERE CatCode IS NULL}
Selects all columns from table Book, returning only rows where the CatCode column
is NULL.
-\tt{SELECT * FROM Book ORDER BY Title}
+{\tt SELECT * FROM Book ORDER BY Title}
Selects all columns from table Book, ordering by Title, in ascending order. To specify
descending order, add DESC after the ORDER BY Title clause.
-\tt{SELECT Title FROM Book WHERE RetailPriceAmount >= 20.0 AND RetailPriceAmount <= 35.0}
+{\tt SELECT Title FROM Book WHERE RetailPriceAmount >= 20.0 AND RetailPriceAmount <= 35.0}
Selects records where RetailPriceAmount conforms to the WHERE expression.
Example:
-\tt{UPDATE Incident SET X = 123 WHERE ASSET = 'BD34'}
+{\tt UPDATE Incident SET X = 123 WHERE ASSET = 'BD34'}
This example sets a field in column `X' to the number 123, for the record
where the column ASSET has the value `BD34'.
\membersection{wxTempFile::Write}\label{wxtempfilewrites}
-\func{bool}{Write}{\param{const wxString\& }{str}, \param{wxMBConv&}{ conv = wxConvLibc}}
+\func{bool}{Write}{\param{const wxString\& }{str}, \param{wxMBConv\&}{ conv = wxConvLibc}}
Write to the file, return {\tt TRUE} on success, {\tt FALSE} on failure.
; Finally, a way to specify face names
htmlFaceName = "Arial, Lucida, Helvetica"
+\textasciitilde [0]{{\tt\~}}
+\textasciicircum [0]{{\tt\^}}
+\textbackslash [0]{{\tt$\backslash$}}
+\gifsep [0]{\par}
+ignoreInput = "ltx.tex"
+htmlStylesheet = "wx.css"
+
;\overview [2] {\rtfonly{See also }\settransparency{on}\sethotspotcolour{off}\sethotspotunderline{on}\winhelponly{\image{}{books.bmp}\settransparency{off}}
;\htmlonly{\image{}{books.gif}}\helpref{#1}{#2}
;\sethotspotcolour{on}\sethotspotunderline{on}}
\membersection{wxTextFile::Open}\label{wxtextfileopen}
-\constfunc{bool}{Open}{\param{wxMBConv&}{ conv = wxConvLibc}}
+\constfunc{bool}{Open}{\param{wxMBConv\&}{ conv = wxConvLibc}}
-\constfunc{bool}{Open}{\param{const wxString\& }{strFile}, \param{wxMBConv&}{ conv = wxConvLibc}}
+\constfunc{bool}{Open}{\param{const wxString\& }{strFile}, \param{wxMBConv\&}{ conv = wxConvLibc}}
Open() opens the file with the given name or the name which was given in the
\helpref{constructor}{wxtextfilector} and also loads file in memory on
\membersection{wxTextFile::Write}\label{wxtextfilewrite}
-\constfunc{bool}{Write}{\param{wxTextFileType }{typeNew = wxTextFileType\_None}, \param{wxMBConv&}{ conv = wxConvLibc}}
+\constfunc{bool}{Write}{\param{wxTextFileType }{typeNew = wxTextFileType\_None}, \param{wxMBConv\&}{ conv = wxConvLibc}}
Change the file on disk. The {\it typeNew} parameter allows you to change the
file format (default argument means "don't change type") and may be used to
both selected and unselected items.
\pythonnote{The second form of this method is called
-\tt{InsertItemBefore} in wxPython.}
+{\tt InsertItemBefore} in wxPython.}
\membersection{wxTreeCtrl::IsBold}\label{wxtreectrlisbold}
don't have any natural width or height and thus require an explicit size. Some controls
can calculate their height, but not their width (e.g. a single line text control):
-\center{
-\image{}{sizer03.gif}
+\newcommand{\myimage}[1]{\mbox{\image{0cm;0cm}{#1}}}
-\image{}{sizer04.gif}
-
-\image{}{sizer05.gif}
-}
+\begin{center}
+\myimage{sizer03.eps}\gifsep
+\myimage{sizer04.eps}\gifsep
+\myimage{sizer05.eps}
+\end{center}
{\bf A border:} The border is just empty space and is used to separate dialog items
in a dialog. This border can either be all around, or at any combination of sides
explicitly, typically 5 points. The following samples show dialogs with only one
dialog item (a button) and a border of 0, 5, and 10 pixels around the button:
-\center{
-\image{}{sizer00.gif}
-
-\image{}{sizer01.gif}
-
-\image{}{sizer02.gif}
-}
+\begin{center}
+\myimage{sizer00.eps}\gifsep
+\myimage{sizer01.eps}\gifsep
+\myimage{sizer02.eps}
+\end{center}
{\bf An alignment:} Often, a dialog item is given more space than its minimal size
plus its border. Depending on what flags are used for the respective dialog
sample shows a listbox and three buttons in a horizontal box sizer; one button
is centred, one is aligned at the top, one is aligned at the bottom:
-\center{
-\image{}{sizer06.gif}
-}
+\begin{center}
+\myimage{sizer06.eps}
+\end{center}
{\bf A stretch factor:} If a sizer contains more than one child and it is offered
more space than its children and their borders need, the question arises how to
whereas the other two buttons have a stretch factor of zero and keep their
initial width:
-\center{
-\image{}{sizer07.gif}
-}
+\begin{center}
+\myimage{sizer07.eps}
+\end{center}
Within wxDesigner, this stretch factor gets set from the {\it Option} menu.
The following sample shows the same dialog as in the last sample,
only the box sizer is a vertical box sizer now:
-\center{
-\image{}{sizer08.gif}
-}
+\begin{center}
+\myimage{sizer08.eps}
+\end{center}
\wxheading{wxStaticBoxSizer}
\helpref{wxStaticBoxSixer}{wxstaticboxsizer} is the same as a wxBoxSizer, but surrounded by a
static box. Here is a sample:
-\center{
-\image{}{sizer09.gif}
-}
+\begin{center}
+\myimage{sizer09.eps}
+\end{center}
\wxheading{wxGridSizer}
of columns or the number or rows is fixed and the grid sizer will grow
in the respectively other orientation if new children are added:
-\center{
-\image{}{sizer10.gif}
-}
+\begin{center}
+\myimage{sizer10.eps}
+\end{center}
For programming information, see \helpref{wxGridSizer}{wxgridsizer}.
a size different from that which it requested. The following sample shows
the same dialog as the one above, but using a flex grid sizer:
-\center{
-\image{}{sizer11.gif}
-}
+\begin{center}
+\myimage{sizer11.eps}
+\end{center}
\wxheading{wxNotebookSizer}
\item call {\tt wxXmlResource::Get()->InitAllHandlers()} from your wxApp::OnInit function,
and then call {\tt wxXmlResource::Get()->Load("myfile.xrc")} to load the resource file;
\item to create a dialog from a resource, create it using the default constructor, and then
-load using for example {\tt wxXmlResource::Get()->LoadDialog(&dlg, this, "dlg1");}
+load using for example {\tt wxXmlResource::Get()->LoadDialog(\&dlg, this, "dlg1");}
\item set up event tables as usual but use the {\tt XRCID(str)} macro to translate from XRC string names
to a suitable integer identifier, for example {\tt EVT\_MENU(XRCID("quit"), MyFrame::OnQuit)}.
\end{itemize}
To create an XRC file, use one of the following methods.
-\begin{itemize}\itemsep=0
+\begin{itemize}\itemsep=0pt
\item Create the file by hand;
\item use \urlref{wxDesigner}{http://www.roebling.de}, a commercial dialog designer/RAD tool;
\item use \urlref{XRCed}{http://www.mema.ucl.ac.be/~rolinsky/xrced/}, a wxPython-based
To compile binary resource files, use the command-line wxrc utility. It takes a single file parameter (the
input XRC file) and the following switches and options.
-\begin{itemize}\itemsep=0
+\begin{itemize}\itemsep=0pt
\item -h (--help): show a help message
\item -v (--verbose): show verbose logging information
\item -c (--cpp-code): write C++ source rather than a RSC file
a wxEVT\_HELP event if the user clicked on an application window.
This style cannot be used together with wxMAXIMIZE\_BOX or wxMINIMIZE\_BOX, so
you should use the style of
-{\tt wxDEFAULT\_FRAME\_STYLE & ~(wxMINIMIZE\_BOX | wxMAXIMIZE\_BOX)} for the
+{\tt wxDEFAULT\_FRAME\_STYLE \& \textasciitilde(wxMINIMIZE\_BOX | wxMAXIMIZE\_BOX)} for the
frames having this style (the dialogs don't have minimize nor maximize box by
default)}
\end{twocollist}
\wxheading{Data structures}
-\begin{enumerate}
+\begin{verbatim}
enum wxXmlResourceFlags
{
wxXRC\_USE\_LOCALE = 1,
wxXRC\_NO\_SUBCLASSING = 2
};
-\end{enumerate}
+\end{verbatim}
\latexignore{\rtfignore{\wxheading{Members}}}
\constfunc{long}{GetVersion}{\void}
-Returns version information (a.b.c.d = d+ 256*c + 256\tt{^}2*b + 256\tt{^}3*a).
+Returns version information (a.b.c.d = d+ 256*c + 256\textasciicircum2*b + 256\textasciitilde3*a).
\membersection{wxXmlResource::GetXRCID}\label{wxxmlresourcegetxmlid}
\begin{itemize}\itemsep=0pt
\item replaces $\backslash$n, $\backslash$r, $\backslash$t by respective characters (according to C syntax)
-\item replaces \tt{\$} by \tt{\&} and \tt{\$\$} by \tt{\$} (needed for \tt{\_File} to \tt{\&File}
+\item replaces {\tt\$} by {\tt\&} and {\tt\$\$} by {\tt\$} (needed for {\tt\_File} to {\tt\&File}
translation because of XML syntax)
\item calls wxGetTranslations (unless disabled in wxXmlResource)
\end{itemize}
projects / wxWidgets.git / commitdiff
