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