Finds the handler with the given name.
-\func{static wxBitmapHandler*}{FindHandler}{\param{const wxString\& }{extension}, \param{long}{ bitmapType}}
+\func{static wxBitmapHandler*}{FindHandler}{\param{const wxString\& }{extension}, \param{wxBitmapType}{ bitmapType}}
Finds the handler associated with the given extension and type.
-\func{static wxBitmapHandler*}{FindHandler}{\param{long }{bitmapType}}
+\func{static wxBitmapHandler*}{FindHandler}{\param{wxBitmapType }{bitmapType}}
Finds the handler associated with the given bitmap type.
\membersection{wxBitmap::LoadFile}\label{wxbitmaploadfile}
-\func{bool}{LoadFile}{\param{const wxString\&}{ name}, \param{long}{ type}}
+\func{bool}{LoadFile}{\param{const wxString\&}{ name}, \param{wxBitmapType}{ type}}
Loads a bitmap from a file or resource.
\membersection{wxBitmap::SaveFile}\label{wxbitmapsavefile}
-\func{bool}{SaveFile}{\param{const wxString\& }{name}, \param{int}{ type}, \param{wxPalette* }{palette = NULL}}
+\func{bool}{SaveFile}{\param{const wxString\& }{name}, \param{wxBitmapType}{ type}, \param{wxPalette* }{palette = NULL}}
Saves a bitmap in the named file.
\twocolitem{\helpref{wxDbColDataPtr}{wxdbcoldataptr}}{}
\twocolitem{\helpref{wxDbColFor}{wxdbcolfor}}{}
\twocolitem{\helpref{wxDbConnectInf}{wxdbconnectinf}}{}
-\twocolitem{\helpref{wxDbIndexDef}{wxdbindexdef}}{}
+\twocolitem{\helpref{wxDbIdxDef}{wxdbidxdef}}{}
\end{twocollist}
{\large {\bf Miscellaneous}}
\membersection{wxCondition::WaitTimeout}\label{wxconditionwaittimeout}
-\func{wxCondError}{Wait}{\param{unsigned long}{ milliseconds}}
+\func{wxCondError}{WaitTimeout}{\param{unsigned long}{ milliseconds}}
Waits until the condition is signalled or the timeout has elapsed.
Accessor function to assign the user ID for this class instance.
-\section{\class{wxDbIndexDef}}\label{wxdbindexdef}
+\section{\class{wxDbIdxDef}}\label{wxdbidxdef}
Used in creation of non-primary indexes. Currently there are no member
functions for this class.
See the \helpref{database classes overview}{odbcoverview} for
an introduction to using the ODBC classes.
+
+\wxheading{Include files}
+
+<wx/db.h>
+
\section{\class{wxDbInf}}\label{wxdbinf}
Contains information regarding the database connection (datasource name,
\begin{itemize}\itemsep=0pt
\item \helpref{wxDbColDef}{wxdbcoldef}
\item \helpref{wxDbColDataPtr}{wxdbcoldataptr}
-\item \helpref{wxDbIndexDef}{wxdbindexdef}
+\item \helpref{wxDbIdxDef}{wxdbidxdef}
\end{itemize}
\wxheading{Constants}
\membersection{wxDbTable::CreateIndex}\label{wxdbtablecreateindex}
\func{bool}{CreateIndex}{\param{const wxString \&}{IndexName}, \param{bool }{unique},
-\param{UWORD }{numIndexColumns}, \param{wxDbIndexDef *}{pIndexDefs},
+\param{UWORD }{numIndexColumns}, \param{wxDbIdxDef *}{pIndexDefs},
\param{bool }{attemptDrop=true}}
This member function allows you to create secondary (non primary) indexes on
space of the datasource.}
\docparam{unique}{Indicates if this index is unique.}
\docparam{numIndexColumns}{Number of columns in the index.}
-\docparam{pIndexDefs}{A pointer to an array \helpref{wxDbIndexDef}{wxdbindexdef} structures. }
+\docparam{pIndexDefs}{A pointer to an array \helpref{wxDbIdxDef}{wxdbidxdef} structures. }
\docparam{attemptDrop}{{\it OPTIONAL}. Indicates if the function should try
to execute a \helpref{wxDbTable::DropIndex}{wxdbtabledropindex} on the index
name provided before trying to create the index name. Default is true.}
number must match the number of columns defined in the 'pIndexDefs' parameter.
The fourth parameter specifies which columns make up the index using the
-\helpref{wxDbIndexDef}{wxdbindexdef} structure. For each column in the index, you must specify two
+\helpref{wxDbIdxDef}{wxdbidxdef} structure. For each column in the index, you must specify two
things, the column name and the sort order (ascending / descending). See
-the example below to see how to build and pass in the \helpref{wxDbIndexDef}{wxdbindexdef} structure.
+the example below to see how to build and pass in the \helpref{wxDbIdxDef}{wxdbidxdef} structure.
The fifth parameter is provided to handle the differences in datasources as
to whether they will automatically overwrite existing indexes with the same
\begin{verbatim}
// Create a secondary index on the PARTS table
- wxDbIndexDef IndexDef[2]; // 2 columns make up the index
+ wxDbIdxDef IndexDef[2]; // 2 columns make up the index
wxStrcpy(IndexDef[0].ColName, "PART_DESC"); // Column 1
IndexDef[0].Ascending = true;
\membersection{wxDocMDIParentFrame::wxDocMDIParentFrame}\label{wxdocmdiparentframector}
-\func{}{wxDocParentFrame}{\param{wxDocManager*}{ manager}, \param{wxFrame *}{parent}, \param{wxWindowID}{ id},
+\func{}{wxDocMDIParentFrame}{\param{wxDocManager*}{ manager}, \param{wxFrame *}{parent}, \param{wxWindowID}{ id},
\param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},
\param{const wxSize\&}{ size = wxDefaultSize},
\param{long}{ style = wxDEFAULT\_FRAME\_STYLE}, \param{const wxString\& }{name = "frame"}}
\param{const bool}{ underline = false}, \param{const wxString\& }{faceName = ""},
\param{wxFontEncoding }{encoding = wxFONTENCODING\_DEFAULT}}
-\func{}{wxFont}{\param{const wxSize\&}{ pixelSize}, \param{wxFontFamily}{ family}, \param{int}{ style}, \param{int}{ weight},
+\func{}{wxFont}{\param{int}{ pixelSize}, \param{int}{ family}, \param{int}{ style}, \param{int}{ weight},
\param{const bool}{ underline = false}, \param{const wxString\& }{faceName = ""},
\param{wxFontEncoding }{encoding = wxFONTENCODING\_DEFAULT}}
Creates an icon from XPM data.
-\func{}{wxIcon}{\param{const wxString\& }{name}, \param{long}{ type},
+\func{}{wxIcon}{\param{const wxString\& }{name}, \param{wxBitmapType}{ type},
\param{int}{ desiredWidth = -1}, \param{int}{ desiredHeight = -1}}
Loads an icon from a file or resource.
\membersection{wxIcon::LoadFile}\label{wxiconloadfile}
-\func{bool}{LoadFile}{\param{const wxString\&}{ name}, \param{long}{ type}}
+\func{bool}{LoadFile}{\param{const wxString\&}{ name}, \param{wxBitmapType}{ type}}
Loads an icon from a file or resource.
\begin{comment}
\membersection{wxIcon::SaveFile}\label{wxiconsavefile}
-\func{bool}{SaveFile}{\param{const wxString\& }{name}, \param{int}{ type}, \param{wxPalette* }{palette = NULL}}
+\func{bool}{SaveFile}{\param{const wxString\& }{name}, \param{wxBitmapType}{ type}, \param{wxPalette* }{palette = NULL}}
Saves an icon in the named file.
\membersection{wxJoystick::GetZMin}\label{wxjoystickgetzmin}
-\constfunc{int}{GetXMin}{\void}
+\constfunc{int}{GetZMin}{\void}
Returns the minimum z position.
\membersection{wxMDIChildFrame::Maximize}\label{wxmdichildframemaximize}
-\func{void}{Maximize}{\void}
+\func{void}{Maximize}{\param{bool}{maximize}}
Maximizes this MDI child frame.
\membersection{wxPalette::GetRGB}\label{wxpalettegetrgb}
-\constfunc{bool}{GetPixel}{\param{int}{ pixel}, \param{const unsigned char* }{red}, \param{const unsigned char* }{green},\rtfsp
+\constfunc{bool}{GetRGB}{\param{int}{ pixel}, \param{const unsigned char* }{red}, \param{const unsigned char* }{green},\rtfsp
\param{const unsigned char* }{blue}}
Returns RGB values for a given palette index.
--- /dev/null
+\section{wxWindows Compile-Time Configuration Options}\label{setup}
+
+
\membersection{wxSizerFlags::Expand}\label{wxsizerflagsexpand}
-\func{wxSizerFlags\& }{Align}{\void}
+\func{wxSizerFlags\& }{Expand}{\void}
Sets the object of the wxSizerFlags to expand to fill as much area as it can.
\latexignore{\rtfignore{\wxheading{Members}}}
+
\membersection{wxTextInputStream::wxTextInputStream}\label{wxtextinputstreamctor}
\func{}{wxTextInputStream}{\param{wxInputStream\&}{ stream}, \param{const wxString\&}{ sep=" $\backslash$t"},
\docparam{conv}{{\it In Unicode build only:} The encoding converter used to convert the bytes in the
underlying input stream to characters.}
+
\membersection{wxTextInputStream::\destruct{wxTextInputStream}}\label{wxtextinputstreamdtor}
\func{}{\destruct{wxTextInputStream}}{\void}
Destroys the wxTextInputStream object.
+
\membersection{wxTextInputStream::Read8}\label{wxtextinputstreamread8}
\func{wxUint8}{Read8}{\param{int}{ base = 10}}
which may have leading zeroes as they can yield unexpected (to the user not
familiar with C) results.
+
\membersection{wxTextInputStream::Read8S}\label{wxtextinputstreamread8s}
\func{wxInt8}{Read8S}{\param{int}{ base = 10}}
See \helpref{wxTextInputStream::Read8}{wxtextinputstreamread8} for the
description of the {\it base} parameter.
+
\membersection{wxTextInputStream::Read16}\label{wxtextinputstreamread16}
\func{wxUint16}{Read16}{\param{int}{ base = 10}}
See \helpref{wxTextInputStream::Read8}{wxtextinputstreamread8} for the
description of the {\it base} parameter.
+
\membersection{wxTextInputStream::Read16S}\label{wxtextinputstreamread16s}
\func{wxInt16}{Read16S}{\param{int}{ base = 10}}
See \helpref{wxTextInputStream::Read8}{wxtextinputstreamread8} for the
description of the {\it base} parameter.
+
\membersection{wxTextInputStream::Read32}\label{wxtextinputstreamread32}
\func{wxUint32}{Read32}{\param{int}{ base = 10}}
See \helpref{wxTextInputStream::Read8}{wxtextinputstreamread8} for the
description of the {\it base} parameter.
+
\membersection{wxTextInputStream::Read32S}\label{wxtextinputstreamread32s}
\func{wxInt32}{Read32S}{\param{int}{ base = 10}}
See \helpref{wxTextInputStream::Read8}{wxtextinputstreamread8} for the
description of the {\it base} parameter.
+
\membersection{wxTextInputStream::GetChar}\label{wxtextinputstreamgetchar}
-\func{wxChar}{wxTextInputStream::GetChar}{\void}
+\func{wxChar}{GetChar}{\void}
Reads a character, returns $0$ if there are no more characters in the stream.
+
\membersection{wxTextInputStream::ReadDouble}\label{wxtextinputstreamreaddouble}
\func{double}{ReadDouble}{\void}
Reads a double (IEEE encoded) from the stream.
+
\membersection{wxTextInputStream::ReadLine}\label{wxtextinputstreamreadline}
-\func{wxString}{wxTextInputStream::ReadLine}{\void}
+\func{wxString}{ReadLine}{\void}
Reads a line from the input stream and returns it (without the end of line
character).
+
\membersection{wxTextInputStream::ReadString}\label{wxtextinputstreamreadstring}
-\func{wxString}{wxTextInputStream::ReadString}{\void}
+\func{wxString}{ReadString}{\void}
{\bf NB:} This method is deprecated, use \helpref{ReadLine}{wxtextinputstreamreadline}
or \helpref{ReadWord}{wxtextinputstreamreadword} instead.
Same as \helpref{ReadLine}{wxtextinputstreamreadline}.
+
\membersection{wxTextInputStream::ReadWord}\label{wxtextinputstreamreadword}
-\func{wxString}{wxTextInputStream::ReadWord}{\void}
+\func{wxString}{ReadWord}{\void}
Reads a word (a sequence of characters until the next separator) from the
input stream.
\helpref{SetStringSeparators}{wxtextinputstreamsetstringseparators}
+
\membersection{wxTextInputStream::SetStringSeparators}\label{wxtextinputstreamsetstringseparators}
\func{void}{SetStringSeparators}{\param{const wxString\& }{sep}}
\latexignore{\rtfignore{\wxheading{Members}}}
+
\membersection{wxTextOutputStream::wxTextOutputStream}\label{wxtextoutputstreamctor}
\func{}{wxTextOutputStream}{\param{wxOutputStream\&}{ stream}, \param{wxEOL}{ mode = wxEOL\_NATIVE}, \param{wxMBConv\&}{ conv = wxConvUTF8}}
\docparam{conv}{{\it In Unicode build only:} The object used to convert
Unicode text into ASCII characters written to the output stream.}
+
\membersection{wxTextOutputStream::\destruct{wxTextOutputStream}}\label{wxtextoutputstreamdtor}
\func{}{\destruct{wxTextOutputStream}}{\void}
Destroys the wxTextOutputStream object.
+
\membersection{wxTextOutputStream::GetMode}\label{wxtextoutputstreamgetmode}
-\func{wxEOL}{wxTextOutputStream::GetMode}{\void}
+\func{wxEOL}{GetMode}{\void}
Returns the end-of-line mode. One of {\bf wxEOL\_DOS}, {\bf wxEOL\_MAC} and {\bf wxEOL\_UNIX}.
+
+\membersection{wxTextOutputStream::PutChar}\label{wxtextoutputstreamputchar}
+
+\func{void}{PutChar}{{\param wxChar }{c}}
+
+Writes a character to the stream.
+
+
\membersection{wxTextOutputStream::SetMode}\label{wxtextoutputstreamsetmode}
-\func{void}{wxTextOutputStream::SetMode}{{\param wxEOL}{ mode = wxEOL\_NATIVE}}
+\func{void}{SetMode}{{\param wxEOL}{ mode = wxEOL\_NATIVE}}
Set the end-of-line mode. One of {\bf wxEOL\_NATIVE}, {\bf wxEOL\_DOS}, {\bf wxEOL\_MAC} and {\bf wxEOL\_UNIX}.
+
\membersection{wxTextOutputStream::Write8}\label{wxtextoutputstreamwrite8}
-\func{void}{wxTextOutputStream::Write8}{{\param wxUint8 }{i8}}
+\func{void}{Write8}{{\param wxUint8 }{i8}}
Writes the single byte {\it i8} to the stream.
-\membersection{wxTextOutputStream::PutChar}\label{wxtextoutputstreamputchar}
-
-\func{void}{wxTextOutputStream::PutChar}{{\param wxChar }{c}}
-
-Writes a character to the stream.
\membersection{wxTextOutputStream::Write16}\label{wxtextoutputstreamwrite16}
-\func{void}{wxTextOutputStream::Write16}{{\param wxUint16 }{i16}}
+\func{void}{Write16}{{\param wxUint16 }{i16}}
Writes the 16 bit integer {\it i16} to the stream.
+
\membersection{wxTextOutputStream::Write32}\label{wxtextoutputstreamwrite32}
-\func{void}{wxTextOutputStream::Write32}{{\param wxUint32 }{i32}}
+\func{void}{Write32}{{\param wxUint32 }{i32}}
Writes the 32 bit integer {\it i32} to the stream.
+
\membersection{wxTextOutputStream::WriteDouble}\label{wxtextoutputstreamwritedouble}
-\func{virtual void}{wxTextOutputStream::WriteDouble}{{\param double }{f}}
+\func{virtual void}{WriteDouble}{{\param double }{f}}
Writes the double {\it f} to the stream using the IEEE format.
+
\membersection{wxTextOutputStream::WriteString}\label{wxtextoutputstreamwritestring}
-\func{virtual void}{wxTextOutputStream::WriteString}{{\param const wxString\& }{string}}
+\func{virtual void}{WriteString}{{\param const wxString\& }{string}}
Writes {\it string} as a line. Depending on the end-of-line mode the end of
line ('$\backslash$n') characters in the string are converted to the correct
\membersection{wxVariant::Convert}\label{wxvariantconvert}
-\constfunc{bool}{Convert}{long* value}
+\constfunc{bool}{Convert}{\param{long*}{ value}}
-\constfunc{bool}{Convert}{bool* value}
+\constfunc{bool}{Convert}{\param{bool*}{ value}}
-\constfunc{bool}{Convert}{double* value}
+\constfunc{bool}{Convert}{\param{double*}{ value}}
-\constfunc{bool}{Convert}{wxString* value}
+\constfunc{bool}{Convert}{\param{wxString*}{ value}}
-\constfunc{bool}{Convert}{char* value}
+\constfunc{bool}{Convert}{\param{char*}{ value}}
-\constfunc{bool}{Convert}{wxDateTime* value}
+\constfunc{bool}{Convert}{\param{wxDateTime*}{ value}}
Retrieves and converts the value of this variant to the type that {\it value} is.
projects / wxWidgets.git / commitdiff
