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