xref: /AOO41X/main/offapi/com/sun/star/awt/RoadmapItem.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
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_RoadmapItem_idl__
24#define __com_sun_star_awt_RoadmapItem_idl__
25
26
27
28//=============================================================================
29
30 module com {  module sun {  module star {  module awt {
31
32//=============================================================================
33
34/* specifies a RoadmapItem which serves as an Element in a Container like the Roadmap
35 * specified in com::sun::star::awt::UnoControlRoadmapModel and
36 * com::sun::star::awt::UnoControlRoadmap
37 */
38service RoadmapItem
39{
40    /** The ID uniquely identifies the roadmap item.
41     *  When the RoadmapItem is inserted into the Roadmap via "insertByIndex"
42     *  the default value of the ID is the first available absolute digit that
43     *  has not yet been assigned to other existing RoadmapItems.
44    */
45    [property] short ID;
46
47    /** The Label of the RoadmapItem does not include its Prefix that is auto
48     * matically set after the following algorithm:
49     * (Index + 1) + ". " + Label
50     */
51    [property] string Label;
52
53
54    /** When "Interactive" is true the RoadmapItem supports a certain "HyperLabel
55     *  functionality":
56     *  Moving the Mousepointer over the RoadmapItem will change it to a Refhand and
57     *  underline the Label for the time the mousepointer resides over the RoadmapItem.
58     *  Clicking the mousepointer will then notify the Roadmap Container.
59     *  The property Interactive" is readonly because it is adapted from the container of the
60     *  RoadmapItem.
61     */
62    [property] boolean Interactive;
63
64
65    /** determines whether a control is enabled or disabled.
66     */
67    [property] boolean Enabled;
68};
69
70//=============================================================================
71
72}; }; }; };
73
74#endif
75