Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous


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

interface XImageProducer
Description
specifies a source for an image.

Methods' Summary
addConsumer registers an image consumer with the image producer for accessing the image data during a later reconstruction of the image.  
removeConsumer removes the given XImageConsumer callback from the list of consumers currently registered to receive image data.  
startProduction registers the given image consumer as a consumer and starts an immediate reconstruction of the image data.  
Methods' Details
addConsumer
[oneway] void
addConsumer( [in] XImageConsumer  xConsumer );

Description
registers an image consumer with the image producer for accessing the image data during a later reconstruction of the image.

The image producer may, at its discretion, start delivering the image data to the consumer using the XImageConsumer interface immediately, or when the next available image reconstruction is triggered by a call to the startProduction method.

removeConsumer
[oneway] void
removeConsumer( [in] XImageConsumer  xConsumer );

Description
removes the given XImageConsumer callback from the list of consumers currently registered to receive image data.

It is not considered an error to remove a consumer that is not currently registered. The image producer should stop sending data to this consumer as soon as it is feasible.

startProduction
[oneway] void
startProduction();

Description
registers the given image consumer as a consumer and starts an immediate reconstruction of the image data.

The image data will then be delivered to this consumer and any other consumer which may have already been registered with the producer. This method differs from the addConsumer method in that a reproduction of the image data should be triggered as soon as possible.

Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.