View Source wxImageList (wx v2.4.3)
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.
See:
wxWidgets docs: wxImageList
Summary
Functions
Adds a new image using an icon.
Adds a new image or images using a bitmap and mask colour.
Equivalent to create(This, Width, Height, []).
Initializes the list.
Destroys the object
Equivalent to draw(This, Index, Dc, X, Y, []).
Draws a specified image onto a device context.
Returns the bitmap corresponding to the given index.
Returns the icon corresponding to the given index.
Returns the number of images in the list.
Retrieves the size of the images in the list.
Default ctor.
Equivalent to new(Width, Height, []).
Constructor specifying the image size, whether image masks should be created, and the initial size of the list.
Removes the image at the given position.
Removes all the images in the list.
Replaces the existing image with the new image.
Replaces the existing image with the new image.
Types
-type wxImageList() :: wx:wx_object().
Functions
-spec add(This, Icon) -> integer() when This :: wxImageList(), Icon :: wxIcon:wxIcon() | wxBitmap:wxBitmap().
Adds a new image using an icon.
Return: The new zero-based image index.
Remark: The original bitmap or icon is not affected by the add/3 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.
Only for:wxmsw,wxosx
-spec add(This, Bitmap, Mask) -> integer() when This :: wxImageList(), Bitmap :: wxBitmap:wxBitmap(), Mask :: wxBitmap:wxBitmap(); (This, Bitmap, MaskColour) -> integer() when This :: wxImageList(), Bitmap :: wxBitmap:wxBitmap(), MaskColour :: wx:wx_colour().
Adds a new image or images using a bitmap and mask colour.
Return: The new zero-based image index.
Remark: The original bitmap or icon is not affected by the add/3 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.
-spec create(This, Width, Height) -> boolean() when This :: wxImageList(), Width :: integer(), Height :: integer().
Equivalent to create(This, Width, Height, []).
-spec create(This, Width, Height, [Option]) -> boolean() when This :: wxImageList(), Width :: integer(), Height :: integer(), Option :: {mask, boolean()} | {initialCount, integer()}.
Initializes the list.
See new/3 for details.
-spec destroy(This :: wxImageList()) -> ok.
Destroys the object
-spec draw(This, Index, Dc, X, Y) -> boolean() when This :: wxImageList(), Index :: integer(), Dc :: wxDC:wxDC(), X :: integer(), Y :: integer().
Equivalent to draw(This, Index, Dc, X, Y, []).
-spec draw(This, Index, Dc, X, Y, [Option]) -> boolean() when This :: wxImageList(), Index :: integer(), Dc :: wxDC:wxDC(), X :: integer(), Y :: integer(), Option :: {flags, integer()} | {solidBackground, boolean()}.
Draws a specified image onto a device context.
-spec getBitmap(This, Index) -> wxBitmap:wxBitmap() when This :: wxImageList(), Index :: integer().
Returns the bitmap corresponding to the given index.
-spec getIcon(This, Index) -> wxIcon:wxIcon() when This :: wxImageList(), Index :: integer().
Returns the icon corresponding to the given index.
-spec getImageCount(This) -> integer() when This :: wxImageList().
Returns the number of images in the list.
-spec getSize(This, Index) -> Result when Result :: {Res :: boolean(), Width :: integer(), Height :: integer()}, This :: wxImageList(), Index :: integer().
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.
Return: true if the function succeeded, false if it failed (for example, if the image list was not yet initialized).
-spec new() -> wxImageList().
Default ctor.
-spec new(Width, Height) -> wxImageList() when Width :: integer(), Height :: integer().
Equivalent to new(Width, Height, []).
-spec new(Width, Height, [Option]) -> wxImageList() when Width :: integer(), Height :: integer(), Option :: {mask, boolean()} | {initialCount, integer()}.
Constructor specifying the image size, whether image masks should be created, and the initial size of the list.
See: create/4
-spec remove(This, Index) -> boolean() when This :: wxImageList(), Index :: integer().
Removes the image at the given position.
-spec removeAll(This) -> boolean() when This :: wxImageList().
Removes all the images in the list.
-spec replace(This, Index, Icon) -> boolean() when This :: wxImageList(), Index :: integer(), Icon :: wxIcon:wxIcon() | wxBitmap:wxBitmap().
Replaces the existing image with the new image.
Return: true if the replacement was successful, false otherwise.
Remark: The original bitmap or icon is not affected by the replace/4 operation, and can be deleted afterwards.
Only for:wxmsw,wxosx
-spec replace(This, Index, Bitmap, Mask) -> boolean() when This :: wxImageList(), Index :: integer(), Bitmap :: wxBitmap:wxBitmap(), Mask :: wxBitmap:wxBitmap().
Replaces the existing image with the new image.
Windows only.
Return: true if the replacement was successful, false otherwise.
Remark: The original bitmap or icon is not affected by the replace/4 operation, and can be deleted
afterwards.