summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/awt/UnoControlRoadmapModel.idl
blob: 65f5380c6e1f3d38fedad501e2db5a51924cfcb4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_awt_UnoControlRoadmapModel_idl__
#define __com_sun_star_awt_UnoControlRoadmapModel_idl__


#ifndef __com_sun_star_awt_UnoControlModel_idl__
#include <com/sun/star/awt/UnoControlModel.idl>
#endif
#ifndef __com_sun_star_container_XIndexContainer_idl__
#include <com/sun/star/container/XIndexContainer.idl>
#endif
#ifndef __com_sun_star_beans_XPropertyChangeListener_idl__
#include <com/sun/star/beans/XPropertyChangeListener.idl>
#endif
#ifndef com_sun_star_graphic_XGraphic_idl
#include <com/sun/star/graphic/XGraphic.idl>
#endif

//=============================================================================

 module com {  module sun {  module star {  module awt {

//=============================================================================

/** specifies the standard model of an <type>UnoControlContainer</type>.
 */
service UnoControlRoadmapModel
{
    service com::sun::star::awt::UnoControlModel;

    /** The control serves as an indexed container typically for RoadmapItems
        as specified in com::sun::star::awt:RoadmapItem. The RoadmapItems are
        held in a sequence.
        When inserting such items their ID is set equal to the Index of their
        insertion by default.
        After removing items the CurrentItem property is - when beyound the upper sequence
        boundaries - set equal to last index of the RoadmapItem Array.
     */
    interface com::sun::star::container::XIndexContainer;

    //-------------------------------------------------------------------------


    /** specifies the background color (RGB) of the control.
        The Default value is white
     */
    [property] long BackgroundColor;

    //-------------------------------------------------------------------------

    /** determines whether the control is interactive or not.

        <p>A roadmap control which is interactive allows selecting its items out-of-order,
        by simply clicking them.</p>
     */
    [property] boolean Interactive;

    //-------------------------------------------------------------------------

    /** determines whether the control container is complete or not. If it is
        false than a non - interactive RoadmapItem is appended
     */
    [property] boolean Complete;


    //-------------------------------------------------------------------------

    /** specifies an URL to an image to use for the control.
        The image is placed in the lower right corner of the control
        @see Graphic
     */
    [property] string ImageURL;

    //-------------------------------------------------------------------------

    /** specifies a graphic to be displayed on the control

        <p>If this property is present, it interacts with the <member>ImageURL</member>in the
        following way:
        <ul><li>If <member>ImageURL</member> is set, <member>Graphic</member> will be reset
            to an object as loaded from the given image URL, or <NULL/> if <member>ImageURL</member>
            does not point to a valid image file.</li>
            <li>If <member>Graphic</member> is set, <member>ImageURL</member> will be reset
            to an empty string.</li>
        </ul></p>

        @since OOo 2.1
     */
    [optional, property, transient] com::sun::star::graphic::XGraphic Graphic;

    //-------------------------------------------------------------------------

    /** specifies the border style of the control.

        <pre>
        0: No border
        1: 3D border
        2: simple border
        </pre>
     */
    [property] short Border;

    //-------------------------------------------------------------------------

    /** specifies whether the control will be printed with the document.
     */
    [property] boolean Printable;

    //-------------------------------------------------------------------------

    /** specifies the text displayed in the control.
     */
    [property] string Text;

    //-------------------------------------------------------------------------

    /** refers to the  ID of the currently selected item. Initially this property is set to '-1'
        which is equal to 'undefined"
        If the Roadmap Item that the CurrentItemID refers to is removed the property
        'CurrentItemID' is set to -1
     */
    [property] short CurrentItemID;


    //-------------------------------------------------------------------------

    /** specifies the help text of the control.
     */
    [property] string HelpText;


    //-------------------------------------------------------------------------

    /** specifies the help URL of the control.
     */
    [property] string HelpURL;

};

//=============================================================================

}; }; }; };

#endif