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