| /************************************************************** |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| #ifndef __com_sun_star_awt_XImageConsumer_idl__ |
| #define __com_sun_star_awt_XImageConsumer_idl__ |
| |
| #ifndef __com_sun_star_uno_XInterface_idl__ |
| #include <com/sun/star/uno/XInterface.idl> |
| #endif |
| |
| //============================================================================= |
| |
| module com { module sun { module star { module awt { |
| |
| published interface XImageProducer; |
| |
| //============================================================================= |
| |
| /** specifies a data sink for an image. |
| |
| <p>An image consumer is a component which wants to display or just |
| receive an image from an image producer.</p> |
| |
| @see XImageProducer |
| */ |
| published interface XImageConsumer: com::sun::star::uno::XInterface |
| { |
| //------------------------------------------------------------------------- |
| |
| /** initializes the consumer with image dimensions. |
| */ |
| [oneway] void init( [in] long Width, |
| [in] long Height ); |
| |
| //------------------------------------------------------------------------- |
| |
| /** changes color model for next pixels |
| typically called once after initialization. |
| */ |
| [oneway] void setColorModel( [in] short BitCount, |
| [in] sequence<long> RGBAPal, |
| [in] long RedMask, |
| [in] long GreenMask, |
| [in] long BlueMask, |
| [in] long AlphaMask ); |
| |
| //------------------------------------------------------------------------- |
| |
| /** delivers a chunk of pixels as <atom>long</atom> values. |
| |
| <p>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 * <var>nScanSize</var> |
| + m + nOffset).</p> |
| */ |
| [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 ); |
| |
| //------------------------------------------------------------------------- |
| |
| /** delivers a chunk of pixels as <atom>byte</atom> values. |
| |
| <p>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 * <var>nScanSize</var> |
| + m + nOffset).</p> |
| */ |
| [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 ); |
| |
| //------------------------------------------------------------------------- |
| |
| /** is called for the notification of the degree to which the |
| image is delivered. |
| |
| <p>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.</p> |
| */ |
| [oneway] void complete( [in] long Status, |
| [in] XImageProducer xProducer ); |
| |
| }; |
| |
| //============================================================================= |
| |
| }; }; }; }; |
| |
| #endif |