offapi/com/sun/star/presentation/Shape.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: Shape.idl,v $
  10  * $Revision: 1.12 $
  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_presentation_Shape_idl__
  31 #define __com_sun_star_presentation_Shape_idl__
  32
  33 #ifndef __com_sun_star_util_Color_idl__
  34 #include <com/sun/star/util/Color.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_presentation_AnimationEffect_idl__
  38 #include <com/sun/star/presentation/AnimationEffect.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_presentation_ClickAction_idl__
  42 #include <com/sun/star/presentation/ClickAction.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_presentation_AnimationSpeed_idl__
  46 #include <com/sun/star/presentation/AnimationSpeed.idl>
  47 #endif
  48
  49
  50 //=============================================================================
  51
  52  module com {  module sun {  module star {  module presentation {
  53
  54 //=============================================================================
  55
  56 /** this service is supported from all shapes inside a <type>PresentationDocument</type>.
  57
  58
  59     This usually enahnces objects of type <type scope="com::sun::star::drawing">Shape</type> with
  60     presentation properties.
  61 */
  62 published service Shape
  63 {
  64     //-------------------------------------------------------------------------
  65
  66     /** is a generic URL for the property OnClick.
  67      */
  68     [property] string Bookmark;
  69
  70     //-------------------------------------------------------------------------
  71
  72     /** This is the color for dimming this shape.
  73
  74         <p>This color is used if the property <member scope="com::sun::star::drawing">Shape::DimPrev</member>
  75         is <TRUE/> and <member scope="com::sun::star::drawing">Shape::DimHide</member> is <FALSE/>.</p>
  76      */
  77     [property] com::sun::star::util::Color DimColor;
  78
  79     //-------------------------------------------------------------------------
  80
  81     /** If this property and the property <member scope="com::sun::star::drawing">Shape::DimPrev</member>
  82         are both <TRUE/>, the shape is hidden instead of dimmed to a color.
  83      */
  84     [property] boolean DimHide;
  85
  86     //-------------------------------------------------------------------------
  87
  88     /** If this property is <TRUE/>, this shape is dimmed to the color of
  89         property <member scope="com::sun::star::drawing">Shape::DimColor</member> after executing its
  90         animation effect.
  91      */
  92     [property] boolean DimPrevious;
  93
  94     //-------------------------------------------------------------------------
  95
  96     /** selects the animation effect of this shape.
  97      */
  98     [property] com::sun::star::presentation::AnimationEffect Effect;
  99
 100     //-------------------------------------------------------------------------
 101
 102     /** If this is a default presentation object and if it is empty,
 103         this property is <TRUE/>.
 104      */
 105     [property] boolean IsEmptyPresentationObject;
 106
 107     //-------------------------------------------------------------------------
 108
 109     /** If this is a presentation object, this property is <TRUE/>.
 110         <p>Presentation objects are objects like TitleTextShape and
 111         OutlinerShape.</p>
 112      */
 113     [readonly, property] boolean IsPresentationObject;
 114
 115     //-------------------------------------------------------------------------
 116
 117     /** selects an action performed after the user clicks
 118         on this shape.
 119      */
 120     [property] com::sun::star::presentation::ClickAction OnClick;
 121
 122     //-------------------------------------------------------------------------
 123
 124     /** If this property is <TRUE/>, the sound of this shape is played in
 125         full.
 126
 127         <p>The default behavior is to stop the sound after completing the
 128         animation effect.</p>
 129      */
 130     [property] boolean PlayFull;
 131
 132     //-------------------------------------------------------------------------
 133
 134     /** This is the position of this shape in the order of the shapes which
 135         can be animated on its page.
 136
 137         <p>The animations are executed in this order, starting at the shape
 138         with the PresentationOrder "one."  You can change the order by
 139         changing this number. Setting it to "one" makes this shape the
 140         first shape in the execution order for the animation effects.</p>
 141      */
 142     [property] long PresentationOrder;
 143
 144     //-------------------------------------------------------------------------
 145
 146     /** This is the URL to a soundfile that is played while the animation
 147         effect of this shape is running.
 148      */
 149     [property] string Sound;
 150
 151     //-------------------------------------------------------------------------
 152
 153     /** If this property is set to <TRUE/>, a sound is played while the
 154         animation effect is executed.
 155      */
 156     [property] boolean SoundOn;
 157
 158     //-------------------------------------------------------------------------
 159
 160     /** This is the speed of the animation effect.
 161      */
 162     [property] com::sun::star::presentation::AnimationSpeed Speed;
 163
 164     //-------------------------------------------------------------------------
 165
 166     /** This is the animation effect for the text inside this shape.
 167      */
 168     [property] com::sun::star::presentation::AnimationEffect TextEffect;
 169
 170     //-------------------------------------------------------------------------
 171
 172     /** specifies an "ole2" verb for the ClickAction VERB in
 173         the property <member scope="com::sun::star::drawing">Shape::OnClick</member>.
 174      */
 175     [property] long Verb;
 176
 177 };
 178
 179 //=============================================================================
 180
 181 }; }; }; };
 182
 183 #endif