diff --git a/docs/latex/wx/body.tex b/docs/latex/wx/body.tex index 64cc7b1230..5002bcdeca 100644 --- a/docs/latex/wx/body.tex +++ b/docs/latex/wx/body.tex @@ -511,7 +511,7 @@ Some are under the 'contrib' hierarchy which mirrors the 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}. @@ -522,7 +522,7 @@ Helpview is a program for displaying wxWindows HTML 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 @@ -530,7 +530,7 @@ 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 @@ -541,54 +541,54 @@ This is a good way to start a reference for a set of classes. 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} diff --git a/docs/latex/wx/calctrl.tex b/docs/latex/wx/calctrl.tex index c0041ca7d8..26e40bade5 100644 --- a/docs/latex/wx/calctrl.tex +++ b/docs/latex/wx/calctrl.tex @@ -438,7 +438,7 @@ The wxCalendarEvent class is used together with \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. diff --git a/docs/latex/wx/config.tex b/docs/latex/wx/config.tex index 920d830406..d8e9f3b302 100644 --- a/docs/latex/wx/config.tex +++ b/docs/latex/wx/config.tex @@ -257,7 +257,7 @@ Currently, only two types of data are supported: string and long (but it might 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. @@ -309,8 +309,8 @@ config file: 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 diff --git a/docs/latex/wx/datetime.tex b/docs/latex/wx/datetime.tex index 00823a44b0..ff08bc8e67 100644 --- a/docs/latex/wx/datetime.tex +++ b/docs/latex/wx/datetime.tex @@ -659,7 +659,7 @@ Same as \helpref{Set}{wxdatetimesetdate} \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. @@ -885,25 +885,25 @@ calculations make sense for it). \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, @@ -913,7 +913,7 @@ 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. @@ -924,13 +924,13 @@ 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). diff --git a/docs/latex/wx/db.tex b/docs/latex/wx/db.tex index 65d6f3e267..c608f783a6 100644 --- a/docs/latex/wx/db.tex +++ b/docs/latex/wx/db.tex @@ -357,7 +357,7 @@ Writes a message to the wxLog window (stdout usually) when an internal 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} @@ -386,7 +386,7 @@ available through the ODBC driver manager on the current workstation. 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. @@ -424,7 +424,7 @@ be created and opened before any database activity can occur. \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 @@ -539,8 +539,8 @@ that leave the cursors open after a transaction.} \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 @@ -609,8 +609,7 @@ datasource is not recognized, a value of 'dbmsUNIDENTIFIED' is returned. \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 @@ -697,7 +696,7 @@ one in context and displaying the ones you choose. \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'. @@ -712,7 +711,7 @@ If the view does not exist, this function will return TRUE. Note that views are \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. @@ -770,7 +769,7 @@ The returned catalog will only contain catalog entries for tables to which the u \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} @@ -794,7 +793,7 @@ occurs retrieving the number of columns, this function will return a -1. \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}} @@ -923,7 +922,7 @@ Returns the name of the database engine. \membersection{wxDb::GetDatasourceName}\label{wxdbgetdatasourcename} -\func{const wxString &}{GetDatasourceName}{\void} +\func{const wxString \&}{GetDatasourceName}{\void} Returns the ODBC datasource name. @@ -947,7 +946,7 @@ Returns the ODBC statement handle associated with this database connection. \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. @@ -1010,7 +1009,7 @@ hstmt argument.} \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. @@ -1025,7 +1024,7 @@ connection. \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. @@ -1033,8 +1032,8 @@ 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. @@ -1137,7 +1136,7 @@ partial failures to open a connection instance. \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.} @@ -1158,8 +1157,8 @@ text into the SQL log file. \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. @@ -1195,8 +1194,8 @@ used for behavioral descriptions. \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}} @@ -1331,7 +1330,7 @@ When compiled in release mode (FINAL=1), this setting has no affect. \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} @@ -1394,7 +1393,7 @@ before including the table name in a SQL statement} \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 @@ -1426,9 +1425,9 @@ This function does not indicate whether or not the user has privileges to query \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 @@ -1440,7 +1439,6 @@ at least minimal privileges to the table). {\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. @@ -1462,25 +1460,23 @@ following (or a datasource specific privilege):} \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.} @@ -1502,7 +1498,7 @@ seconds of time difference. \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. @@ -1517,7 +1513,7 @@ Returns the internal class DB\_ERR code. See \helpref{wxDb::DB\_STATUS}{wxdb} d \membersection{wxDb::WriteSqlLog}\label{wxdbwritesqllog} -\func{bool}{WriteSqlLog}{\param{const wxString &}{logMsg}} +\func{bool}{WriteSqlLog}{\param{const wxString \&}{logMsg}} \wxheading{Parameters} @@ -1710,10 +1706,10 @@ functions planned to be added for creating/manipulating datasource definitions. 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. @@ -1900,7 +1896,7 @@ instance. \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. @@ -1910,7 +1906,7 @@ Synonymous with \helpref{wxDbConnectInf::SetPassword}{wxdbconnectinfsetpassword} \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 @@ -1920,7 +1916,7 @@ ODBC Administrator for MS-Access. \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. @@ -1930,14 +1926,14 @@ NOTE: Description is a FUTURE USE item and is unused currently. \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. @@ -1954,7 +1950,7 @@ Accessor function to set the SQL environment handle 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. @@ -1964,14 +1960,14 @@ Synonymous with \helpref{wxDbConnectInf::SetAuthStr}{wxdbconnectinfsetauthstr} \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. @@ -2074,9 +2070,9 @@ with the wxDbTable class. \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. @@ -2110,8 +2106,8 @@ Virtual default destructor. \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. @@ -2139,7 +2135,7 @@ this function. \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 @@ -2174,8 +2170,8 @@ this function. \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. @@ -2214,8 +2210,8 @@ this function. \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' @@ -2379,7 +2375,7 @@ programmer if desired. \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. @@ -2434,7 +2430,7 @@ this function. \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}} @@ -2665,7 +2661,7 @@ of actions that insert/update/delete rows in a table. \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. @@ -2718,7 +2714,7 @@ this function. \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. @@ -2759,9 +2755,9 @@ after executing this function. \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} @@ -2860,7 +2856,7 @@ return FALSE, and the data contained in the bound columns will be undefined. \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}. @@ -2953,7 +2949,7 @@ bound for access by the wxDbTable instance. \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}. @@ -2995,7 +2991,7 @@ return FALSE, and the data contained in the bound columns will be undefined. \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 @@ -3024,7 +3020,7 @@ database documentation to find out which behavior is supported. \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. @@ -3032,7 +3028,7 @@ 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. @@ -3044,7 +3040,7 @@ Currently only applicable to dBase and MS-Access datasources. \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} @@ -3203,9 +3199,9 @@ function can significantly speed up the privileges checks. \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 @@ -3323,7 +3319,7 @@ clauses.} \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. @@ -3562,7 +3558,7 @@ table's columns are refreshed to reflect the current data in the database. \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}} @@ -3689,7 +3685,7 @@ and saving a pointer to that cursor. \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 @@ -3741,7 +3737,7 @@ the datasource knows on which column values the tables should be joined on. \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 @@ -3770,7 +3766,7 @@ value to disk. \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 @@ -3828,7 +3824,7 @@ correctly. \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. @@ -3881,7 +3877,7 @@ Do {\bf not} include the keywords "WHERE" when setting the WHERE clause. \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 @@ -3919,7 +3915,7 @@ this function to commit or rollback the update. \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}. @@ -3945,9 +3941,9 @@ this function to commit or rollback the update(s). \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} diff --git a/docs/latex/wx/dir.tex b/docs/latex/wx/dir.tex index bc33378d33..c4b9c7d374 100644 --- a/docs/latex/wx/dir.tex +++ b/docs/latex/wx/dir.tex @@ -128,7 +128,7 @@ to \helpref{GetFirst}{wxdirgetfirst}. \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 @@ -136,7 +136,7 @@ case, even hidden files are taken into account. \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). @@ -144,7 +144,7 @@ The hidden subdirectories are taken into account as well. \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} @@ -166,7 +166,7 @@ See also: \helpref{GetAllFiles}{wxdirgetallfiles} \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 diff --git a/docs/latex/wx/dirtrav.tex b/docs/latex/wx/dirtrav.tex index 6def4ad3c8..bf7ef9df13 100644 --- a/docs/latex/wx/dirtrav.tex +++ b/docs/latex/wx/dirtrav.tex @@ -73,7 +73,7 @@ enum wxDirTraverseResult \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 @@ -81,7 +81,7 @@ 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 diff --git a/docs/latex/wx/doctempl.tex b/docs/latex/wx/doctempl.tex index a7287f5f26..9cd7334232 100644 --- a/docs/latex/wx/doctempl.tex +++ b/docs/latex/wx/doctempl.tex @@ -57,7 +57,7 @@ A pointer to the document manager for which this template was created. \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} @@ -92,7 +92,7 @@ a wxDocManager instance, and before doing any document or view operations. {\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. diff --git a/docs/latex/wx/dragimag.tex b/docs/latex/wx/dragimag.tex index f71608e08c..72cca31294 100644 --- a/docs/latex/wx/dragimag.tex +++ b/docs/latex/wx/dragimag.tex @@ -46,19 +46,19 @@ Please see {\tt samples/dragimag} for an example. 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. @@ -77,7 +77,7 @@ Constructs a drag image from the text in the given tree control item, and option \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 diff --git a/docs/latex/wx/fdrepdlg.tex b/docs/latex/wx/fdrepdlg.tex index ef44dfb864..5ba747af2f 100644 --- a/docs/latex/wx/fdrepdlg.tex +++ b/docs/latex/wx/fdrepdlg.tex @@ -88,7 +88,9 @@ dialog and calling them has no effect later. \wxheading{Include files} +\begin{verbatim} #include +\end{verbatim} \wxheading{Derived from} @@ -193,7 +195,9 @@ Please see the dialogs sample for example of using it. \wxheading{Include files} +\begin{verbatim} #include +\end{verbatim} \wxheading{Derived from} diff --git a/docs/latex/wx/ffile.tex b/docs/latex/wx/ffile.tex index d3bfa20e35..76422f67ac 100644 --- a/docs/latex/wx/ffile.tex +++ b/docs/latex/wx/ffile.tex @@ -203,7 +203,7 @@ Number of bytes written. \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. diff --git a/docs/latex/wx/file.tex b/docs/latex/wx/file.tex index 4b2160def6..d4c5f0aaa9 100644 --- a/docs/latex/wx/file.tex +++ b/docs/latex/wx/file.tex @@ -291,7 +291,7 @@ the number of bytes actually written \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. diff --git a/docs/latex/wx/filename.tex b/docs/latex/wx/filename.tex index 2093b783a0..50b80ba2ad 100644 --- a/docs/latex/wx/filename.tex +++ b/docs/latex/wx/filename.tex @@ -407,7 +407,7 @@ method. 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} diff --git a/docs/latex/wx/function.tex b/docs/latex/wx/function.tex index 4ba9c2f115..2568e53be0 100644 --- a/docs/latex/wx/function.tex +++ b/docs/latex/wx/function.tex @@ -2781,7 +2781,7 @@ loading from resource data. \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} @@ -2947,7 +2947,7 @@ load an entire {\tt .wxr file} into a string. \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. diff --git a/docs/latex/wx/hashmap.tex b/docs/latex/wx/hashmap.tex index 738ad03c29..bcf6f2f87e 100644 --- a/docs/latex/wx/hashmap.tex +++ b/docs/latex/wx/hashmap.tex @@ -125,7 +125,7 @@ means that you can't use {\tt --it}, {\tt it + 3}, {\tt it1 - it2}. 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. @@ -146,7 +146,7 @@ Removes all elements from the hash map. \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. @@ -168,7 +168,7 @@ Returns an iterator pointing at the one-after-the-last element of the hash map \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 ). @@ -182,9 +182,9 @@ the iterator is no longer valid and must not be used. \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 @@ -192,13 +192,13 @@ is returned ( i.e. hashmap.find( non\_existent\_key ) == hashmap.end() ). \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 diff --git a/docs/latex/wx/htmlhlpf.tex b/docs/latex/wx/htmlhlpf.tex index 9f21cfa295..a3b7e4dc41 100644 --- a/docs/latex/wx/htmlhlpf.tex +++ b/docs/latex/wx/htmlhlpf.tex @@ -39,7 +39,7 @@ with some error. See also \wxheading{Contents file (.hhc)} Contents file has HTML syntax and it can be parsed by regular HTML parser. It contains exactly one list -(\tt{} statement): +({\tt } statement): \begin{verbatim}