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
  20
  21
  22
  23  module com {  module sun {  module star {  module awt {
  24
  25
  26 /** specifies a Roadmap control. The model of the Roadmap control must be a
  27     UnoControlRoadmapModel
  28
  29     <p>The model properties are implemented in the control as follows:
  30     <ul><li>CurrentItem: The RGB code of the background color is RGB(194, 211, 238)</li>
  31         <li>ImageURL: The image referenced by the URL is placed in the lower right corner
  32             of the control.</li>
  33         <li>Graphic: The graphic is placed in the lower right corner of the control.</li>
  34         <li>Complete: When set to `FALSE` a non interactive RoadmapItem is appended
  35             after the last roadmap item, labeled with three dots, indicating incompleteness.</li>
  36         <li>Interactive: When activating a RoadmapItem (see RoadmapItem) the
  37             information about which Item has been selected is passed over when an itemlistener
  38             has been registered at the control.</li>
  39     </ul></p>
  40 */
  41 service UnoControlRoadmap
  42 {
  43     service com::sun::star::awt::UnoControl;
  44
  45     /** This interface allows to add an Itemlistener to the roadmap.
  46         If the property "Interactive" at the com::sun::star::awt::UnoControlRoadmapModel
  47         is set to "true" the listener is triggered each time the user selects a RoadmapItem
  48         by Mouse click or pressing space bar at the currently focused RoadmapItem.
  49         The property ItemID of the com::sun::star::awt::ItemEvent:: is assigned
  50         the value of the property "ID" of the activated RoadmapItem.
  51      */
  52     interface com::sun::star::awt::XItemEventBroadcaster;
  53
  54
  55 };
  56
  57 }; }; }; };
  58
  59
  60 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */