offapi/com/sun/star/report/XImageControl.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XImageControl.idl,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_report_XImageControl_idl__
  31 #define __com_sun_star_report_XImageControl_idl__
  32
  33 #ifndef __com_sun_star_report_XReportControlModel_idl__
  34 #include <com/sun/star/report/XReportControlModel.idl>
  35 #endif
  36 #ifndef __com_sun_star_form_XImageProducerSupplier_idl__
  37 #include <com/sun/star/form/XImageProducerSupplier.idl>
  38 #endif
  39
  40 //=============================================================================
  41
  42  module com {  module sun {  module star {  module report {
  43
  44 //=============================================================================
  45 interface XImageControl
  46 {
  47     interface XReportControlModel;
  48
  49     /** supplies the caller with an <type scope="com::sun::star::awt">XImageProducer</type>.
  50
  51         <p>Other components can register as <type scope="com::sun::star::awt">XImageConsumer</type>
  52         at this producer. Then they will be notified of any change in the image to be displayed.</p>
  53
  54         <p>Whenever the <member scope="com::sun::star::awt">UnoControlImageControlModel::ImageURL</member>
  55         property is changed, the model loads the specified image, and sets it as image source
  56         at its <type scope="com::sun::star::awt">XImageProducer</type>. Then, all
  57         <type scope="com::sun::star::awt">XImageConsumer</type>s are notified and supplied with
  58         the binary data of the image.<br/>
  59         Usually, controls acting for an <type>ImageControl</type> model are consumers, and use the
  60         data stream to display the image</p>
  61      */
  62     interface com::sun::star::form::XImageProducerSupplier;
  63
  64     /** specifies an URL to an image to use for the control.
  65      */
  66     [attribute,bound] string ImageURL;
  67
  68     /** defines how to scale the image
  69
  70         <p>If this property is present, it supersedes the <member>ScaleImage</member> property.</p>
  71
  72         <p>The value of this property is one of the <type scope="com::sun::star::awt">ImageScaleMode</type> constants.</p>
  73
  74         @since OOo 3.2
  75     */
  76     [attribute,bound] short ScaleMode
  77     {
  78         set raises (com::sun::star::lang::IllegalArgumentException);
  79     };
  80
  81     /** Specifies that the IRI given in the data field should be preserved, otherwise the content will be inserted in the resulting report document.
  82         If the data field contains something different as string then this attribute will be ignored.
  83     */
  84     [attribute,bound] boolean PreserveIRI;
  85 };
  86
  87 service ImageControl : XImageControl;
  88 //=============================================================================
  89
  90 }; }; }; };
  91
  92 /*=============================================================================
  93
  94 =============================================================================*/
  95 #endif