offapi/com/sun/star/awt/XImageProducer.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XImageProducer.idl,v $
  10  * $Revision: 1.12 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_awt_XImageProducer_idl__
  31 #define __com_sun_star_awt_XImageProducer_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_awt_XImageConsumer_idl__
  38 #include <com/sun/star/awt/XImageConsumer.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44  module com {  module sun {  module star {  module awt {
  45
  46 //=============================================================================
  47
  48 /** specifies a source for an image.
  49  */
  50 published interface XImageProducer: com::sun::star::uno::XInterface
  51 {
  52     //-------------------------------------------------------------------------
  53
  54     /** registers an image consumer with the image producer for accessing
  55         the image data during a later reconstruction of the image.
  56
  57         <p>The image producer may, at its discretion, start delivering the
  58         image data to the consumer using the <type>XImageConsumer</type>
  59         interface immediately, or when the next available image reconstruction
  60         is triggered by a call to the startProduction method.</p>
  61      */
  62     [oneway] void addConsumer( [in] com::sun::star::awt::XImageConsumer xConsumer );
  63
  64     //-------------------------------------------------------------------------
  65
  66     /** removes the given <type scope="com::sun::star::awt">XImageConsumer</type>
  67         callback from the list of consumers currently registered to receive
  68         image data.
  69
  70         <p>It is not considered an error to remove a consumer that is not
  71         currently registered. The image producer should stop sending data
  72         to this consumer as soon as it is feasible.</p>
  73      */
  74     [oneway] void removeConsumer( [in] com::sun::star::awt::XImageConsumer xConsumer );
  75
  76     //-------------------------------------------------------------------------
  77
  78     /** registers the given image consumer as a consumer
  79         and starts an immediate reconstruction of the image data.
  80
  81         <p>The image data will then be delivered to this consumer and any other
  82         consumer which may have already been registered with the producer.
  83         This method differs from the addConsumer method in that a reproduction of
  84         the image data should be triggered as soon as possible.</p>
  85      */
  86     [oneway] void startProduction();
  87
  88 };
  89
  90 //=============================================================================
  91
  92 }; }; }; };
  93
  94 #endif