com.goldencode.p2j.ui.ocx

Interface IImages

All Known Implementing Classes:

ListImages

public interface IImages

IImages COM interface.

Author:

mag

Method Summary

Modifier and Type	Method and Description
comhandle	add(ComParameter index, ComParameter key, ComParameter picture) Adds a ListImage object to a ListImages and returns a reference to the created object.
comhandle	add(integer index, character key, comhandle picture) Adds a ListImage object to a ListImages and returns a reference to the created object.
void	clear() Remove all objects in a collection.
integer	getCount() Returns the number of objects in a collection.
comhandle	getItem(character key) Returns a specific member of a Collection either by key.
comhandle	getItem(NumberType index) Returns a specific member of a Collection either by position.
void	remove(character key) Remove a specific member of a collection.
void	remove(NumberType index) Remove a specific member of a collection.
void	setCount(integer count) Set the number of objects in a collection.

Method Detail

add

comhandle add(ComParameter index,
              ComParameter key,
              ComParameter picture)

Adds a ListImage object to a ListImages and returns a reference to the created object.

Parameters:

index - The position inside collection, wrapped in ComParameter

key - The key to identify an image, wrapped in ComParameter

picture - The picture object reference, wrapped in ComParameter.

Returns:

The comhandle to the new created image.

add

comhandle add(integer index,
              character key,
              comhandle picture)

Adds a ListImage object to a ListImages and returns a reference to the created object.

Parameters:

index - position inside collection.

key - Key unique value to identify an image

picture - The picture object reference wrapped in comhandle.

Returns:

comhandle to the new created image.

getCount

integer getCount()

Returns the number of objects in a collection.

Returns:

Number of objects in a collection.

setCount

void setCount(integer count)

Set the number of objects in a collection.

Parameters:

count - New size of collection

getItem

comhandle getItem(NumberType index)

Returns a specific member of a Collection either by position.

Parameters:

index - Collection position

Returns:

The image handle at requested position or unknown if not found.

getItem

comhandle getItem(character key)

Returns a specific member of a Collection either by key.

Parameters:

key - Key unique value to identify a picture

Returns:

Picture at requested key or unknown if not found.

clear

void clear()

Remove all objects in a collection.

remove

void remove(NumberType index)

Remove a specific member of a collection.

Parameters:

index - position inside collection.

remove

void remove(character key)

Remove a specific member of a collection.

Parameters:

key - The image key