xref: /trunk/main/offapi/com/sun/star/awt/UnoControlImageControlModel.idl (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
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_awt_UnoControlImageControlModel_idl__
28#define __com_sun_star_awt_UnoControlImageControlModel_idl__
29
30#ifndef __com_sun_star_awt_UnoControlModel_idl__
31#include <com/sun/star/awt/UnoControlModel.idl>
32#endif
33#ifndef __com_sun_star_util_Color_idl__
34#include <com/sun/star/util/Color.idl>
35#endif
36#ifndef com_sun_star_graphic_XGraphic_idl
37#include <com/sun/star/graphic/XGraphic.idl>
38#endif
39
40
41//=============================================================================
42
43 module com {  module sun {  module star {  module awt {
44
45//=============================================================================
46
47/** specifies the standard model of an <type>UnoControlImageControl</type>.
48 */
49published service UnoControlImageControlModel
50{
51    service com::sun::star::awt::UnoControlModel;
52
53    //-------------------------------------------------------------------------
54
55    /** specifies the background color (RGB) of the control.
56     */
57    [property] com::sun::star::util::Color BackgroundColor;
58
59    //-------------------------------------------------------------------------
60
61    /** specifies the border style of the control.
62
63        <pre>
64        0: No border
65        1: 3D border
66        2: simple border
67        </pre>
68     */
69    [property] short Border;
70
71    //-------------------------------------------------------------------------
72
73    /** specifies the color of the border, if present
74
75        <p>Not every border style (see <member>Border</member>) may support coloring.
76        For instance, usually a border with 3D effect will ignore the BorderColor setting.</p>
77
78        @since OOo 2.0
79     */
80    [optional, property] long BorderColor;
81
82    //-------------------------------------------------------------------------
83
84    /** determines whether the control is enabled or disabled.
85     */
86    [property] boolean Enabled;
87
88    //-------------------------------------------------------------------------
89
90    /** specifies the help text of the control.
91     */
92    [property] string HelpText;
93
94    //-------------------------------------------------------------------------
95
96    /** specifies the help URL of the control.
97     */
98    [property] string HelpURL;
99
100    //-------------------------------------------------------------------------
101
102    /** specifies an URL to an image to use for the control.
103        @see Graphic
104     */
105    [property] string ImageURL;
106
107    //-------------------------------------------------------------------------
108
109    /** specifies a graphic to be displayed on the control
110
111        <p>If this property is present, it interacts with the <member>ImageURL</member>in the
112        following way:
113        <ul><li>If <member>ImageURL</member> is set, <member>Graphic</member> will be reset
114            to an object as loaded from the given image URL, or <NULL/> if <member>ImageURL</member>
115            does not point to a valid image file.</li>
116            <li>If <member>Graphic</member> is set, <member>ImageURL</member> will be reset
117            to an empty string.</li>
118        </ul></p>
119
120        @since OOo 2.1
121     */
122    [optional, property, transient] com::sun::star::graphic::XGraphic Graphic;
123
124    //-------------------------------------------------------------------------
125
126    /** specifies that the control will be printed with the document.
127     */
128    [property] boolean Printable;
129
130    //-------------------------------------------------------------------------
131
132    /** specifies if the image is automatically scaled to the size of the
133        control.
134     */
135    [property] boolean ScaleImage;
136
137    /** defines how to scale the image
138
139        <p>If this property is present, it supersedes the <member>ScaleImage</member> property.</p>
140
141        <p>The value of this property is one of the <type>ImageScaleMode</type> constants.</p>
142
143        @since OOo 3.1
144    */
145    [property, optional] short ScaleMode;
146
147    //-------------------------------------------------------------------------
148
149    /** specifies that the control can be reached with the TAB key.
150
151        @since OOo 1.1.2
152     */
153    [optional, property] boolean Tabstop;
154
155};
156
157//=============================================================================
158
159}; }; }; };
160
161#endif
162