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_UnoControlRoadmap_idl__
28#define __com_sun_star_awt_UnoControlRoadmap_idl__
29
30#ifndef __com_sun_star_awt_UnoControl_idl__
31#include <com/sun/star/awt/UnoControl.idl>
32#endif
33
34#ifndef __com_sun_star_awt_XItemEventBroadcaster_idl__
35#include <com/sun/star/awt/XItemEventBroadcaster.idl>
36#endif
37
38#ifndef __com_sun_star_beans_XPropertyChangeListener_idl__
39#include <com/sun/star/beans/XPropertyChangeListener.idl>
40#endif
41
42
43
44//=============================================================================
45
46 module com {  module sun {  module star {  module awt {
47
48//=============================================================================
49
50/** specifies a Roadmap control. The model of the Roadmap control must be a
51    <type>UnoControlRoadmapModel</type>
52
53    <p>The model properties are implemented in the control as follows:
54    <ul><li>CurrentItem: The RGB code of the background color is RGB(194, 211, 238)</li>
55        <li>ImageURL: The image referenced by the URL is placed in the lower right corner
56            of the control.</li>
57        <li>Graphic: The graphic is placed in the lower right corner of the control.</li>
58        <li>Complete: When set to <FALSE/> a non interactive RoadmapItem is appended
59            after the last roadmap item, labeled with three dots, indicating incompleteness.</li>
60        <li>Interactive: When activating a RoadmapItem (see <type>RoadmapItem</type>) the
61            information about which Item has been selected is passed over when an itemlistener
62            has been registered at the control.</li>
63    </ul></p>
64*/
65service UnoControlRoadmap
66{
67	service com::sun::star::awt::UnoControl;
68
69	/** This interface allows to add an Itemlistener to the roadmap.
70	    If the property "Interactive" at the com::sun::star::awt::UnoControlRoadmapModel
71	    is set to 'true' the listener is triggered each time the user selects a RoadmapItem
72	    by Mouseclick or pressing space bar at the currently focussed RoadmapItem.
73	    The property ItemID of the com::sun::star::awt::ItemEvent:: is assigned
74	    the value of the property "ID" of the activated RoadmapItem.
75	 */
76	interface com::sun::star::awt::XItemEventBroadcaster;
77
78
79};
80//=============================================================================
81
82}; }; }; };
83
84
85#endif
86