Added docs for new wxImage constructor.

Began docs for grid sizers.


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_2_2_BRANCH@7360 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robert Roebling
2000-05-05 20:17:41 +00:00
parent 76dfc86313
commit 4a18b95556
5 changed files with 62 additions and 2 deletions

View File

@@ -117,6 +117,8 @@ These are the classes relevant to the sizer-based layout.
\begin{twocollist}\itemsep=0pt
\twocolitem{\helpref{wxSizer}{wxsizer}}{Abstract base class}
\twocolitem{\helpref{wxGridSizer}{wxgridsizer}}{A sizer for laying out windows in a grid with all fields having the same size}
\twocolitem{\helpref{wxFlexGridSizer}{wxflexgridsizer}}{A sizer for laying out windows in a flexible grid}
\twocolitem{\helpref{wxBoxSizer}{wxboxsizer}}{A sizer for laying out windows in a row or column}
\twocolitem{\helpref{wxStaticBoxSizer}{wxstaticboxsizer}}{Same as wxBoxSizer, but with surrounding static box}
\twocolitem{\helpref{wxNotebookSizer}{wxnotebooksizer}}{Sizer to use with the wxNotebook control.}

View File

@@ -91,6 +91,7 @@
\input filesys.tex
\input filesysh.tex
\input filetype.tex
\input flexsizr.tex
\input fltinstr.tex
\input fltoutst.tex
\input focusevt.tex
@@ -107,6 +108,7 @@
\input glcanvas.tex
\input valgen.tex
\input grid.tex
\input gridsizr.tex
\input hash.tex
\input helpinst.tex
\input htcell.tex

View File

@@ -0,0 +1,25 @@
\section{\class{wxFlexGridSizer}}\label{wxflexgridsizer}
A flex grid sizer is a sizer which lays out its children in a two-
dimensional table with all table fields in one row having the same
height and all fields in one column having the same width.
\wxheading{Derived from}
\helpref{wxGridSizer}{wxsizer}\\
\helpref{wxSizer}{wxsizer}\\
\helpref{wxObject}{wxobject}
\membersection{wxFlexGridSizer::wxFlexGridSizer}\label{wxflexgridsizerwxflexgridsizer}
\func{}{wxFlexGridSizer}{\param{int }{rows}, \param{int }{cols}, \param{int }{vgap}, \param{int }{hgap}}
\func{}{wxFlexGridSizer}{\param{int }{cols}, \param{int }{vgap = 0}, \param{int }{hgap = 0}}
Constructor for a wxGridSizer. {\it rows} and {\it cols} determine the number of
columns and rows in the sizer - if either of the parameters is zero, it will be
calculated form the total number of children in the sizer, thus making the
sizer grow dynamically. {\it vgap} and {\it hgap} define extra space between
all children.

View File

@@ -0,0 +1,25 @@
\section{\class{wxGridSizer}}\label{wxgridsizer}
A grid sizer is a sizer which lays out its children in a two-
dimensional table with all table fields having the same size,
i.e. the width of each field is the width of the widest child,
the height of each field is the height of the tallest child.
\wxheading{Derived from}
\helpref{wxSizer}{wxsizer}\\
\helpref{wxObject}{wxobject}
\membersection{wxGridSizer::wxGridSizer}\label{wxgridsizerwxgridsizer}
\func{}{wxGridSizer}{\param{int }{rows}, \param{int }{cols}, \param{int }{vgap}, \param{int }{hgap}}
\func{}{wxGridSizer}{\param{int }{cols}, \param{int }{vgap = 0}, \param{int }{hgap = 0}}
Constructor for a wxGridSizer. {\it rows} and {\it cols} determine the number of
columns and rows in the sizer - if either of the parameters is zero, it will be
calculated form the total number of children in the sizer, thus making the
sizer grow dynamically. {\it vgap} and {\it hgap} define extra space between
all children.

View File

@@ -29,7 +29,7 @@ handler with \helpref{wxImage::AddHandler}{wximageaddhandler} or
\twocolitem{{\bf \indexit{wxGIFHandler}}}{Only for loading, due to legal issues.}
\twocolitem{{\bf \indexit{wxPCXHandler}}}{For loading and saving (see below).}
\twocolitem{{\bf \indexit{wxPNMHandler}}}{For loading and saving (see below).}
\twocolitem{{\bf \indexit{wxTIFFHandler}}}{For loading and saving.}
\twocolitem{{\bf \indexit{wxTIFFHandler}}}{For loading.}
\end{twocollist}
When saving in PCX format, {\bf wxPCXHandler} will count the number of
@@ -74,6 +74,13 @@ and forth without loss in that respect.
Creates an image with the given width and height.
\func{}{wxImage}{\param{int}{ width}, \param{int}{ height}, \param{unsigned char*}{ data}, \param{bool}{ static_data=FALSE}}
Creates an image from given data with the given width and height. If
{\it static_data} is TRUE, then wxImage will not delete the actual
image data in its destructor, otherwise it will free it by calling
{\it free()}.
\func{}{wxImage}{\param{const wxString\& }{name}, \param{long}{ type = wxBITMAP\_TYPE\_ANY}}
\func{}{wxImage}{\param{const wxString\& }{name}, \param{const wxString\&}{ mimetype}}
@@ -458,7 +465,6 @@ Saves a image in the given stream.
\twocolitem{{\bf wxBITMAP\_TYPE\_PNG}}{Save a PNG image file.}
\twocolitem{{\bf wxBITMAP\_TYPE\_PCX}}{Save a PCX image file (tries to save as 8-bit if possible, falls back to 24-bit otherwise).}
\twocolitem{{\bf wxBITMAP\_TYPE\_PNM}}{Save a PNM image file (as raw RGB always).}
\twocolitem{{\bf wxBITMAP\_TYPE\_TIF}}{Save a TIFF image file.}
\end{twocollist}}
\docparam{mimetype}{MIME type.}