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