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_UnoControlRoadmapModel_idl__
24#define __com_sun_star_awt_UnoControlRoadmapModel_idl__
25
26
27#ifndef __com_sun_star_awt_UnoControlModel_idl__
28#include <com/sun/star/awt/UnoControlModel.idl>
29#endif
30#ifndef __com_sun_star_container_XIndexContainer_idl__
31#include <com/sun/star/container/XIndexContainer.idl>
32#endif
33#ifndef __com_sun_star_beans_XPropertyChangeListener_idl__
34#include <com/sun/star/beans/XPropertyChangeListener.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 module com {  module sun {  module star {  module awt {
43
44//=============================================================================
45
46/** specifies the standard model of an <type>UnoControlContainer</type>.
47 */
48service UnoControlRoadmapModel
49{
50    service com::sun::star::awt::UnoControlModel;
51
52    /** The control serves as an indexed container typically for RoadmapItems
53        as specified in com::sun::star::awt:RoadmapItem. The RoadmapItems are
54        held in a sequence.
55        When inserting such items their ID is set equal to the Index of their
56        insertion by default.
57        After removing items the CurrentItem property is - when beyound the upper sequence
58        boundaries - set equal to last index of the RoadmapItem Array.
59     */
60    interface com::sun::star::container::XIndexContainer;
61
62    //-------------------------------------------------------------------------
63
64
65    /** specifies the background color (RGB) of the control.
66        The Default value is white
67     */
68    [property] long BackgroundColor;
69
70    //-------------------------------------------------------------------------
71
72    /** determines whether the control is interactive or not.
73
74        <p>A roadmap control which is interactive allows selecting its items out-of-order,
75        by simply clicking them.</p>
76     */
77    [property] boolean Interactive;
78
79    //-------------------------------------------------------------------------
80
81    /** determines whether the control container is complete or not. If it is
82        false than a non - interactive RoadmapItem is appended
83     */
84    [property] boolean Complete;
85
86
87    //-------------------------------------------------------------------------
88
89    /** specifies an URL to an image to use for the control.
90        The image is placed in the lower right corner of the control
91        @see Graphic
92     */
93    [property] string ImageURL;
94
95    //-------------------------------------------------------------------------
96
97    /** specifies a graphic to be displayed on the control
98
99        <p>If this property is present, it interacts with the <member>ImageURL</member>in the
100        following way:
101        <ul><li>If <member>ImageURL</member> is set, <member>Graphic</member> will be reset
102            to an object as loaded from the given image URL, or <NULL/> if <member>ImageURL</member>
103            does not point to a valid image file.</li>
104            <li>If <member>Graphic</member> is set, <member>ImageURL</member> will be reset
105            to an empty string.</li>
106        </ul></p>
107
108        @since OpenOffice 2.1
109     */
110    [optional, property, transient] com::sun::star::graphic::XGraphic Graphic;
111
112    //-------------------------------------------------------------------------
113
114    /** specifies the border style of the control.
115
116        <pre>
117        0: No border
118        1: 3D border
119        2: simple border
120        </pre>
121     */
122    [property] short Border;
123
124    //-------------------------------------------------------------------------
125
126    /** specifies whether the control will be printed with the document.
127     */
128    [property] boolean Printable;
129
130    //-------------------------------------------------------------------------
131
132    /** specifies the text displayed in the control.
133     */
134    [property] string Text;
135
136    //-------------------------------------------------------------------------
137
138    /** refers to the  ID of the currently selected item. Initially this property is set to '-1'
139        which is equal to 'undefined"
140        If the Roadmap Item that the CurrentItemID refers to is removed the property
141        'CurrentItemID' is set to -1
142     */
143    [property] short CurrentItemID;
144
145
146    //-------------------------------------------------------------------------
147
148    /** specifies the help text of the control.
149     */
150    [property] string HelpText;
151
152
153    //-------------------------------------------------------------------------
154
155    /** specifies the help URL of the control.
156     */
157    [property] string HelpURL;
158
159};
160
161//=============================================================================
162
163}; }; }; };
164
165#endif
166