]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/imaglist.tex
no changes, just come cleanup and more comments
[wxWidgets.git] / docs / latex / wx / imaglist.tex
index 62b41b6e13f78a6cc26276f3b8b446875b565f8b..697aad2ea184237da0f84d376aa373da8f8ee1bd 100644 (file)
@@ -16,6 +16,10 @@ wxImageList is used principally in conjunction with \helpref{wxTreeCtrl}{wxtreec
 
 <wx/imaglist.h>
 
+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+
 \wxheading{See also}
 
 \helpref{wxTreeCtrl}{wxtreectrl}, \helpref{wxListCtrl}{wxlistctrl}
@@ -28,7 +32,7 @@ wxImageList is used principally in conjunction with \helpref{wxTreeCtrl}{wxtreec
 
 Default constructor.
 
-\func{}{wxImageList}{\param{int }{width}, \param{int }{height}, \param{const bool }{mask = true},\rtfsp
+\func{}{wxImageList}{\param{int }{width}, \param{int }{height}, \param{bool }{mask = true},\rtfsp
 \param{int }{initialCount = 1}}
 
 Constructor specifying the image size, whether image masks should be created, and the initial size of the list.
@@ -51,11 +55,11 @@ Constructor specifying the image size, whether image masks should be created, an
 
 \func{int}{Add}{\param{const wxBitmap\&}{ bitmap}, \param{const wxBitmap\&}{ mask = wxNullBitmap}}
 
-Adds a new image using a bitmap and optional mask bitmap.
+Adds a new image or images using a bitmap and optional mask bitmap.
 
 \func{int}{Add}{\param{const wxBitmap\&}{ bitmap}, \param{const wxColour\&}{ maskColour}}
 
-Adds a new image using a bitmap and mask colour.
+Adds a new image or images using a bitmap and mask colour.
 
 \func{int}{Add}{\param{const wxIcon\&}{ icon}}
 
@@ -79,6 +83,8 @@ The new zero-based image index.
 
 The original bitmap or icon is not affected by the {\bf Add} operation, and can be deleted afterwards.
 
+If the bitmap is wider than the images in the list, then the bitmap will automatically be split into smaller images, each matching the dimensions of the image list.  This does not apply when adding icons.
+
 \pythonnote{In place of a single overloaded method name, wxPython
 implements the following methods:\par
 \indented{2cm}{\begin{twocollist}
@@ -89,7 +95,7 @@ implements the following methods:\par
 }
 \membersection{wxImageList::Create}\label{wximagelistcreate}
 
-\func{bool}{Create}{\param{int }{width}, \param{int }{height}, \param{const bool }{mask = true},\rtfsp
+\func{bool}{Create}{\param{int }{width}, \param{int }{height}, \param{bool }{mask = true},\rtfsp
 \param{int }{initialCount = 1}}
 
 Initializes the list. See \helpref{wxImageList::wxImageList}{wximagelistconstr} for details.
@@ -98,7 +104,7 @@ Initializes the list. See \helpref{wxImageList::wxImageList}{wximagelistconstr}
 
 \func{bool}{Draw}{\param{int}{ index}, \param{wxDC\&}{ dc}, \param{int }{x},\rtfsp
 \param{int }{y}, \param{int }{flags = wxIMAGELIST\_DRAW\_NORMAL},\rtfsp
-\param{const bool }{solidBackground = false}}
+\param{bool }{solidBackground = false}}
 
 Draws a specified image onto a device context.