Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

minor docs corrections (patch 1144566)

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@32226 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2005-02-20 00:07:35 +00:00
parent 719493e14b
commit 0f35356305
14 changed files with 81 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/latex/wx/bitmap.tex
View File

@@ -296,11 +296,11 @@ type of data.
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.
@@ -408,7 +408,7 @@ of a given handler class in an application session.}
\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.
@@ -473,7 +473,7 @@ true if the handler was found and removed, false otherwise.
\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.

2
docs/latex/wx/category.tex
View File

@@ -595,7 +595,7 @@ product, donated by Remstar. This is known as wxODBC.
\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}}

2
docs/latex/wx/conditn.tex
View File

@@ -190,7 +190,7 @@ Returns {\tt wxCOND\_NO\_ERROR} on success, another value if an error occured.
\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.

19
docs/latex/wx/db.tex
View File

@@ -1961,7 +1961,7 @@ Accessor function to set the user ID for this class instance.
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.
@@ -1978,6 +1978,11 @@ There are no constructors/destructors as of this time, and no member functions.
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,
@@ -2032,7 +2037,7 @@ with the wxDbTable class.
\begin{itemize}\itemsep=0pt
\item \helpref{wxDbColDef}{wxdbcoldef}
\item \helpref{wxDbColDataPtr}{wxdbcoldataptr}
\item \helpref{wxDbIndexDef}{wxdbindexdef}
\item \helpref{wxDbIdxDef}{wxdbidxdef}
\end{itemize}
\wxheading{Constants}
@@ -2417,7 +2422,7 @@ this function.
\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
@@ -2436,7 +2441,7 @@ take advantage of those indexes.
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.}
@@ -2458,9 +2463,9 @@ In the third parameter, specify how many columns are in your index. This
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
@@ -2485,7 +2490,7 @@ after executing this function.
\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;

2
docs/latex/wx/docmdipr.tex
View File

@@ -28,7 +28,7 @@ See the example application in {\tt samples/docview}.
\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"}}

2
docs/latex/wx/font.tex
View File

@@ -156,7 +156,7 @@ Default constructor.
\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}}

6
docs/latex/wx/icon.tex
View File

@@ -80,7 +80,7 @@ Creates a new icon.
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.
@@ -247,7 +247,7 @@ Gets the width of the icon in pixels.
\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.
@@ -286,7 +286,7 @@ Returns true if icon data is present.
\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.

2
docs/latex/wx/joystick.tex
View File

@@ -201,7 +201,7 @@ Returns the maximum z position.
\membersection{wxJoystick::GetZMin}\label{wxjoystickgetzmin}
\constfunc{int}{GetXMin}{\void}
\constfunc{int}{GetZMin}{\void}
Returns the minimum z position.

2
docs/latex/wx/mdi.tex
View File

@@ -125,7 +125,7 @@ for further details.
\membersection{wxMDIChildFrame::Maximize}\label{wxmdichildframemaximize}
\func{void}{Maximize}{\void}
\func{void}{Maximize}{\param{bool}{maximize}}
Maximizes this MDI child frame.

2
docs/latex/wx/palette.tex
View File

@@ -123,7 +123,7 @@ The nearest palette index.
\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.

3
docs/latex/wx/setup.tex Normal file
View File

@@ -0,0 +1,3 @@
\section{wxWindows Compile-Time Configuration Options}\label{setup}

2
docs/latex/wx/sizer.tex
View File

@@ -496,7 +496,7 @@ Sets the object of the wxSizerFlags to center itself in the area it is given.
\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.

66
docs/latex/wx/txtstrm.tex
View File

@@ -41,6 +41,7 @@ For example:
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxTextInputStream::wxTextInputStream}\label{wxtextinputstreamctor}
\func{}{wxTextInputStream}{\param{wxInputStream\&}{ stream}, \param{const wxString\&}{ sep=" $\backslash$t"},
@@ -57,12 +58,14 @@ Constructs a text stream associated to the given input stream.
\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}}
@@ -77,6 +80,7 @@ that you may not want to specify the base $0$ if you are parsing the numbers
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}}
@@ -86,6 +90,7 @@ Reads a single signed byte from the stream.
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}}
@@ -95,6 +100,7 @@ Reads a unsigned 16 bit integer from the stream.
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}}
@@ -104,6 +110,7 @@ Reads a signed 16 bit integer from the stream.
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}}
@@ -113,6 +120,7 @@ Reads a 32 bit unsigned integer from the stream.
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}}
@@ -122,37 +130,42 @@ Reads a 32 bit signed integer from the stream.
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.
@@ -161,6 +174,7 @@ input stream.
\helpref{SetStringSeparators}{wxtextinputstreamsetstringseparators}
\membersection{wxTextInputStream::SetStringSeparators}\label{wxtextinputstreamsetstringseparators}
\func{void}{SetStringSeparators}{\param{const wxString\& }{sep}}
@@ -195,6 +209,7 @@ and Unix in their native formats (concerning the line ending).
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxTextOutputStream::wxTextOutputStream}\label{wxtextoutputstreamctor}
\func{}{wxTextOutputStream}{\param{wxOutputStream\&}{ stream}, \param{wxEOL}{ mode = wxEOL\_NATIVE}, \param{wxMBConv\&}{ conv = wxConvUTF8}}
@@ -210,57 +225,66 @@ Constructs a text stream object associated to the given output stream.
\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::SetMode}\label{wxtextoutputstreamsetmode}
\func{void}{wxTextOutputStream::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}}
Writes the single byte {\it i8} to the stream.
\membersection{wxTextOutputStream::PutChar}\label{wxtextoutputstreamputchar}
\func{void}{wxTextOutputStream::PutChar}{{\param wxChar }{c}}
\func{void}{PutChar}{{\param wxChar }{c}}
Writes a character to the stream.
\membersection{wxTextOutputStream::SetMode}\label{wxtextoutputstreamsetmode}
\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}{Write8}{{\param wxUint8 }{i8}}
Writes the single byte {\it i8} 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

12
docs/latex/wx/variant.tex
View File

@@ -119,17 +119,17 @@ Deletes the contents of the list.
\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.