xref: /aoo41x/main/offapi/com/sun/star/awt/RoadmapItem.idl (revision d1766043)
1*d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5*d1766043SAndrew Rist * distributed with this work for additional information
6*d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9*d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10*d1766043SAndrew Rist *
11*d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12*d1766043SAndrew Rist *
13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*d1766043SAndrew Rist * software distributed under the License is distributed on an
15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17*d1766043SAndrew Rist * specific language governing permissions and limitations
18*d1766043SAndrew Rist * under the License.
19*d1766043SAndrew Rist *
20*d1766043SAndrew Rist *************************************************************/
21*d1766043SAndrew Rist
22*d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_awt_RoadmapItem_idl__
24cdf0e10cSrcweir#define __com_sun_star_awt_RoadmapItem_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir
27cdf0e10cSrcweir
28cdf0e10cSrcweir//=============================================================================
29cdf0e10cSrcweir
30cdf0e10cSrcweir module com {  module sun {  module star {  module awt {
31cdf0e10cSrcweir
32cdf0e10cSrcweir//=============================================================================
33cdf0e10cSrcweir
34cdf0e10cSrcweir/* specifies a RoadmapItem which serves as an Element in a Container like the Roadmap
35cdf0e10cSrcweir * specified in com::sun::star::awt::UnoControlRoadmapModel and
36cdf0e10cSrcweir * com::sun::star::awt::UnoControlRoadmap
37cdf0e10cSrcweir */
38cdf0e10cSrcweirservice RoadmapItem
39cdf0e10cSrcweir{
40cdf0e10cSrcweir	/** The ID uniquely identifies the roadmap item.
41cdf0e10cSrcweir	 *  When the RoadmapItem is inserted into the Roadmap via "insertByIndex"
42cdf0e10cSrcweir	 *  the default value of the ID is the first available absolute digit that
43cdf0e10cSrcweir	 *  has not yet been assigned to other existing RoadmapItems.
44cdf0e10cSrcweir	*/
45cdf0e10cSrcweir 	[property] short ID;
46cdf0e10cSrcweir
47cdf0e10cSrcweir	/** The Label of the RoadmapItem does not include its Prefix that is auto
48cdf0e10cSrcweir	 * matically set after the following algorithm:
49cdf0e10cSrcweir	 * (Index + 1) + ". " + Label
50cdf0e10cSrcweir	 */
51cdf0e10cSrcweir	[property] string Label;
52cdf0e10cSrcweir
53cdf0e10cSrcweir
54cdf0e10cSrcweir	/** When "Interactive" is true the RoadmapItem supports a certain "HyperLabel
55cdf0e10cSrcweir	 *  functionality":
56cdf0e10cSrcweir	 *  Moving the Mousepointer over the RoadmapItem will change it to a Refhand and
57cdf0e10cSrcweir	 *  underline the Label for the time the mousepointer resides over the RoadmapItem.
58cdf0e10cSrcweir	 *  Clicking the mousepointer will then notify the Roadmap Container.
59cdf0e10cSrcweir	 *  The property Interactive" is readonly because it is adapted from the container of the
60cdf0e10cSrcweir	 *  RoadmapItem.
61cdf0e10cSrcweir	 */
62cdf0e10cSrcweir	[property] boolean Interactive;
63cdf0e10cSrcweir
64cdf0e10cSrcweir
65cdf0e10cSrcweir	/** determines whether a control is enabled or disabled.
66cdf0e10cSrcweir	 */
67cdf0e10cSrcweir	[property] boolean Enabled;
68cdf0e10cSrcweir};
69cdf0e10cSrcweir
70cdf0e10cSrcweir//=============================================================================
71cdf0e10cSrcweir
72cdf0e10cSrcweir}; }; }; };
73cdf0e10cSrcweir
74cdf0e10cSrcweir#endif
75