Top   Module   Use   Manual   Index 
 EXPORTING SERVICES | METHODS' SUMMARY | METHODS' DETAILS 

com :: sun :: star :: awt ::

interface XImageConsumer

Base Interface
com::sun::star::uno::XInterface

Description
specifies a data sink for an image, or in other words, an interface for a component which wants to display or just receive an image from an image producer.
See also
XImageProducer


Methods' Summary

init This initializes the consumer with image dimensions.
setColorModel changes color model for next pixels typically called once after initialization.
setPixelsByBytes delivers a chunk of pixels as long values.
setPixelsByLongs delivers a chunk of pixels as byte values.
complete is called for the notification of the degree to which the image is delivered.

Methods' Details

init
 
[ oneway ] void
init(
[ in ] long Width,
[ in ] long Height );

Description
This initializes the consumer with image dimensions.
setColorModel
 
[ oneway ] void
setColorModel(
[ in ] short BitCount,
[ in ] sequence< long > RGBAPal,
[ in ] long RedMask,
[ in ] long GreenMask,
[ in ] long BlueMask,
[ in ] long AlphaMask );

Description
changes color model for next pixels typically called once after initialization.
setPixelsByBytes
 
[ oneway ] void
setPixelsByBytes(
[ in ] long nX,
[ in ] long nY,
[ in ] long nWidth,
[ in ] long nHeight,
[ in ] sequence< byte > aProducerData,
[ in ] long nOffset,
[ in ] long nScanSize );

Description
delivers a chunk of pixels as long values.

The pixels of the image are delivered using one or more calls to this method. Each call specifies the location and size of the rectangle of source pixels that are contained in the array of pixels. The specified color model object should be used to convert the pixels into their corresponding color and alpha components. Pixel (m,n) is stored in the pixels array at index (n * nScanSize + m + nOffset).

setPixelsByLongs
 
[ oneway ] void
setPixelsByLongs(
[ in ] long nX,
[ in ] long nY,
[ in ] long nWidth,
[ in ] long nHeight,
[ in ] sequence< long > aProducerData,
[ in ] long nOffset,
[ in ] long nScanSize );

Description
delivers a chunk of pixels as byte values.

The pixels of the image are delivered using one or more calls to this method. Each call specifies the location and size of the rectangle of source pixels that are contained in the array of pixels. The specified color model object should be used to convert the pixels into their corresponding color and alpha components. Pixel (m,n) is stored in the pixels array at index (n * nScanSize + m + nOffset).

complete
 
[ oneway ] void
complete(
[ in ] long Status,
[ in ] com::sun::star::awt::XImageProducer xProducer );

Description
is called for the notification of the degree to which the image is delivered.

The complete method is called when the image producer has finished delivering all of the pixels that the source image contains, or when a single frame of a multi-frame animation has been completed, or when an error in loading or producing the image has occurred. The image consumer should remove itself from the list of consumers registered with the image producer at this time, unless it is interested in successive frames.


Top of Page