offapi/com/sun/star/awt/RoadmapItem.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: RoadmapItem.idl,v $
  10  * $Revision: 1.4 $
  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_RoadmapItem_idl__
  31 #define __com_sun_star_awt_RoadmapItem_idl__
  32
  33
  34
  35 //=============================================================================
  36
  37  module com {  module sun {  module star {  module awt {
  38
  39 //=============================================================================
  40
  41 /* specifies a RoadmapItem which serves as an Element in a Container like the Roadmap
  42  * specified in com::sun::star::awt::UnoControlRoadmapModel and
  43  * com::sun::star::awt::UnoControlRoadmap
  44  */
  45 service RoadmapItem
  46 {
  47     /** The ID uniquely identifies the roadmap item.
  48      *  When the RoadmapItem is inserted into the Roadmap via "insertByIndex"
  49      *  the default value of the ID is the first available absolute digit that
  50      *  has not yet been assigned to other existing RoadmapItems.
  51     */
  52      [property] short ID;
  53
  54     /** The Label of the RoadmapItem does not include its Prefix that is auto
  55      * matically set after the following algorithm:
  56      * (Index + 1) + ". " + Label
  57      */
  58     [property] string Label;
  59
  60
  61     /** When "Interactive" is true the RoadmapItem supports a certain "HyperLabel
  62      *  functionality":
  63      *  Moving the Mousepointer over the RoadmapItem will change it to a Refhand and
  64      *  underline the Label for the time the mousepointer resides over the RoadmapItem.
  65      *  Clicking the mousepointer will then notify the Roadmap Container.
  66      *  The property Interactive" is readonly because it is adapted from the container of the
  67      *  RoadmapItem.
  68      */
  69     [property] boolean Interactive;
  70
  71
  72     /** determines whether a control is enabled or disabled.
  73      */
  74     [property] boolean Enabled;
  75 };
  76
  77 //=============================================================================
  78
  79 }; }; }; };
  80
  81 #endif