offapi/com/sun/star/report/XImageControl.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_report_XImageControl_idl__
  20 #define __com_sun_star_report_XImageControl_idl__
  21
  22 #include <com/sun/star/report/XReportControlModel.idl>
  23 #include <com/sun/star/form/XImageProducerSupplier.idl>
  24
  25
  26  module com {  module sun {  module star {  module report {
  27
  28 interface XImageControl
  29 {
  30     interface XReportControlModel;
  31
  32     /** supplies the caller with an com::sun::star::awt::XImageProducer.
  33
  34         <p>Other components can register as com::sun::star::awt::XImageConsumer
  35         at this producer. Then they will be notified of any change in the image to be displayed.</p>
  36
  37         <p>Whenever the com::sun::star::awt::UnoControlImageControlModel::ImageURL
  38         property is changed, the model loads the specified image, and sets it as image source
  39         at its com::sun::star::awt::XImageProducer. Then, all
  40         com::sun::star::awt::XImageConsumers are notified and supplied with
  41         the binary data of the image.<br/>
  42         Usually, controls acting for an ImageControl model are consumers, and use the
  43         data stream to display the image</p>
  44      */
  45     interface com::sun::star::form::XImageProducerSupplier;
  46
  47     /** specifies an URL to an image to use for the control.
  48      */
  49     [attribute,bound] string ImageURL;
  50
  51     /** defines how to scale the image
  52
  53         <p>If this property is present, it supersedes the ScaleImage property.</p>
  54
  55         <p>The value of this property is one of the com::sun::star::awt::ImageScaleMode constants.</p>
  56
  57         @since OOo 3.2
  58     */
  59     [attribute,bound] short ScaleMode
  60     {
  61         set raises (com::sun::star::lang::IllegalArgumentException);
  62     };
  63
  64     /** Specifies that the IRI given in the data field should be preserved, otherwise the content will be inserted in the resulting report document.
  65         If the data field contains something different as string then this attribute will be ignored.
  66     */
  67     [attribute,bound] boolean PreserveIRI;
  68 };
  69
  70
  71 }; }; }; };
  72
  73 #endif
  74
  75 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */