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