User's Guide
Reference Manual
Release Notes
PDF
Top

wxErlang
Reference Manual
Version 1.0

Expand All
Contract All

Table of Contents

# wxImageList

### MODULE

wxImageList

### MODULE SUMMARY

See external documentation: wxImageList.

### DESCRIPTION

See external documentation: wxImageList.

### DATA TYPES

wxImageList()

  An object reference, The representation is internal and can be changed without notice. It can't be used for comparsion stored on disc or distributed for use on other nodes.

### EXPORTS

new() -> wxImageList()

See external documentation.

new(Width, Height) -> wxImageList()

Types:

Width = integer()
Height = integer()

Equivalent to new(Width, Height, []).

new(Width, Height, Option::[Option]) -> wxImageList()

Types:

Width = integer()
Height = integer()
Option = {mask, boolean()} | {initialCount, integer()}

See external documentation.

add(This, Bitmap) -> integer()

Types:

This = wxImageList()
Bitmap = wxBitmap() (see module wxBitmap)

See external documentation.

add(This, Bitmap, Mask) -> integer()

Types:

This = wxImageList()
Bitmap = wxBitmap() (see module wxBitmap)
Mask = wxBitmap() (see module wxBitmap)

See external documentation.
Also:
add(This, Bitmap, MaskColour) -> integer() when
This::wxImageList(), Bitmap::wxBitmap:wxBitmap(), MaskColour::wx:wx_colour().

create(This, Width, Height) -> boolean()

Types:

This = wxImageList()
Width = integer()
Height = integer()

Equivalent to create(This, Width, Height, []).

create(This, Width, Height, Option::[Option]) -> boolean()

Types:

This = wxImageList()
Width = integer()
Height = integer()
Option = {mask, boolean()} | {initialCount, integer()}

See external documentation.

draw(This, Index, Dc, X, Y) -> boolean()

Types:

This = wxImageList()
Index = integer()
Dc = wxDC() (see module wxDC)
X = integer()
Y = integer()

Equivalent to draw(This, Index, Dc, X, Y, []).

draw(This, Index, Dc, X, Y, Option::[Option]) -> boolean()

Types:

This = wxImageList()
Index = integer()
Dc = wxDC() (see module wxDC)
X = integer()
Y = integer()
Option = {flags, integer()} | {solidBackground, boolean()}

See external documentation.

getBitmap(This, Index) -> wxBitmap() (see module wxBitmap)

Types:

This = wxImageList()
Index = integer()

See external documentation.

getIcon(This, Index) -> wxIcon() (see module wxIcon)

Types:

This = wxImageList()
Index = integer()

See external documentation.

getImageCount(This) -> integer()

Types:

This = wxImageList()

See external documentation.

getSize(This, Index) -> Result

Types:

Result = {Res::boolean(), Width::integer(), Height::integer()}
This = wxImageList()
Index = integer()

See external documentation.

remove(This, Index) -> boolean()

Types:

This = wxImageList()
Index = integer()

See external documentation.

removeAll(This) -> boolean()

Types:

This = wxImageList()

See external documentation.

replace(This, Index, Bitmap) -> boolean()

Types:

This = wxImageList()
Index = integer()
Bitmap = wxBitmap() (see module wxBitmap)

See external documentation.

replace(This, Index, Bitmap, Mask) -> boolean()

Types:

This = wxImageList()
Index = integer()
Bitmap = wxBitmap() (see module wxBitmap)
Mask = wxBitmap() (see module wxBitmap)

See external documentation.

destroy(This::wxImageList()) -> ok

Destroys this object, do not use object again