offapi/com/sun/star/presentation/Shape.idl

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