summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/awt/UnoControlRoadmap.idl
blob: d1eab4799d3671d68d43b8c2b0cae2d453c2f91a (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
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: UnoControlRoadmap.idl,v $
 * $Revision: 1.5 $
 *
 * 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_UnoControlRoadmap_idl__
#define __com_sun_star_awt_UnoControlRoadmap_idl__

#ifndef __com_sun_star_awt_UnoControl_idl__
#include <com/sun/star/awt/UnoControl.idl>
#endif

#ifndef __com_sun_star_awt_XItemEventBroadcaster_idl__
#include <com/sun/star/awt/XItemEventBroadcaster.idl>
#endif

#ifndef __com_sun_star_beans_XPropertyChangeListener_idl__
#include <com/sun/star/beans/XPropertyChangeListener.idl>
#endif



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

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

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

/** specifies a Roadmap control. The model of the Roadmap control must be a
    <type>UnoControlRoadmapModel</type>

    <p>The model properties are implemented in the control as follows:
    <ul><li>CurrentItem: The RGB code of the background color is RGB(194, 211, 238)</li>
        <li>ImageURL: The image referenced by the URL is placed in the lower right corner
            of the control.</li>
        <li>Graphic: The graphic is placed in the lower right corner of the control.</li>
        <li>Complete: When set to <FALSE/> a non interactive RoadmapItem is appended
            after the last roadmap item, labeled with three dots, indicating incompleteness.</li>
        <li>Interactive: When activating a RoadmapItem (see <type>RoadmapItem</type>) the
            information about which Item has been selected is passed over when an itemlistener
            has been registered at the control.</li>
    </ul></p>
*/
service UnoControlRoadmap
{
    service com::sun::star::awt::UnoControl;

    /** This interface allows to add an Itemlistener to the roadmap.
        If the property "Interactive" at the com::sun::star::awt::UnoControlRoadmapModel
        is set to 'true' the listener is triggered each time the user selects a RoadmapItem
        by Mouseclick or pressing space bar at the currently focussed RoadmapItem.
        The property ItemID of the com::sun::star::awt::ItemEvent:: is assigned
        the value of the property "ID" of the activated RoadmapItem.
     */
    interface com::sun::star::awt::XItemEventBroadcaster;


};
//=============================================================================

}; }; }; };


#endif