/*************************************************************************
 *
 *  $RCSfile: XImageProducer.idl,v $
 *
 *  $Revision: 1.2 $
 *
 *  last change: $Author: mi $ $Date: 2000-11-06 13:14:20 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (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.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_awt_XImageProducer_idl__
#define __com_sun_star_awt_XImageProducer_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_awt_XImageConsumer_idl__
#include <com/sun/star/awt/XImageConsumer.idl>
#endif


//=============================================================================

 module com {  module sun {  module star {  module awt {

//=============================================================================

// DocMerge from idl: interface com::sun::star::awt::XImageProducer
/** specifies a source for an image.
 */
[ uik(E227A51F-33D6-11D1-AABE00A0-249D5590), ident( "XImageProducer", 1.0 ) ]
interface XImageProducer: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::awt::XImageProducer::addConsumer
    /** registers an image consumer with the
        image producer for accessing the image data
        during a later reconstruction of the image.



        <p>The image producer may, at its
        discretion, start delivering the image data to the consumer
        using the <type>XImageConsumer</type> interface immediately, or when the
        next available image reconstruction is triggered by a call
        to the startProduction method.</p>
     */
    [oneway] void addConsumer( [in] com::sun::star::awt::XImageConsumer xConsumer );

    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::awt::XImageProducer::removeConsumer
    /** removes the given <type scope="com::sun::star::awt">XImageConsumer</type> 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.
     */
    [oneway] void removeConsumer( [in] com::sun::star::awt::XImageConsumer xConsumer );

    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::awt::XImageProducer::startProduction
    /** registers the given image consumer as a consumer
        and starts an immediate reconstruction of the image data.



        <p>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.</p>
     */
    [oneway] void startProduction();

};

//=============================================================================

}; }; }; };

/*=============================================================================

    $Log: not supported by cvs2svn $
    Revision 1.1.1.1  2000/09/18 23:34:53  hjs
    initial import

    Revision 1.5  2000/09/11 11:52:08  mi
    documentation merged from XML

    Revision 1.3  2000/05/16 12:19:53  mi
    documentation

    Revision 1.2  2000/02/07 11:24:16  mi
    zu #70728# missing documentation marked

    Revision 1.1.1.1  1999/11/11 09:48:40  jsc
    new


=============================================================================*/
#endif