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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_awt_RoadmapItem_idl__
  29 #define __com_sun_star_awt_RoadmapItem_idl__
  30
  31
  32
  33 //=============================================================================
  34
  35  module com {  module sun {  module star {  module awt {
  36
  37 //=============================================================================
  38
  39 /* specifies a RoadmapItem which serves as an Element in a Container like the Roadmap
  40  * specified in com::sun::star::awt::UnoControlRoadmapModel and
  41  * com::sun::star::awt::UnoControlRoadmap
  42  */
  43 service RoadmapItem
  44 {
  45     /** The ID uniquely identifies the roadmap item.
  46      *  When the RoadmapItem is inserted into the Roadmap via "insertByIndex"
  47      *  the default value of the ID is the first available absolute digit that
  48      *  has not yet been assigned to other existing RoadmapItems.
  49     */
  50      [property] short ID;
  51
  52     /** The Label of the RoadmapItem does not include its Prefix that is automatically
  53      * set after the following algorithm:
  54      * (Index + 1) + ". " + Label
  55      */
  56     [property] string Label;
  57
  58
  59     /** When "Interactive" is true the RoadmapItem supports a certain "HyperLabel
  60      *  functionality":
  61      *  Moving the mouse pointer over the RoadmapItem will change it to a Refhand and
  62      *  underline the Label for the time the mouse pointer resides over the RoadmapItem.
  63      *  Clicking with mouse pointer will then notify the Roadmap Container.
  64      *  The property Interactive" is readonly because it is adapted from the container of the
  65      *  RoadmapItem.
  66      */
  67     [property] boolean Interactive;
  68
  69
  70     /** determines whether a control is enabled or disabled.
  71      */
  72     [property] boolean Enabled;
  73 };
  74
  75 //=============================================================================
  76
  77 }; }; }; };
  78
  79 #endif
  80
  81 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */