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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /**
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_awt_UnoControlRoadmap_idl__
  20 #define __com_sun_star_awt_UnoControlRoadmap_idl__
  21
  22 #include <com/sun/star/awt/UnoControl.idl>
  23 #include <com/sun/star/awt/XItemEventBroadcaster.idl>
  24 #include <com/sun/star/beans/XPropertyChangeListener.idl>
  25
  26
  27
  28
  29  module com {  module sun {  module star {  module awt {
  30
  31
  32 /** specifies a Roadmap control. The model of the Roadmap control must be a
  33     <type>UnoControlRoadmapModel</type>
  34
  35     <p>The model properties are implemented in the control as follows:
  36     <ul><li>CurrentItem: The RGB code of the background color is RGB(194, 211, 238)</li>
  37         <li>ImageURL: The image referenced by the URL is placed in the lower right corner
  38             of the control.</li>
  39         <li>Graphic: The graphic is placed in the lower right corner of the control.</li>
  40         <li>Complete: When set to <FALSE/> a non interactive RoadmapItem is appended
  41             after the last roadmap item, labeled with three dots, indicating incompleteness.</li>
  42         <li>Interactive: When activating a RoadmapItem (see <type>RoadmapItem</type>) the
  43             information about which Item has been selected is passed over when an itemlistener
  44             has been registered at the control.</li>
  45     </ul></p>
  46 */
  47 service UnoControlRoadmap
  48 {
  49     service com::sun::star::awt::UnoControl;
  50
  51     /** This interface allows to add an Itemlistener to the roadmap.
  52         If the property "Interactive" at the com::sun::star::awt::UnoControlRoadmapModel
  53         is set to "true" the listener is triggered each time the user selects a RoadmapItem
  54         by Mouse click or pressing space bar at the currently focused RoadmapItem.
  55         The property ItemID of the com::sun::star::awt::ItemEvent:: is assigned
  56         the value of the property "ID" of the activated RoadmapItem.
  57      */
  58     interface com::sun::star::awt::XItemEventBroadcaster;
  59
  60
  61 };
  62
  63 }; }; }; };
  64
  65
  66 #endif
  67
  68 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */