wImageList

A wImageList contains a list of images. It is used principally in conjunction with wTreeCtrl and wListCtrl.

Seealso:wImage wBitmap wIcon

Procs

proc getHandle(self: wImageList): HIMAGELIST {...}{.inline, raises: [], tags: [].}
Gets the real resource handle in system.
proc add(self: wImageList; icon: wIcon): int {...}{.discardable, raises: [NilAccessError],
    tags: [].}
Adds a new image using an icon. Return the new zero-based image index.
proc add(self: wImageList; bitmap: wBitmap; maskColor: wColor): int {...}{.discardable,
    raises: [NilAccessError], tags: [].}
Adds a new image using a bitmap and mask color. Return the new zero-based image index.
proc add(self: wImageList; bitmap: wBitmap; mask: wBitmap = nil): int {...}{.discardable,
    raises: [NilAccessError], tags: [].}
Adds a new image using a bitmap and optional mask bitmap. Return the new zero-based image index.
proc add(self: wImageList; image: wImage): int {...}{.discardable,
    raises: [NilAccessError, Exception, wBitmapError], tags: [RootEffect].}
Adds a new image using a image.
proc replace(self: wImageList; index: int; icon: wIcon): bool {...}{.discardable,
    raises: [NilAccessError], tags: [].}
Replaces the existing image with the new image.
proc replace(self: wImageList; index: int; bitmap: wBitmap; mask: wBitmap = nil): bool {...}{.
    discardable, raises: [NilAccessError], tags: [].}
Replaces the existing image with the new image.
proc replace(self: wImageList; index: int; image: wImage): bool {...}{.discardable,
    raises: [NilAccessError, Exception, wBitmapError], tags: [RootEffect].}
Replaces the existing image with the new image.
proc remove(self: wImageList; index: int): bool {...}{.discardable, raises: [], tags: [].}
Removes the image at the given position.
proc removeAll(self: wImageList): bool {...}{.discardable, raises: [], tags: [].}
Removes all the images in the list.
proc getImageCount(self: wImageList): int {...}{.raises: [], tags: [].}
Returns the number of images in the list.
proc getSize(self: wImageList): wSize {...}{.raises: [], tags: [].}
Retrieves the size of the images in the list.
proc getBitmap(self: wImageList; index: int): wBitmap {...}{.
    raises: [Exception, wBitmapError], tags: [RootEffect].}
Create the bitmap from specified index.
proc getIcon(self: wImageList; index: int): wIcon {...}{.raises: [Exception, wIconError],
    tags: [RootEffect].}
Create the icon from specified index.
proc len(self: wImageList): int {...}{.raises: [], tags: [].}
proc delete(self: wImageList) {...}{.raises: [], tags: [].}
Delete the imagelist.
proc final(self: wImageList) {...}{.raises: [], tags: [].}
Default finalizer for wImageList.
proc init(self: wImageList; width: int; height: int; mask = false; initialCount = 1) {...}{.
    inline, raises: [], tags: [].}
Initializes a image list by specifying the image size, whether image masks should be created, and the initial size of the list.
proc ImageList(width: int; height: int; mask = false; initialCount = 1): wImageList {...}{.
    inline, discardable, raises: [], tags: [].}
Constructor.
proc init(self: wImageList; size: wSize; mask = false; initialCount = 1) {...}{.inline,
    raises: [], tags: [].}
Initializes a image list by specifying the image size, whether image masks should be created, and the initial size of the list.
proc ImageList(size: wSize; mask = false; initialCount = 1): wImageList {...}{.inline,
    discardable, raises: [], tags: [].}
Constructor.