1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_form_component_DatabaseImageControl_idl__
28#define __com_sun_star_form_component_DatabaseImageControl_idl__
29
30#ifndef __com_sun_star_awt_UnoControlImageControlModel_idl__
31#include <com/sun/star/awt/UnoControlImageControlModel.idl>
32#endif
33
34#ifndef __com_sun_star_form_DataAwareControlModel_idl__
35#include <com/sun/star/form/DataAwareControlModel.idl>
36#endif
37
38#ifndef __com_sun_star_form_XImageProducerSupplier_idl__
39#include <com/sun/star/form/XImageProducerSupplier.idl>
40#endif
41
42
43//=============================================================================
44
45 module com {  module sun {  module star {  module form {  module component {
46
47//=============================================================================
48
49/** specifies the model of a control used for displaying images stored in a database.
50
51	<p>As every <type scope="com::sun::star::form">DataAwareControlModel</type>, an image control
52	can be bound to a database field. This means that for instance with every record change, the content
53	of the database field is taken, interpreted as image, and displayed in the control.<br/>
54	Unlike other more text-based controls, it does not interpret the content of the field as text or double,
55	but as binary stream (see <member scope="com::sun::star::sdb">XColumn::getBinaryStream</member>).</p>
56
57	<p>Usually, an image control model can be bound to binary columns only,	namely
58	<member scope="com::sun::star::sdbc">DataType::BINARY</member>,
59	<member scope="com::sun::star::sdbc">DataType::VARBINARY</member>,
60	<member scope="com::sun::star::sdbc">DataType::LONGVARBINARY</member>,
61	<member scope="com::sun::star::sdbc">DataType::OTHER</member>,
62	<member scope="com::sun::star::sdbc">DataType::LONGVARCHAR</member></p>
63
64	<p/>
65
66	<p>Note that besides taking the image to be displayed from the bound field, there is another option. The
67	<member scope="com::sun::star::awt">UnoControlImageControlModel::ImageURL</member> property specifies
68	the URL of an image to be displayed. If this property is changed from outside, the respective file
69	is loaded and set as image source.</p>
70
71	<p>In a usual data form, the scenario will be as follows:
72		<ul><li>There is a DatabaseImageControl as part of the document model, which acts as
73				control model for an <type scope="com::sun::star::form::control">ImageControl</type>.</li>
74
75			<li>The control is an <type scope="com::sun::star::awt">XImageConsumer</type> for the
76				<type scope="com::sun::star::awt">XImageProducer</type> supplied by the model.</li>
77
78			<li>Whenever the form's cursor is positioned on a new record, the column the control
79				model is bound to is examined for a binary data stream. This stream is set as source
80				at the image producer, which notifies it's consumers, which leads to the control
81				displaying the image.</li>
82
83			<li>When the user by some interaction tells the control to contain a new image, this is
84				exchanged by URL. For example, implementations of the control service may allow the user
85				to browse for image. After this, the URL of the image is set as
86				<member scope="com::sun::star::awt">UnoControlImageControlModel::ImageURL</member>
87				property at the model.<br/>
88				Now the control loads the image determined by the property value, and starts producing
89				a new data stream, which is displayed by the control (which is a consumer for this stream).<br/>
90				From now on, the control and thus the database record counts as modified. If the cursor of the
91				form is moved further, the modified record is saved, means the content of the image pointed to
92				by <member scope="com::sun::star::awt">UnoControlImageControlModel::ImageURL</member>
93				is saved into the column.</li>
94		</ul>
95	</p>
96 */
97published service DatabaseImageControl
98{
99	service com::sun::star::awt::UnoControlImageControlModel;
100
101	service com::sun::star::form::DataAwareControlModel;
102
103	/** supplies the caller with an <type scope="com::sun::star::awt">XImageProducer</type>.
104
105		<p>Other components can register as <type scope="com::sun::star::awt">XImageConsumer</type>
106		at this producer. Then they will be notified of any change in the image to be displayed.</p>
107	 */
108	interface com::sun::star::form::XImageProducerSupplier;
109
110	//-------------------------------------------------------------------------
111
112	/** indicates if it is possible to change the image being displayed.
113	 */
114	[property] boolean ReadOnly;
115
116};
117
118//=============================================================================
119
120}; }; }; }; };
121
122#endif
123