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