offapi/com/sun/star/form/component/DatabaseImageControl.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: DatabaseImageControl.idl,v $
  10  * $Revision: 1.11 $
  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_form_component_DatabaseImageControl_idl__
  31 #define __com_sun_star_form_component_DatabaseImageControl_idl__
  32
  33 #ifndef __com_sun_star_awt_UnoControlImageControlModel_idl__
  34 #include <com/sun/star/awt/UnoControlImageControlModel.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_form_DataAwareControlModel_idl__
  38 #include <com/sun/star/form/DataAwareControlModel.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_form_XImageProducerSupplier_idl__
  42 #include <com/sun/star/form/XImageProducerSupplier.idl>
  43 #endif
  44
  45
  46 //=============================================================================
  47
  48  module com {  module sun {  module star {  module form {  module component {
  49
  50 //=============================================================================
  51
  52 /** specifies the model of a control used for displaying images stored in a database.
  53
  54     <p>As every <type scope="com::sun::star::form">DataAwareControlModel</type>, an image control
  55     can be bound to a database field. This means that for instance with every record change, the content
  56     of the database field is taken, interpreted as image, and displayed in the control.<br/>
  57     Unlike other more text-based controls, it does not interpret the content of the field as text or double,
  58     but as binary stream (see <member scope="com::sun::star::sdb">XColumn::getBinaryStream</member>).</p>
  59
  60     <p>Usually, an image control model can be bound to binary columns only,     namely
  61     <member scope="com::sun::star::sdbc">DataType::BINARY</member>,
  62     <member scope="com::sun::star::sdbc">DataType::VARBINARY</member>,
  63     <member scope="com::sun::star::sdbc">DataType::LONGVARBINARY</member>,
  64     <member scope="com::sun::star::sdbc">DataType::OTHER</member>,
  65     <member scope="com::sun::star::sdbc">DataType::LONGVARCHAR</member></p>
  66
  67     <p/>
  68
  69     <p>Note that besides taking the image to be displayed from the bound field, there is another option. The
  70     <member scope="com::sun::star::awt">UnoControlImageControlModel::ImageURL</member> property specifies
  71     the URL of an image to be displayed. If this property is changed from outside, the respective file
  72     is loaded and set as image source.</p>
  73
  74     <p>In a usual data form, the scenario will be as follows:
  75         <ul><li>There is a DatabaseImageControl as part of the document model, which acts as
  76                 control model for an <type scope="com::sun::star::form::control">ImageControl</type>.</li>
  77
  78             <li>The control is an <type scope="com::sun::star::awt">XImageConsumer</type> for the
  79                 <type scope="com::sun::star::awt">XImageProducer</type> supplied by the model.</li>
  80
  81             <li>Whenever the form's cursor is positioned on a new record, the column the control
  82                 model is bound to is examined for a binary data stream. This stream is set as source
  83                 at the image producer, which notifies it's consumers, which leads to the control
  84                 displaying the image.</li>
  85
  86             <li>When the user by some interaction tells the control to contain a new image, this is
  87                 exchanged by URL. For example, implementations of the control service may allow the user
  88                 to browse for image. After this, the URL of the image is set as
  89                 <member scope="com::sun::star::awt">UnoControlImageControlModel::ImageURL</member>
  90                 property at the model.<br/>
  91                 Now the control loads the image determined by the property value, and starts producing
  92                 a new data stream, which is displayed by the control (which is a consumer for this stream).<br/>
  93                 From now on, the control and thus the database record counts as modified. If the cursor of the
  94                 form is moved further, the modified record is saved, means the content of the image pointed to
  95                 by <member scope="com::sun::star::awt">UnoControlImageControlModel::ImageURL</member>
  96                 is saved into the column.</li>
  97         </ul>
  98     </p>
  99  */
 100 published service DatabaseImageControl
 101 {
 102     service com::sun::star::awt::UnoControlImageControlModel;
 103
 104     service com::sun::star::form::DataAwareControlModel;
 105
 106     /** supplies the caller with an <type scope="com::sun::star::awt">XImageProducer</type>.
 107
 108         <p>Other components can register as <type scope="com::sun::star::awt">XImageConsumer</type>
 109         at this producer. Then they will be notified of any change in the image to be displayed.</p>
 110      */
 111     interface com::sun::star::form::XImageProducerSupplier;
 112
 113     //-------------------------------------------------------------------------
 114
 115     /** indicates if it is possible to change the image being displayed.
 116      */
 117     [property] boolean ReadOnly;
 118
 119 };
 120
 121 //=============================================================================
 122
 123 }; }; }; }; };
 124
 125 #endif