offapi/com/sun/star/awt/RoadmapItem.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 RoadmapItem which serves as an Element in a Container like the Roadmap
  27  * specified in com::sun::star::awt::UnoControlRoadmapModel and
  28  * com::sun::star::awt::UnoControlRoadmap
  29  */
  30 service RoadmapItem
  31 {
  32     /** The ID uniquely identifies the roadmap item.
  33      *  When the RoadmapItem is inserted into the Roadmap via "insertByIndex"
  34      *  the default value of the ID is the first available absolute digit that
  35      *  has not yet been assigned to other existing RoadmapItems.
  36     */
  37      [property] short ID;
  38
  39     /** The Label of the RoadmapItem does not include its Prefix that is automatically
  40      * set after the following algorithm:
  41      * (Index + 1) + ". " + Label
  42      */
  43     [property] string Label;
  44
  45
  46     /** When "Interactive" is true the RoadmapItem supports a certain "HyperLabel
  47      *  functionality":
  48      *  Moving the mouse pointer over the RoadmapItem will change it to a Refhand and
  49      *  underline the Label for the time the mouse pointer resides over the RoadmapItem.
  50      *  Clicking with mouse pointer will then notify the Roadmap Container.
  51      *  The property Interactive" is readonly because it is adapted from the container of the
  52      *  RoadmapItem.
  53      */
  54     [property] boolean Interactive;
  55
  56
  57     /** determines whether a control is enabled or disabled.
  58      */
  59     [property] boolean Enabled;
  60 };
  61
  62
  63 }; }; }; };
  64
  65 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */