X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a660d684eda27638bca0384b2058911a31c8e845..bf7945cef10c0844a32e95695c544d829da9293a:/docs/latex/wx/imaglist.tex diff --git a/docs/latex/wx/imaglist.tex b/docs/latex/wx/imaglist.tex index 87eea4dea7..548b3dae78 100644 --- a/docs/latex/wx/imaglist.tex +++ b/docs/latex/wx/imaglist.tex @@ -12,6 +12,10 @@ wxImageList is used principally in conjunction with \helpref{wxTreeCtrl}{wxtreec \helpref{wxObject}{wxobject} +\wxheading{Include files} + + + \wxheading{See also} \helpref{wxTreeCtrl}{wxtreectrl}, \helpref{wxListCtrl}{wxlistctrl} @@ -24,8 +28,8 @@ wxImageList is used principally in conjunction with \helpref{wxTreeCtrl}{wxtreec Default constructor. -\func{}{wxImageList}{\param{const int }{width}, \param{const int }{height}, \param{const bool }{mask = TRUE},\rtfsp -\param{const int }{initialCount = 1}} +\func{}{wxImageList}{\param{int }{width}, \param{int }{height}, \param{const 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. @@ -53,7 +57,7 @@ Adds a new image using a bitmap and optional mask bitmap. Adds a new image using a bitmap and mask colour. -\func{int}{Add}{\param{const wxBitmap\&}{ icon}} +\func{int}{Add}{\param{const wxIcon\&}{ icon}} Adds a new image using an icon. @@ -75,17 +79,25 @@ The new zero-based image index. The original bitmap or icon is not affected by the {\bf Add} operation, and can be deleted afterwards. +\pythonnote{In place of a single overloaded method name, wxPython +implements the following methods:\par +\indented{2cm}{\begin{twocollist} +\twocolitem{{\bf Add(bitmap, mask=wxNullBitmap)}}{} +\twocolitem{{\bf AddWithColourMask(bitmap, colour)}}{} +\twocolitem{{\bf AddIcon(icon)}}{} +\end{twocollist}} +} \membersection{wxImageList::Create}\label{wximagelistcreate} -\func{bool}{Create}{\param{const int }{width}, \param{const int }{height}, \param{const bool }{mask = TRUE},\rtfsp -\param{const int }{initialCount = 1}} +\func{bool}{Create}{\param{int }{width}, \param{int }{height}, \param{const bool }{mask = TRUE},\rtfsp +\param{int }{initialCount = 1}} Initializes the list. See \helpref{wxImageList::wxImageList}{wximagelistconstr} for details. \membersection{wxImageList::Draw}\label{wximagelistdraw} -\func{bool}{Draw}{\param{const int}{ index}, \param{wxDC\&}{ dc}, \param{const int }{x},\rtfsp -\param{const int }{x}, \param{const int }{flags = wxIMAGELIST\_DRAW\_NORMAL},\rtfsp +\func{bool}{Draw}{\param{int}{ index}, \param{wxDC\&}{ dc}, \param{int }{x},\rtfsp +\param{int }{x}, \param{int }{flags = wxIMAGELIST\_DRAW\_NORMAL},\rtfsp \param{const bool }{solidBackground = FALSE}} Draws a specified image onto a device context. @@ -119,9 +131,29 @@ that the background is solid.} Returns the number of images in the list. +\membersection{wxImageList::GetSize}\label{wximagelistgetsize} + +\constfunc{bool}{GetSize}{\param{int }{index}, \param{int\& }{width}, \param{int \&}{height}} + +Retrieves the size of the images in the list. Currently, the {\it index} +parameter is ignored as all images in the list have the same size. + +\wxheading{Parameters} + +\docparam{index}{currently unused, should be 0} + +\docparam{width}{receives the width of the images in the list} + +\docparam{height}{receives the height of the images in the list} + +\wxheading{Return value} + +TRUE if the function succeeded, FALSE if it failed (for example, if the image +list was not yet initialized). + \membersection{wxImageList::Remove}\label{wximagelistremove} -\func{bool}{Remove}{\param{const int}{ index}} +\func{bool}{Remove}{\param{int}{ index}} Removes the image at the given position. @@ -133,11 +165,11 @@ Removes all the images in the list. \membersection{wxImageList::Replace}\label{wximagelistreplace} -\func{bool}{Replace}{\param{const int}{ index}, \param{const wxBitmap\&}{ bitmap}, \param{const wxBitmap\&}{ mask = wxNullBitmap}} +\func{bool}{Replace}{\param{int}{ index}, \param{const wxBitmap\&}{ bitmap}, \param{const wxBitmap\&}{ mask = wxNullBitmap}} Replaces the existing image with the new image. -\func{bool}{Replace}{\param{const int}{ index}, \param{const wxIcon\&}{ icon}} +\func{bool}{Replace}{\param{int}{ index}, \param{const wxIcon\&}{ icon}} Replaces the existing image with the new image. @@ -157,4 +189,6 @@ TRUE if the replacement was successful, FALSE otherwise. The original bitmap or icon is not affected by the {\bf Replace} operation, and can be deleted afterwards. +\pythonnote{The second form is called {\tt ReplaceIcon} in wxPython.} +