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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_awt_XImageProducer_idl__
  20 #define __com_sun_star_awt_XImageProducer_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/awt/XImageConsumer.idl>
  25
  26
  27
  28  module com {  module sun {  module star {  module awt {
  29
  30
  31 /** specifies a source for an image.
  32  */
  33 published interface XImageProducer: com::sun::star::uno::XInterface
  34 {
  35
  36     /** registers an image consumer with the image producer for accessing
  37         the image data during a later reconstruction of the image.
  38
  39         <p>The image producer may, at its discretion, start delivering the
  40         image data to the consumer using the XImageConsumer
  41         interface immediately, or when the next available image reconstruction
  42         is triggered by a call to the startProduction method.</p>
  43      */
  44     void addConsumer( [in] com::sun::star::awt::XImageConsumer xConsumer );
  45
  46
  47     /** removes the given com::sun::star::awt::XImageConsumer
  48         callback from the list of consumers currently registered to receive
  49         image data.
  50
  51         <p>It is not considered an error to remove a consumer that is not
  52         currently registered. The image producer should stop sending data
  53         to this consumer as soon as it is feasible.</p>
  54      */
  55     void removeConsumer( [in] com::sun::star::awt::XImageConsumer xConsumer );
  56
  57
  58     /** registers the given image consumer as a consumer
  59         and starts an immediate reconstruction of the image data.
  60
  61         <p>The image data will then be delivered to this consumer and any other
  62         consumer which may have already been registered with the producer.
  63         This method differs from the addConsumer method in that a reproduction of
  64         the image data should be triggered as soon as possible.</p>
  65      */
  66     void startProduction();
  67
  68 };
  69
  70
  71 }; }; }; };
  72
  73 #endif
  74
  75 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */