1*cdf0e10cSrcweir/************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir#ifndef __com_sun_star_awt_UnoControlRoadmapModel_idl__ 28*cdf0e10cSrcweir#define __com_sun_star_awt_UnoControlRoadmapModel_idl__ 29*cdf0e10cSrcweir 30*cdf0e10cSrcweir 31*cdf0e10cSrcweir#ifndef __com_sun_star_awt_UnoControlModel_idl__ 32*cdf0e10cSrcweir#include <com/sun/star/awt/UnoControlModel.idl> 33*cdf0e10cSrcweir#endif 34*cdf0e10cSrcweir#ifndef __com_sun_star_container_XIndexContainer_idl__ 35*cdf0e10cSrcweir#include <com/sun/star/container/XIndexContainer.idl> 36*cdf0e10cSrcweir#endif 37*cdf0e10cSrcweir#ifndef __com_sun_star_beans_XPropertyChangeListener_idl__ 38*cdf0e10cSrcweir#include <com/sun/star/beans/XPropertyChangeListener.idl> 39*cdf0e10cSrcweir#endif 40*cdf0e10cSrcweir#ifndef com_sun_star_graphic_XGraphic_idl 41*cdf0e10cSrcweir#include <com/sun/star/graphic/XGraphic.idl> 42*cdf0e10cSrcweir#endif 43*cdf0e10cSrcweir 44*cdf0e10cSrcweir//============================================================================= 45*cdf0e10cSrcweir 46*cdf0e10cSrcweir module com { module sun { module star { module awt { 47*cdf0e10cSrcweir 48*cdf0e10cSrcweir//============================================================================= 49*cdf0e10cSrcweir 50*cdf0e10cSrcweir/** specifies the standard model of an <type>UnoControlContainer</type>. 51*cdf0e10cSrcweir */ 52*cdf0e10cSrcweirservice UnoControlRoadmapModel 53*cdf0e10cSrcweir{ 54*cdf0e10cSrcweir service com::sun::star::awt::UnoControlModel; 55*cdf0e10cSrcweir 56*cdf0e10cSrcweir /** The control serves as an indexed container typically for RoadmapItems 57*cdf0e10cSrcweir as specified in com::sun::star::awt:RoadmapItem. The RoadmapItems are 58*cdf0e10cSrcweir held in a sequence. 59*cdf0e10cSrcweir When inserting such items their ID is set equal to the Index of their 60*cdf0e10cSrcweir insertion by default. 61*cdf0e10cSrcweir After removing items the CurrentItem property is - when beyound the upper sequence 62*cdf0e10cSrcweir boundaries - set equal to last index of the RoadmapItem Array. 63*cdf0e10cSrcweir */ 64*cdf0e10cSrcweir interface com::sun::star::container::XIndexContainer; 65*cdf0e10cSrcweir 66*cdf0e10cSrcweir //------------------------------------------------------------------------- 67*cdf0e10cSrcweir 68*cdf0e10cSrcweir 69*cdf0e10cSrcweir /** specifies the background color (RGB) of the control. 70*cdf0e10cSrcweir The Default value is white 71*cdf0e10cSrcweir */ 72*cdf0e10cSrcweir [property] long BackgroundColor; 73*cdf0e10cSrcweir 74*cdf0e10cSrcweir //------------------------------------------------------------------------- 75*cdf0e10cSrcweir 76*cdf0e10cSrcweir /** determines whether the control is interactive or not. 77*cdf0e10cSrcweir 78*cdf0e10cSrcweir <p>A roadmap control which is interactive allows selecting its items out-of-order, 79*cdf0e10cSrcweir by simply clicking them.</p> 80*cdf0e10cSrcweir */ 81*cdf0e10cSrcweir [property] boolean Interactive; 82*cdf0e10cSrcweir 83*cdf0e10cSrcweir //------------------------------------------------------------------------- 84*cdf0e10cSrcweir 85*cdf0e10cSrcweir /** determines whether the control container is complete or not. If it is 86*cdf0e10cSrcweir false than a non - interactive RoadmapItem is appended 87*cdf0e10cSrcweir */ 88*cdf0e10cSrcweir [property] boolean Complete; 89*cdf0e10cSrcweir 90*cdf0e10cSrcweir 91*cdf0e10cSrcweir //------------------------------------------------------------------------- 92*cdf0e10cSrcweir 93*cdf0e10cSrcweir /** specifies an URL to an image to use for the control. 94*cdf0e10cSrcweir The image is placed in the lower right corner of the control 95*cdf0e10cSrcweir @see Graphic 96*cdf0e10cSrcweir */ 97*cdf0e10cSrcweir [property] string ImageURL; 98*cdf0e10cSrcweir 99*cdf0e10cSrcweir //------------------------------------------------------------------------- 100*cdf0e10cSrcweir 101*cdf0e10cSrcweir /** specifies a graphic to be displayed on the control 102*cdf0e10cSrcweir 103*cdf0e10cSrcweir <p>If this property is present, it interacts with the <member>ImageURL</member>in the 104*cdf0e10cSrcweir following way: 105*cdf0e10cSrcweir <ul><li>If <member>ImageURL</member> is set, <member>Graphic</member> will be reset 106*cdf0e10cSrcweir to an object as loaded from the given image URL, or <NULL/> if <member>ImageURL</member> 107*cdf0e10cSrcweir does not point to a valid image file.</li> 108*cdf0e10cSrcweir <li>If <member>Graphic</member> is set, <member>ImageURL</member> will be reset 109*cdf0e10cSrcweir to an empty string.</li> 110*cdf0e10cSrcweir </ul></p> 111*cdf0e10cSrcweir 112*cdf0e10cSrcweir @since OOo 2.1 113*cdf0e10cSrcweir */ 114*cdf0e10cSrcweir [optional, property, transient] com::sun::star::graphic::XGraphic Graphic; 115*cdf0e10cSrcweir 116*cdf0e10cSrcweir //------------------------------------------------------------------------- 117*cdf0e10cSrcweir 118*cdf0e10cSrcweir /** specifies the border style of the control. 119*cdf0e10cSrcweir 120*cdf0e10cSrcweir <pre> 121*cdf0e10cSrcweir 0: No border 122*cdf0e10cSrcweir 1: 3D border 123*cdf0e10cSrcweir 2: simple border 124*cdf0e10cSrcweir </pre> 125*cdf0e10cSrcweir */ 126*cdf0e10cSrcweir [property] short Border; 127*cdf0e10cSrcweir 128*cdf0e10cSrcweir //------------------------------------------------------------------------- 129*cdf0e10cSrcweir 130*cdf0e10cSrcweir /** specifies whether the control will be printed with the document. 131*cdf0e10cSrcweir */ 132*cdf0e10cSrcweir [property] boolean Printable; 133*cdf0e10cSrcweir 134*cdf0e10cSrcweir //------------------------------------------------------------------------- 135*cdf0e10cSrcweir 136*cdf0e10cSrcweir /** specifies the text displayed in the control. 137*cdf0e10cSrcweir */ 138*cdf0e10cSrcweir [property] string Text; 139*cdf0e10cSrcweir 140*cdf0e10cSrcweir //------------------------------------------------------------------------- 141*cdf0e10cSrcweir 142*cdf0e10cSrcweir /** refers to the ID of the currently selected item. Initially this property is set to '-1' 143*cdf0e10cSrcweir which is equal to 'undefined" 144*cdf0e10cSrcweir If the Roadmap Item that the CurrentItemID refers to is removed the property 145*cdf0e10cSrcweir 'CurrentItemID' is set to -1 146*cdf0e10cSrcweir */ 147*cdf0e10cSrcweir [property] short CurrentItemID; 148*cdf0e10cSrcweir 149*cdf0e10cSrcweir 150*cdf0e10cSrcweir //------------------------------------------------------------------------- 151*cdf0e10cSrcweir 152*cdf0e10cSrcweir /** specifies the help text of the control. 153*cdf0e10cSrcweir */ 154*cdf0e10cSrcweir [property] string HelpText; 155*cdf0e10cSrcweir 156*cdf0e10cSrcweir 157*cdf0e10cSrcweir //------------------------------------------------------------------------- 158*cdf0e10cSrcweir 159*cdf0e10cSrcweir /** specifies the help URL of the control. 160*cdf0e10cSrcweir */ 161*cdf0e10cSrcweir [property] string HelpURL; 162*cdf0e10cSrcweir 163*cdf0e10cSrcweir}; 164*cdf0e10cSrcweir 165*cdf0e10cSrcweir//============================================================================= 166*cdf0e10cSrcweir 167*cdf0e10cSrcweir}; }; }; }; 168*cdf0e10cSrcweir 169*cdf0e10cSrcweir#endif 170