1/************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27#ifndef __com_sun_star_presentation_Shape_idl__ 28#define __com_sun_star_presentation_Shape_idl__ 29 30#ifndef __com_sun_star_util_Color_idl__ 31#include <com/sun/star/util/Color.idl> 32#endif 33 34#ifndef __com_sun_star_presentation_AnimationEffect_idl__ 35#include <com/sun/star/presentation/AnimationEffect.idl> 36#endif 37 38#ifndef __com_sun_star_presentation_ClickAction_idl__ 39#include <com/sun/star/presentation/ClickAction.idl> 40#endif 41 42#ifndef __com_sun_star_presentation_AnimationSpeed_idl__ 43#include <com/sun/star/presentation/AnimationSpeed.idl> 44#endif 45 46 47//============================================================================= 48 49 module com { module sun { module star { module presentation { 50 51//============================================================================= 52 53/** this service is supported from all shapes inside a <type>PresentationDocument</type>. 54 55 56 This usually enahnces objects of type <type scope="com::sun::star::drawing">Shape</type> with 57 presentation properties. 58*/ 59published service Shape 60{ 61 //------------------------------------------------------------------------- 62 63 /** is a generic URL for the property OnClick. 64 */ 65 [property] string Bookmark; 66 67 //------------------------------------------------------------------------- 68 69 /** This is the color for dimming this shape. 70 71 <p>This color is used if the property <member scope="com::sun::star::drawing">Shape::DimPrev</member> 72 is <TRUE/> and <member scope="com::sun::star::drawing">Shape::DimHide</member> is <FALSE/>.</p> 73 */ 74 [property] com::sun::star::util::Color DimColor; 75 76 //------------------------------------------------------------------------- 77 78 /** If this property and the property <member scope="com::sun::star::drawing">Shape::DimPrev</member> 79 are both <TRUE/>, the shape is hidden instead of dimmed to a color. 80 */ 81 [property] boolean DimHide; 82 83 //------------------------------------------------------------------------- 84 85 /** If this property is <TRUE/>, this shape is dimmed to the color of 86 property <member scope="com::sun::star::drawing">Shape::DimColor</member> after executing its 87 animation effect. 88 */ 89 [property] boolean DimPrevious; 90 91 //------------------------------------------------------------------------- 92 93 /** selects the animation effect of this shape. 94 */ 95 [property] com::sun::star::presentation::AnimationEffect Effect; 96 97 //------------------------------------------------------------------------- 98 99 /** If this is a default presentation object and if it is empty, 100 this property is <TRUE/>. 101 */ 102 [property] boolean IsEmptyPresentationObject; 103 104 //------------------------------------------------------------------------- 105 106 /** If this is a presentation object, this property is <TRUE/>. 107 <p>Presentation objects are objects like TitleTextShape and 108 OutlinerShape.</p> 109 */ 110 [readonly, property] boolean IsPresentationObject; 111 112 //------------------------------------------------------------------------- 113 114 /** selects an action performed after the user clicks 115 on this shape. 116 */ 117 [property] com::sun::star::presentation::ClickAction OnClick; 118 119 //------------------------------------------------------------------------- 120 121 /** If this property is <TRUE/>, the sound of this shape is played in 122 full. 123 124 <p>The default behavior is to stop the sound after completing the 125 animation effect.</p> 126 */ 127 [property] boolean PlayFull; 128 129 //------------------------------------------------------------------------- 130 131 /** This is the position of this shape in the order of the shapes which 132 can be animated on its page. 133 134 <p>The animations are executed in this order, starting at the shape 135 with the PresentationOrder "one." You can change the order by 136 changing this number. Setting it to "one" makes this shape the 137 first shape in the execution order for the animation effects.</p> 138 */ 139 [property] long PresentationOrder; 140 141 //------------------------------------------------------------------------- 142 143 /** This is the URL to a soundfile that is played while the animation 144 effect of this shape is running. 145 */ 146 [property] string Sound; 147 148 //------------------------------------------------------------------------- 149 150 /** If this property is set to <TRUE/>, a sound is played while the 151 animation effect is executed. 152 */ 153 [property] boolean SoundOn; 154 155 //------------------------------------------------------------------------- 156 157 /** This is the speed of the animation effect. 158 */ 159 [property] com::sun::star::presentation::AnimationSpeed Speed; 160 161 //------------------------------------------------------------------------- 162 163 /** This is the animation effect for the text inside this shape. 164 */ 165 [property] com::sun::star::presentation::AnimationEffect TextEffect; 166 167 //------------------------------------------------------------------------- 168 169 /** specifies an "ole2" verb for the ClickAction VERB in 170 the property <member scope="com::sun::star::drawing">Shape::OnClick</member>. 171 */ 172 [property] long Verb; 173 174}; 175 176//============================================================================= 177 178}; }; }; }; 179 180#endif 181