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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_presentation_Shape_idl__
  20 #define __com_sun_star_presentation_Shape_idl__
  21
  22 #include <com/sun/star/util/Color.idl>
  23 #include <com/sun/star/presentation/AnimationEffect.idl>
  24
  25 #include <com/sun/star/presentation/ClickAction.idl>
  26
  27 #include <com/sun/star/presentation/AnimationSpeed.idl>
  28
  29
  30
  31  module com {  module sun {  module star {  module presentation {
  32
  33
  34 /** this service is supported from all shapes inside a PresentationDocument.
  35
  36
  37     This usually enhances objects of type com::sun::star::drawing::Shape with
  38     presentation properties.
  39 */
  40 published service Shape
  41 {
  42
  43     /** is a generic URL for the property OnClick.
  44      */
  45     [property] string Bookmark;
  46
  47
  48     /** This is the color for dimming this shape.
  49
  50         <p>This color is used if the property com::sun::star::drawing::Shape::DimPrev
  51         is `TRUE` and com::sun::star::drawing::Shape::DimHide is `FALSE`.</p>
  52      */
  53     [property] com::sun::star::util::Color DimColor;
  54
  55
  56     /** If this property and the property com::sun::star::drawing::Shape::DimPrev
  57         are both `TRUE`, the shape is hidden instead of dimmed to a color.
  58      */
  59     [property] boolean DimHide;
  60
  61
  62     /** If this property is `TRUE`, this shape is dimmed to the color of
  63         property com::sun::star::drawing::Shape::DimColor after executing its
  64         animation effect.
  65      */
  66     [property] boolean DimPrevious;
  67
  68
  69     /** selects the animation effect of this shape.
  70      */
  71     [property] com::sun::star::presentation::AnimationEffect Effect;
  72
  73
  74     /** If this is a default presentation object and if it is empty,
  75         this property is `TRUE`.
  76      */
  77     [property] boolean IsEmptyPresentationObject;
  78
  79
  80     /** If this is a presentation object, this property is `TRUE`.
  81         <p>Presentation objects are objects like TitleTextShape and
  82         OutlinerShape.</p>
  83      */
  84     [readonly, property] boolean IsPresentationObject;
  85
  86
  87     /** selects an action performed after the user clicks
  88         on this shape.
  89      */
  90     [property] com::sun::star::presentation::ClickAction OnClick;
  91
  92
  93     /** If this property is `TRUE`, the sound of this shape is played in
  94         full.
  95
  96         <p>The default behavior is to stop the sound after completing the
  97         animation effect.</p>
  98      */
  99     [property] boolean PlayFull;
 100
 101
 102     /** This is the position of this shape in the order of the shapes which
 103         can be animated on its page.
 104
 105         <p>The animations are executed in this order, starting at the shape
 106         with the PresentationOrder "one."  You can change the order by
 107         changing this number. Setting it to "one" makes this shape the
 108         first shape in the execution order for the animation effects.</p>
 109      */
 110     [property] long PresentationOrder;
 111
 112
 113     /** This is the URL to a sound file that is played while the animation
 114         effect of this shape is running.
 115      */
 116     [property] string Sound;
 117
 118
 119     /** If this property is set to `TRUE`, a sound is played while the
 120         animation effect is executed.
 121      */
 122     [property] boolean SoundOn;
 123
 124
 125     /** This is the speed of the animation effect.
 126      */
 127     [property] com::sun::star::presentation::AnimationSpeed Speed;
 128
 129
 130     /** This is the animation effect for the text inside this shape.
 131      */
 132     [property] com::sun::star::presentation::AnimationEffect TextEffect;
 133
 134
 135     /** specifies an "OLE2" verb for the ClickAction VERB in
 136         the property com::sun::star::drawing::Shape::OnClick.
 137      */
 138     [property] long Verb;
 139
 140 };
 141
 142
 143 }; }; }; };
 144
 145 #endif
 146
 147 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */