#include </home/Hamish/wxwidgets/wxWidgets3.0-3.0.5.1-1.src/wxWidgets3.0-3.0.5.1-1.i686/src/wxWidgets-3.0.5.1/interface/wx/imaglist.h>
Inheritance diagram for wxImageList: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.
<>< =''>:</>&;&;< =''>\ </></>
Public Member Functions | |
| wxImageList () | |
| Default ctor. More... | |
| wxImageList (int width, int height, bool mask=true, int initialCount=1) | |
| Constructor specifying the image size, whether image masks should be created, and the initial size of the list. More... | |
| int | Add (const wxBitmap &bitmap, const wxBitmap &mask=wxNullBitmap) |
| Adds a new image or images using a bitmap and optional mask bitmap. More... | |
| int | Add (const wxBitmap &bitmap, const wxColour &maskColour) |
| Adds a new image or images using a bitmap and mask colour. More... | |
| int | Add (const wxIcon &icon) |
| Adds a new image using an icon. More... | |
| bool | Create (int width, int height, bool mask=true, int initialCount=1) |
| Initializes the list. More... | |
| virtual bool | Draw (int index, wxDC &dc, int x, int y, int flags=wxIMAGELIST_DRAW_NORMAL, bool solidBackground=false) |
| Draws a specified image onto a device context. More... | |
| wxBitmap | GetBitmap (int index) const |
| Returns the bitmap corresponding to the given index. More... | |
| wxIcon | GetIcon (int index) const |
| Returns the icon corresponding to the given index. More... | |
| virtual int | GetImageCount () const |
| Returns the number of images in the list. More... | |
| virtual bool | GetSize (int index, int &width, int &height) const |
| Retrieves the size of the images in the list. More... | |
| bool | Remove (int index) |
| Removes the image at the given position. More... | |
| bool | RemoveAll () |
| Removes all the images in the list. More... | |
| bool | Replace (int index, const wxBitmap &bitmap, const wxBitmap &mask=wxNullBitmap) |
| Replaces the existing image with the new image. More... | |
| bool | Replace (int index, const wxIcon &icon) |
| Replaces the existing image with the new image. More... | |
Public Member Functions inherited from wxObject | |
| wxObject () | |
| Default ctor; initializes to NULL the internal reference data. More... | |
| wxObject (const wxObject &other) | |
| Copy ctor. More... | |
| virtual | ~wxObject () |
| Destructor. More... | |
| virtual wxClassInfo * | GetClassInfo () const |
| This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar). More... | |
| wxObjectRefData * | GetRefData () const |
| Returns the wxObject::m_refData pointer, i.e. the data referenced by this object. More... | |
| bool | IsKindOf (const wxClassInfo *info) const |
| Determines whether this class is a subclass of (or the same class as) the given class. More... | |
| bool | IsSameAs (const wxObject &obj) const |
| Returns true if this object has the same data pointer as obj. More... | |
| void | Ref (const wxObject &clone) |
| Makes this object refer to the data in clone. More... | |
| void | SetRefData (wxObjectRefData *data) |
| Sets the wxObject::m_refData pointer. More... | |
| void | UnRef () |
| Decrements the reference count in the associated data, and if it is zero, deletes the data. More... | |
| void | UnShare () |
| This is the same of AllocExclusive() but this method is public. More... | |
| void | operator delete (void *buf) |
The delete operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined. More... | |
| void * | operator new (size_t size, const wxString &filename=NULL, int lineNum=0) |
The new operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined. More... | |
Additional Inherited Members | |
Protected Member Functions inherited from wxObject | |
| void | AllocExclusive () |
| Ensure that this object's data is not shared with any other object. More... | |
| virtual wxObjectRefData * | CreateRefData () const |
| Creates a new instance of the wxObjectRefData-derived class specific to this object and returns it. More... | |
| virtual wxObjectRefData * | CloneRefData (const wxObjectRefData *data) const |
| Creates a new instance of the wxObjectRefData-derived class specific to this object and initializes it copying data. More... | |
Protected Attributes inherited from wxObject | |
| wxObjectRefData * | m_refData |
| Pointer to an object which is the object's reference-counted data. More... | |
| wxImageList::wxImageList | ( | ) |
Default ctor.
| wxImageList::wxImageList | ( | int | width, |
| int | height, | ||
| bool | mask = true, |
||
| int | initialCount = 1 |
||
| ) |
Constructor specifying the image size, whether image masks should be created, and the initial size of the list.
| width | Width of the images in the list. |
| height | Height of the images in the list. |
| mask | true if masks should be created for all images. |
| initialCount | The initial size of the list. |
| int wxImageList::Add | ( | const wxBitmap & | bitmap, |
| const wxBitmap & | mask = wxNullBitmap |
||
| ) |
Adds a new image or images using a bitmap and optional mask bitmap.
| bitmap | Bitmap representing the opaque areas of the image. |
| mask | Monochrome mask bitmap, representing the transparent areas of the image. |
Adds a new image or images using a bitmap and mask colour.
| bitmap | Bitmap representing the opaque areas of the image. |
| maskColour | Colour indicating which parts of the image are transparent. |
| int wxImageList::Add | ( | const wxIcon & | icon | ) |
Adds a new image using an icon.
| icon | Icon to use as the image. |
| bool wxImageList::Create | ( | int | width, |
| int | height, | ||
| bool | mask = true, |
||
| int | initialCount = 1 |
||
| ) |
Initializes the list.
See wxImageList() for details.
|
virtual |
Draws a specified image onto a device context.
| index | Image index, starting from zero. |
| dc | Device context to draw on. |
| x | X position on the device context. |
| y | Y position on the device context. |
| flags | How to draw the image. A bitlist of a selection of the following:
|
| solidBackground | For optimisation - drawing can be faster if the function is told that the background is solid. |
| wxBitmap wxImageList::GetBitmap | ( | int | index | ) | const |
Returns the bitmap corresponding to the given index.
| wxIcon wxImageList::GetIcon | ( | int | index | ) | const |
Returns the icon corresponding to the given index.
|
virtual |
Returns the number of images in the list.
|
virtual |
Retrieves the size of the images in the list.
Currently, the index parameter is ignored as all images in the list have the same size.
| index | currently unused, should be 0 |
| width | receives the width of the images in the list |
| height | receives the height of the images in the list |
| bool wxImageList::Remove | ( | int | index | ) |
Removes the image at the given position.
| bool wxImageList::RemoveAll | ( | ) |
Removes all the images in the list.
| bool wxImageList::Replace | ( | int | index, |
| const wxBitmap & | bitmap, | ||
| const wxBitmap & | mask = wxNullBitmap |
||
| ) |
Replaces the existing image with the new image.
Windows only.
| index | The index of the bitmap to be replaced. |
| bitmap | Bitmap representing the opaque areas of the image. |
| mask | Monochrome mask bitmap, representing the transparent areas of the image. |
| bool wxImageList::Replace | ( | int | index, |
| const wxIcon & | icon | ||
| ) |
Replaces the existing image with the new image.
| index | The index of the bitmap to be replaced. |
| icon | Icon to use as the image. |