xref: /AOO41X/main/offapi/com/sun/star/awt/UnoControlImageControlModel.idl (revision d1e7efc3a14909e0a68c915b160c0a3adcc02b1f)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_awt_UnoControlImageControlModel_idl__
24#define __com_sun_star_awt_UnoControlImageControlModel_idl__
25
26#ifndef __com_sun_star_awt_UnoControlModel_idl__
27#include <com/sun/star/awt/UnoControlModel.idl>
28#endif
29#ifndef __com_sun_star_util_Color_idl__
30#include <com/sun/star/util/Color.idl>
31#endif
32#ifndef com_sun_star_graphic_XGraphic_idl
33#include <com/sun/star/graphic/XGraphic.idl>
34#endif
35
36
37//=============================================================================
38
39 module com {  module sun {  module star {  module awt {
40
41//=============================================================================
42
43/** specifies the standard model of an <type>UnoControlImageControl</type>.
44 */
45published service UnoControlImageControlModel
46{
47    service com::sun::star::awt::UnoControlModel;
48
49    //-------------------------------------------------------------------------
50
51    /** specifies the background color (RGB) of the control.
52     */
53    [property] com::sun::star::util::Color BackgroundColor;
54
55    //-------------------------------------------------------------------------
56
57    /** specifies the border style of the control.
58
59        <pre>
60        0: No border
61        1: 3D border
62        2: simple border
63        </pre>
64     */
65    [property] short Border;
66
67    //-------------------------------------------------------------------------
68
69    /** specifies the color of the border, if present
70
71        <p>Not every border style (see <member>Border</member>) may support coloring.
72        For instance, usually a border with 3D effect will ignore the BorderColor setting.</p>
73
74        @since OpenOffice 2.0
75     */
76    [optional, property] long BorderColor;
77
78    //-------------------------------------------------------------------------
79
80    /** determines whether the control is enabled or disabled.
81     */
82    [property] boolean Enabled;
83
84    //-------------------------------------------------------------------------
85
86    /** specifies the help text of the control.
87     */
88    [property] string HelpText;
89
90    //-------------------------------------------------------------------------
91
92    /** specifies the help URL of the control.
93     */
94    [property] string HelpURL;
95
96    //-------------------------------------------------------------------------
97
98    /** specifies an URL to an image to use for the control.
99        @see Graphic
100     */
101    [property] string ImageURL;
102
103    //-------------------------------------------------------------------------
104
105    /** specifies a graphic to be displayed on the control
106
107        <p>If this property is present, it interacts with the <member>ImageURL</member>in the
108        following way:
109        <ul><li>If <member>ImageURL</member> is set, <member>Graphic</member> will be reset
110            to an object as loaded from the given image URL, or <NULL/> if <member>ImageURL</member>
111            does not point to a valid image file.</li>
112            <li>If <member>Graphic</member> is set, <member>ImageURL</member> will be reset
113            to an empty string.</li>
114        </ul></p>
115
116        @since OpenOffice 2.1
117     */
118    [optional, property, transient] com::sun::star::graphic::XGraphic Graphic;
119
120    //-------------------------------------------------------------------------
121
122    /** specifies that the control will be printed with the document.
123     */
124    [property] boolean Printable;
125
126    //-------------------------------------------------------------------------
127
128    /** specifies if the image is automatically scaled to the size of the
129        control.
130     */
131    [property] boolean ScaleImage;
132
133    /** defines how to scale the image
134
135        <p>If this property is present, it supersedes the <member>ScaleImage</member> property.</p>
136
137        <p>The value of this property is one of the <type>ImageScaleMode</type> constants.</p>
138
139        @since OpenOffice 3.1
140    */
141    [property, optional] short ScaleMode;
142
143    //-------------------------------------------------------------------------
144
145    /** specifies that the control can be reached with the TAB key.
146
147        @since OpenOffice 1.1.2
148     */
149    [optional, property] boolean Tabstop;
150
151};
152
153//=============================================================================
154
155}; }; }; };
156
157#endif
158