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

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