1d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5d1766043SAndrew Rist * distributed with this work for additional information 6d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10d1766043SAndrew Rist * 11d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12d1766043SAndrew Rist * 13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14d1766043SAndrew Rist * software distributed under the License is distributed on an 15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17d1766043SAndrew Rist * specific language governing permissions and limitations 18d1766043SAndrew Rist * under the License. 19d1766043SAndrew Rist * 20d1766043SAndrew Rist *************************************************************/ 21d1766043SAndrew Rist 22d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_awt_UnoControlRoadmapModel_idl__ 24cdf0e10cSrcweir#define __com_sun_star_awt_UnoControlRoadmapModel_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir 27cdf0e10cSrcweir#ifndef __com_sun_star_awt_UnoControlModel_idl__ 28cdf0e10cSrcweir#include <com/sun/star/awt/UnoControlModel.idl> 29cdf0e10cSrcweir#endif 30cdf0e10cSrcweir#ifndef __com_sun_star_container_XIndexContainer_idl__ 31cdf0e10cSrcweir#include <com/sun/star/container/XIndexContainer.idl> 32cdf0e10cSrcweir#endif 33cdf0e10cSrcweir#ifndef __com_sun_star_beans_XPropertyChangeListener_idl__ 34cdf0e10cSrcweir#include <com/sun/star/beans/XPropertyChangeListener.idl> 35cdf0e10cSrcweir#endif 36cdf0e10cSrcweir#ifndef com_sun_star_graphic_XGraphic_idl 37cdf0e10cSrcweir#include <com/sun/star/graphic/XGraphic.idl> 38cdf0e10cSrcweir#endif 39cdf0e10cSrcweir 40cdf0e10cSrcweir//============================================================================= 41cdf0e10cSrcweir 42cdf0e10cSrcweir module com { module sun { module star { module awt { 43cdf0e10cSrcweir 44cdf0e10cSrcweir//============================================================================= 45cdf0e10cSrcweir 46cdf0e10cSrcweir/** specifies the standard model of an <type>UnoControlContainer</type>. 47cdf0e10cSrcweir */ 48cdf0e10cSrcweirservice UnoControlRoadmapModel 49cdf0e10cSrcweir{ 50cdf0e10cSrcweir service com::sun::star::awt::UnoControlModel; 51cdf0e10cSrcweir 52cdf0e10cSrcweir /** The control serves as an indexed container typically for RoadmapItems 53cdf0e10cSrcweir as specified in com::sun::star::awt:RoadmapItem. The RoadmapItems are 54cdf0e10cSrcweir held in a sequence. 55cdf0e10cSrcweir When inserting such items their ID is set equal to the Index of their 56cdf0e10cSrcweir insertion by default. 57cdf0e10cSrcweir After removing items the CurrentItem property is - when beyound the upper sequence 58cdf0e10cSrcweir boundaries - set equal to last index of the RoadmapItem Array. 59cdf0e10cSrcweir */ 60cdf0e10cSrcweir interface com::sun::star::container::XIndexContainer; 61cdf0e10cSrcweir 62cdf0e10cSrcweir //------------------------------------------------------------------------- 63cdf0e10cSrcweir 64cdf0e10cSrcweir 65cdf0e10cSrcweir /** specifies the background color (RGB) of the control. 66cdf0e10cSrcweir The Default value is white 67cdf0e10cSrcweir */ 68cdf0e10cSrcweir [property] long BackgroundColor; 69cdf0e10cSrcweir 70cdf0e10cSrcweir //------------------------------------------------------------------------- 71cdf0e10cSrcweir 72cdf0e10cSrcweir /** determines whether the control is interactive or not. 73cdf0e10cSrcweir 74cdf0e10cSrcweir <p>A roadmap control which is interactive allows selecting its items out-of-order, 75cdf0e10cSrcweir by simply clicking them.</p> 76cdf0e10cSrcweir */ 77cdf0e10cSrcweir [property] boolean Interactive; 78cdf0e10cSrcweir 79cdf0e10cSrcweir //------------------------------------------------------------------------- 80cdf0e10cSrcweir 81cdf0e10cSrcweir /** determines whether the control container is complete or not. If it is 82cdf0e10cSrcweir false than a non - interactive RoadmapItem is appended 83cdf0e10cSrcweir */ 84cdf0e10cSrcweir [property] boolean Complete; 85cdf0e10cSrcweir 86cdf0e10cSrcweir 87cdf0e10cSrcweir //------------------------------------------------------------------------- 88cdf0e10cSrcweir 89cdf0e10cSrcweir /** specifies an URL to an image to use for the control. 90cdf0e10cSrcweir The image is placed in the lower right corner of the control 91cdf0e10cSrcweir @see Graphic 92cdf0e10cSrcweir */ 93cdf0e10cSrcweir [property] string ImageURL; 94cdf0e10cSrcweir 95cdf0e10cSrcweir //------------------------------------------------------------------------- 96cdf0e10cSrcweir 97cdf0e10cSrcweir /** specifies a graphic to be displayed on the control 98cdf0e10cSrcweir 99cdf0e10cSrcweir <p>If this property is present, it interacts with the <member>ImageURL</member>in the 100cdf0e10cSrcweir following way: 101cdf0e10cSrcweir <ul><li>If <member>ImageURL</member> is set, <member>Graphic</member> will be reset 102cdf0e10cSrcweir to an object as loaded from the given image URL, or <NULL/> if <member>ImageURL</member> 103cdf0e10cSrcweir does not point to a valid image file.</li> 104cdf0e10cSrcweir <li>If <member>Graphic</member> is set, <member>ImageURL</member> will be reset 105cdf0e10cSrcweir to an empty string.</li> 106cdf0e10cSrcweir </ul></p> 107cdf0e10cSrcweir 108*d1e7efc3SJürgen Schmidt @since OpenOffice 2.1 109cdf0e10cSrcweir */ 110cdf0e10cSrcweir [optional, property, transient] com::sun::star::graphic::XGraphic Graphic; 111cdf0e10cSrcweir 112cdf0e10cSrcweir //------------------------------------------------------------------------- 113cdf0e10cSrcweir 114cdf0e10cSrcweir /** specifies the border style of the control. 115cdf0e10cSrcweir 116cdf0e10cSrcweir <pre> 117cdf0e10cSrcweir 0: No border 118cdf0e10cSrcweir 1: 3D border 119cdf0e10cSrcweir 2: simple border 120cdf0e10cSrcweir </pre> 121cdf0e10cSrcweir */ 122cdf0e10cSrcweir [property] short Border; 123cdf0e10cSrcweir 124cdf0e10cSrcweir //------------------------------------------------------------------------- 125cdf0e10cSrcweir 126cdf0e10cSrcweir /** specifies whether the control will be printed with the document. 127cdf0e10cSrcweir */ 128cdf0e10cSrcweir [property] boolean Printable; 129cdf0e10cSrcweir 130cdf0e10cSrcweir //------------------------------------------------------------------------- 131cdf0e10cSrcweir 132cdf0e10cSrcweir /** specifies the text displayed in the control. 133cdf0e10cSrcweir */ 134cdf0e10cSrcweir [property] string Text; 135cdf0e10cSrcweir 136cdf0e10cSrcweir //------------------------------------------------------------------------- 137cdf0e10cSrcweir 138cdf0e10cSrcweir /** refers to the ID of the currently selected item. Initially this property is set to '-1' 139cdf0e10cSrcweir which is equal to 'undefined" 140cdf0e10cSrcweir If the Roadmap Item that the CurrentItemID refers to is removed the property 141cdf0e10cSrcweir 'CurrentItemID' is set to -1 142cdf0e10cSrcweir */ 143cdf0e10cSrcweir [property] short CurrentItemID; 144cdf0e10cSrcweir 145cdf0e10cSrcweir 146cdf0e10cSrcweir //------------------------------------------------------------------------- 147cdf0e10cSrcweir 148cdf0e10cSrcweir /** specifies the help text of the control. 149cdf0e10cSrcweir */ 150cdf0e10cSrcweir [property] string HelpText; 151cdf0e10cSrcweir 152cdf0e10cSrcweir 153cdf0e10cSrcweir //------------------------------------------------------------------------- 154cdf0e10cSrcweir 155cdf0e10cSrcweir /** specifies the help URL of the control. 156cdf0e10cSrcweir */ 157cdf0e10cSrcweir [property] string HelpURL; 158cdf0e10cSrcweir 159cdf0e10cSrcweir}; 160cdf0e10cSrcweir 161cdf0e10cSrcweir//============================================================================= 162cdf0e10cSrcweir 163cdf0e10cSrcweir}; }; }; }; 164cdf0e10cSrcweir 165cdf0e10cSrcweir#endif 166