X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/06d20283afba5439c8a2c1b3b7cd3390541da52d..ce756cb06a93facb4faa35a1d57c7038fc26e8e1:/docs/latex/wx/imaglist.tex?ds=sidebyside diff --git a/docs/latex/wx/imaglist.tex b/docs/latex/wx/imaglist.tex index 159e866cc4..b38d24d9c7 100644 --- a/docs/latex/wx/imaglist.tex +++ b/docs/latex/wx/imaglist.tex @@ -28,7 +28,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{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. @@ -39,7 +39,7 @@ Constructor specifying the image size, whether image masks should be created, an \docparam{height}{Height of the images in the list.} -\docparam{mask}{TRUE if masks should be created for all images.} +\docparam{mask}{true if masks should be created for all images.} \docparam{initialCount}{The initial size of the list.} @@ -82,14 +82,14 @@ The original bitmap or icon is not affected by the {\bf Add} operation, and can \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)}}{} +\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{int }{width}, \param{int }{height}, \param{const bool }{mask = TRUE},\rtfsp +\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. @@ -98,7 +98,7 @@ Initializes the list. See \helpref{wxImageList::wxImageList}{wximagelistconstr} \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}} +\param{const bool }{solidBackground = false}} Draws a specified image onto a device context. @@ -118,7 +118,7 @@ Draws a specified image onto a device context. \twocolitem{{\bf wxIMAGELIST\_DRAW\_NORMAL}}{Draw the image normally.} \twocolitem{{\bf wxIMAGELIST\_DRAW\_TRANSPARENT}}{Draw the image with transparency.} \twocolitem{{\bf wxIMAGELIST\_DRAW\_SELECTED}}{Draw the image in selected state.} -\twocolitem{{\bf wxIMAGELIST\_DRAW\_FOCUSED}}{Draw the image in a focussed state.} +\twocolitem{{\bf wxIMAGELIST\_DRAW\_FOCUSED}}{Draw the image in a focused state.} \end{twocollist} } @@ -131,6 +131,26 @@ 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{int}{ index}} @@ -149,6 +169,8 @@ Removes all the images in the list. Replaces the existing image with the new image. +Windows only. + \func{bool}{Replace}{\param{int}{ index}, \param{const wxIcon\&}{ icon}} Replaces the existing image with the new image. @@ -163,12 +185,12 @@ Replaces the existing image with the new image. \wxheading{Return value} -TRUE if the replacement was successful, FALSE otherwise. +true if the replacement was successful, false otherwise. \wxheading{Remarks} 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.} +\pythonnote{The second form is called {\tt ReplaceIcon} in wxPython.}