offapi/com/sun/star/awt/UnoControlRoadmap.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: UnoControlRoadmap.idl,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_awt_UnoControlRoadmap_idl__
  31 #define __com_sun_star_awt_UnoControlRoadmap_idl__
  32
  33 #ifndef __com_sun_star_awt_UnoControl_idl__
  34 #include <com/sun/star/awt/UnoControl.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_awt_XItemEventBroadcaster_idl__
  38 #include <com/sun/star/awt/XItemEventBroadcaster.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_beans_XPropertyChangeListener_idl__
  42 #include <com/sun/star/beans/XPropertyChangeListener.idl>
  43 #endif
  44
  45
  46
  47 //=============================================================================
  48
  49  module com {  module sun {  module star {  module awt {
  50
  51 //=============================================================================
  52
  53 /** specifies a Roadmap control. The model of the Roadmap control must be a
  54     <type>UnoControlRoadmapModel</type>
  55
  56     <p>The model properties are implemented in the control as follows:
  57     <ul><li>CurrentItem: The RGB code of the background color is RGB(194, 211, 238)</li>
  58         <li>ImageURL: The image referenced by the URL is placed in the lower right corner
  59             of the control.</li>
  60         <li>Graphic: The graphic is placed in the lower right corner of the control.</li>
  61         <li>Complete: When set to <FALSE/> a non interactive RoadmapItem is appended
  62             after the last roadmap item, labeled with three dots, indicating incompleteness.</li>
  63         <li>Interactive: When activating a RoadmapItem (see <type>RoadmapItem</type>) the
  64             information about which Item has been selected is passed over when an itemlistener
  65             has been registered at the control.</li>
  66     </ul></p>
  67 */
  68 service UnoControlRoadmap
  69 {
  70     service com::sun::star::awt::UnoControl;
  71
  72     /** This interface allows to add an Itemlistener to the roadmap.
  73         If the property "Interactive" at the com::sun::star::awt::UnoControlRoadmapModel
  74         is set to 'true' the listener is triggered each time the user selects a RoadmapItem
  75         by Mouseclick or pressing space bar at the currently focussed RoadmapItem.
  76         The property ItemID of the com::sun::star::awt::ItemEvent:: is assigned
  77         the value of the property "ID" of the activated RoadmapItem.
  78      */
  79     interface com::sun::star::awt::XItemEventBroadcaster;
  80
  81
  82 };
  83 //=============================================================================
  84
  85 }; }; }; };
  86
  87
  88 #endif