X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ae3c17b4013e80b99976c750c19fca47729517f6..b72ed64277a2b16c6c8681995e5f3f304a8fe38d:/interface/wx/imaglist.h diff --git a/interface/wx/imaglist.h b/interface/wx/imaglist.h index ca3711c418..7c9cd1d72b 100644 --- a/interface/wx/imaglist.h +++ b/interface/wx/imaglist.h @@ -3,17 +3,15 @@ // Purpose: interface of wxImageList // Author: wxWidgets team // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @class wxImageList - @wxheader{imaglist.h} - A wxImageList contains a list of images, which are stored in - an unspecified form. Images can have masks for transparent - drawing, and can be made from a variety of sources including bitmaps - and icons. + A wxImageList contains a list of images, which are stored in an unspecified + form. Images can have masks for transparent drawing, and can be made from a + variety of sources including bitmaps and icons. wxImageList is used principally in conjunction with wxTreeCtrl and wxListCtrl classes. @@ -26,7 +24,11 @@ class wxImageList : public wxObject { public: - //@{ + /** + Default ctor. + */ + wxImageList(); + /** Constructor specifying the image size, whether image masks should be created, and the initial size of the list. @@ -42,34 +44,66 @@ public: @see Create() */ - wxImageList(); wxImageList(int width, int height, bool mask = true, int initialCount = 1); - //@} - //@{ /** - Adds a new image using an icon. + Adds a new image or images using a bitmap and optional mask bitmap. @param bitmap Bitmap representing the opaque areas of the image. @param mask Monochrome mask bitmap, representing the transparent areas of the image. + + @return The new zero-based image index. + + @remarks The original bitmap or icon is not affected by the 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. + */ + int Add(const wxBitmap& bitmap, + const wxBitmap& mask = wxNullBitmap); + + /** + Adds a new image or images using a bitmap and mask colour. + + @param bitmap + Bitmap representing the opaque areas of the image. @param maskColour Colour indicating which parts of the image are transparent. + + @return The new zero-based image index. + + @remarks The original bitmap or icon is not affected by the 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. + */ + int Add(const wxBitmap& bitmap, const wxColour& maskColour); + + /** + Adds a new image using an icon. + @param icon Icon to use as the image. @return The new zero-based image index. - @remarks The original bitmap or icon is not affected by the Add + @remarks The original bitmap or icon is not affected by the 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. + + @onlyfor{wxmsw,wxosx} */ - int Add(const wxBitmap& bitmap, - const wxBitmap& mask = wxNullBitmap); - int Add(const wxBitmap& bitmap, const wxColour& maskColour); int Add(const wxIcon& icon); - //@} /** Initializes the list. See wxImageList() for details. @@ -90,58 +124,17 @@ public: Y position on the device context. @param flags How to draw the image. A bitlist of a selection of the following: - - - - - - - wxIMAGELIST_DRAW_NORMAL - - - - - Draw the image normally. - - - - - - wxIMAGELIST_DRAW_TRANSPARENT - - - - - Draw the image with transparency. - - - - - - wxIMAGELIST_DRAW_SELECTED - - - - - Draw the image in selected state. - - - - - - wxIMAGELIST_DRAW_FOCUSED - - - - - Draw the image in a focused state. + - wxIMAGELIST_DRAW_NORMAL: Draw the image normally. + - wxIMAGELIST_DRAW_TRANSPARENT: Draw the image with transparency. + - wxIMAGELIST_DRAW_SELECTED: Draw the image in selected state. + - wxIMAGELIST_DRAW_FOCUSED: Draw the image in a focused state. @param solidBackground For optimisation - drawing can be faster if the function is told that the background is solid. */ - bool Draw(int index, wxDC& dc, int x, int y, - int flags = wxIMAGELIST_DRAW_NORMAL, - bool solidBackground = false); + virtual bool Draw(int index, wxDC& dc, int x, int y, + int flags = wxIMAGELIST_DRAW_NORMAL, + bool solidBackground = false); /** Returns the bitmap corresponding to the given index. @@ -156,7 +149,7 @@ public: /** Returns the number of images in the list. */ - int GetImageCount() const; + virtual int GetImageCount() const; /** Retrieves the size of the images in the list. Currently, the @a index @@ -169,10 +162,10 @@ public: @param height receives the height of the images in the list - @return @true if the function succeeded, @false if it failed (for example, - if the image list was not yet initialized). + @return @true if the function succeeded, @false if it failed + (for example, if the image list was not yet initialized). */ - bool GetSize(int index, int& width, int& height) const; + virtual bool GetSize(int index, int& width, int& height) const; /** Removes the image at the given position. @@ -184,25 +177,40 @@ public: */ bool RemoveAll(); - //@{ /** Replaces the existing image with the new image. + Windows only. + @param index + The index of the bitmap to be replaced. @param bitmap Bitmap representing the opaque areas of the image. @param mask Monochrome mask bitmap, representing the transparent areas of the image. - @param icon - Icon to use as the image. @return @true if the replacement was successful, @false otherwise. - @remarks The original bitmap or icon is not affected by the Replace + @remarks The original bitmap or icon is not affected by the Replace() operation, and can be deleted afterwards. */ bool Replace(int index, const wxBitmap& bitmap, const wxBitmap& mask = wxNullBitmap); + + /** + Replaces the existing image with the new image. + + @param index + The index of the bitmap to be replaced. + @param icon + Icon to use as the image. + + @return @true if the replacement was successful, @false otherwise. + + @remarks The original bitmap or icon is not affected by the Replace() + operation, and can be deleted afterwards. + + @onlyfor{wxmsw,wxosx} + */ bool Replace(int index, const wxIcon& icon); - //@} };