summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/awt/UnoControlRoadmap.idl
blob: 26813bc1d7bce356c508818c6ce8bf7b8820cac9 (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
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_awt_UnoControlRoadmap_idl__
#define __com_sun_star_awt_UnoControlRoadmap_idl__

#include <com/sun/star/awt/UnoControl.idl>
#include <com/sun/star/awt/XItemEventBroadcaster.idl>
#include <com/sun/star/beans/XPropertyChangeListener.idl>




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


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

    <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 RoadmapItem) 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 Mouse click or pressing space bar at the currently focused 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

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */