offapi/com/sun/star/awt/UnoControlRoadmapModel.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: UnoControlRoadmapModel.idl,v $
  10  * $Revision: 1.5 $
  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_UnoControlRoadmapModel_idl__
  31 #define __com_sun_star_awt_UnoControlRoadmapModel_idl__
  32
  33
  34 #ifndef __com_sun_star_awt_UnoControlModel_idl__
  35 #include <com/sun/star/awt/UnoControlModel.idl>
  36 #endif
  37 #ifndef __com_sun_star_container_XIndexContainer_idl__
  38 #include <com/sun/star/container/XIndexContainer.idl>
  39 #endif
  40 #ifndef __com_sun_star_beans_XPropertyChangeListener_idl__
  41 #include <com/sun/star/beans/XPropertyChangeListener.idl>
  42 #endif
  43 #ifndef com_sun_star_graphic_XGraphic_idl
  44 #include <com/sun/star/graphic/XGraphic.idl>
  45 #endif
  46
  47 //=============================================================================
  48
  49  module com {  module sun {  module star {  module awt {
  50
  51 //=============================================================================
  52
  53 /** specifies the standard model of an <type>UnoControlContainer</type>.
  54  */
  55 service UnoControlRoadmapModel
  56 {
  57     service com::sun::star::awt::UnoControlModel;
  58
  59     /** The control serves as an indexed container typically for RoadmapItems
  60         as specified in com::sun::star::awt:RoadmapItem. The RoadmapItems are
  61         held in a sequence.
  62         When inserting such items their ID is set equal to the Index of their
  63         insertion by default.
  64         After removing items the CurrentItem property is - when beyound the upper sequence
  65         boundaries - set equal to last index of the RoadmapItem Array.
  66      */
  67     interface com::sun::star::container::XIndexContainer;
  68
  69     //-------------------------------------------------------------------------
  70
  71
  72     /** specifies the background color (RGB) of the control.
  73         The Default value is white
  74      */
  75     [property] long BackgroundColor;
  76
  77     //-------------------------------------------------------------------------
  78
  79     /** determines whether the control is interactive or not.
  80
  81         <p>A roadmap control which is interactive allows selecting its items out-of-order,
  82         by simply clicking them.</p>
  83      */
  84     [property] boolean Interactive;
  85
  86     //-------------------------------------------------------------------------
  87
  88     /** determines whether the control container is complete or not. If it is
  89         false than a non - interactive RoadmapItem is appended
  90      */
  91     [property] boolean Complete;
  92
  93
  94     //-------------------------------------------------------------------------
  95
  96     /** specifies an URL to an image to use for the control.
  97         The image is placed in the lower right corner of the control
  98         @see Graphic
  99      */
 100     [property] string ImageURL;
 101
 102     //-------------------------------------------------------------------------
 103
 104     /** specifies a graphic to be displayed on the control
 105
 106         <p>If this property is present, it interacts with the <member>ImageURL</member>in the
 107         following way:
 108         <ul><li>If <member>ImageURL</member> is set, <member>Graphic</member> will be reset
 109             to an object as loaded from the given image URL, or <NULL/> if <member>ImageURL</member>
 110             does not point to a valid image file.</li>
 111             <li>If <member>Graphic</member> is set, <member>ImageURL</member> will be reset
 112             to an empty string.</li>
 113         </ul></p>
 114
 115         @since OOo 2.1
 116      */
 117     [optional, property, transient] com::sun::star::graphic::XGraphic Graphic;
 118
 119     //-------------------------------------------------------------------------
 120
 121     /** specifies the border style of the control.
 122
 123         <pre>
 124         0: No border
 125         1: 3D border
 126         2: simple border
 127         </pre>
 128      */
 129     [property] short Border;
 130
 131     //-------------------------------------------------------------------------
 132
 133     /** specifies whether the control will be printed with the document.
 134      */
 135     [property] boolean Printable;
 136
 137     //-------------------------------------------------------------------------
 138
 139     /** specifies the text displayed in the control.
 140      */
 141     [property] string Text;
 142
 143     //-------------------------------------------------------------------------
 144
 145     /** refers to the  ID of the currently selected item. Initially this property is set to '-1'
 146         which is equal to 'undefined"
 147         If the Roadmap Item that the CurrentItemID refers to is removed the property
 148         'CurrentItemID' is set to -1
 149      */
 150     [property] short CurrentItemID;
 151
 152
 153     //-------------------------------------------------------------------------
 154
 155     /** specifies the help text of the control.
 156      */
 157     [property] string HelpText;
 158
 159
 160     //-------------------------------------------------------------------------
 161
 162     /** specifies the help URL of the control.
 163      */
 164     [property] string HelpURL;
 165
 166 };
 167
 168 //=============================================================================
 169
 170 }; }; }; };
 171
 172 #endif