X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2edb0bdef6238c8c246b6978bc14828b7033d931..3bfa7be9771e14a164116fa2081171bcab17814f:/docs/latex/wx/imaglist.tex diff --git a/docs/latex/wx/imaglist.tex b/docs/latex/wx/imaglist.tex index 8ae464ae15..62b41b6e13 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.} @@ -89,7 +89,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{const bool }{mask = true},\rtfsp \param{int }{initialCount = 1}} Initializes the list. See \helpref{wxImageList::wxImageList}{wximagelistconstr} for details. @@ -97,8 +97,8 @@ Initializes the list. See \helpref{wxImageList::wxImageList}{wximagelistconstr} \membersection{wxImageList::Draw}\label{wximagelistdraw} \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{int }{y}, \param{int }{flags = wxIMAGELIST\_DRAW\_NORMAL},\rtfsp +\param{const bool }{solidBackground = false}} Draws a specified image onto a device context. @@ -125,6 +125,18 @@ Draws a specified image onto a device context. \docparam{solidBackground}{For optimisation - drawing can be faster if the function is told that the background is solid.} +\membersection{wxImageList::GetBitmap}\label{wximagelistgetbitmap} + +\constfunc{wxBitmap}{GetBitmap}{\param{int }{index}} + +Returns the bitmap corresponding to the given index. + +\membersection{wxImageList::GetIcon}\label{wximagelistgeticon} + +\constfunc{wxIcon}{GetIcon}{\param{int }{index}} + +Returns the icon corresponding to the given index. + \membersection{wxImageList::GetImageCount}\label{wximagelistgetimagecount} \constfunc{int}{GetImageCount}{\void} @@ -148,7 +160,7 @@ parameter is ignored as all images in the list have the same size. \wxheading{Return value} -TRUE if the function succeeded, FALSE if it failed (for example, if the image +true if the function succeeded, false if it failed (for example, if the image list was not yet initialized). \membersection{wxImageList::Remove}\label{wximagelistremove} @@ -169,6 +181,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. @@ -183,7 +197,7 @@ 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}