LibreOffice LibreOffice 25.2 SDK API Reference

Shape.idl
Go to the documentation of this file.
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
20
21
22 module com { module sun { module star { module presentation {
23
24
31published service Shape
32{
33
36 [property] string Bookmark;
37
38
44 [property] com::sun::star::util::Color DimColor;
45
46
50 [property] boolean DimHide;
51
52
57 [property] boolean DimPrevious;
58
59
62 [property] com::sun::star::presentation::AnimationEffect Effect;
63
64
68 [property] boolean IsEmptyPresentationObject;
69
70
75 [readonly, property] boolean IsPresentationObject;
76
77
81 [property] com::sun::star::presentation::ClickAction OnClick;
82
83
90 [property] boolean PlayFull;
91
92
101 [property] long PresentationOrder;
102
103
107 [property] string Sound;
108
109
113 [property] boolean SoundOn;
114
115
118 [property] com::sun::star::presentation::AnimationSpeed Speed;
119
120
123 [property] com::sun::star::presentation::AnimationEffect TextEffect;
124
125
129 [property] long Verb;
130
131};
132
133
134}; }; }; };
135
136/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::presentation::AnimationSpeed
AnimationSpeed
specifies the speed values of animation/fade effects.
Definition: AnimationSpeed.idl:28
com::sun::star::presentation::AnimationEffect
AnimationEffect
specifies the animation effects for animating text or objects.
Definition: AnimationEffect.idl:28
com::sun::star::presentation::ClickAction
ClickAction
This enumeration specifies the actions which can be processed when a user clicks on an object.
Definition: ClickAction.idl:29
com::sun::star::util::Color
long Color
describes an RGB color value with an optional alpha channel.
Definition: Color.idl:34
com
Definition: Ambiguous.idl:20
com::sun::star::presentation::Shape
this service is supported from all shapes inside a PresentationDocument.
Definition: Shape.idl:32
com::sun::star::presentation::Shape::DimPrevious
boolean DimPrevious
If this property is TRUE, this shape is dimmed to the color of property com::sun::star::drawing::Shap...
Definition: Shape.idl:57
com::sun::star::presentation::Shape::DimHide
boolean DimHide
If this property and the property com::sun::star::drawing::Shape::DimPrev are both TRUE,...
Definition: Shape.idl:50
com::sun::star::presentation::Shape::Bookmark
string Bookmark
is a generic URL for the property OnClick.
Definition: Shape.idl:36
com::sun::star::presentation::Shape::TextEffect
com::sun::star::presentation::AnimationEffect TextEffect
This is the animation effect for the text inside this shape.
Definition: Shape.idl:123
com::sun::star::presentation::Shape::Sound
string Sound
This is the URL to a sound file that is played while the animation effect of this shape is running.
Definition: Shape.idl:107
com::sun::star::presentation::Shape::SoundOn
boolean SoundOn
If this property is set to TRUE, a sound is played while the animation effect is executed.
Definition: Shape.idl:113
com::sun::star::presentation::Shape::OnClick
com::sun::star::presentation::ClickAction OnClick
selects an action performed after the user clicks on this shape.
Definition: Shape.idl:81
com::sun::star::presentation::Shape::PlayFull
boolean PlayFull
If this property is TRUE, the sound of this shape is played in full.
Definition: Shape.idl:90
com::sun::star::presentation::Shape::Verb
long Verb
specifies an "OLE2" verb for the ClickAction VERB in the property com::sun::star::drawing::Shape::OnC...
Definition: Shape.idl:129
com::sun::star::presentation::Shape::Speed
com::sun::star::presentation::AnimationSpeed Speed
This is the speed of the animation effect.
Definition: Shape.idl:118
com::sun::star::presentation::Shape::Effect
com::sun::star::presentation::AnimationEffect Effect
selects the animation effect of this shape.
Definition: Shape.idl:62
com::sun::star::presentation::Shape::IsPresentationObject
boolean IsPresentationObject
If this is a presentation object, this property is TRUE.
Definition: Shape.idl:75
com::sun::star::presentation::Shape::PresentationOrder
long PresentationOrder
This is the position of this shape in the order of the shapes which can be animated on its page.
Definition: Shape.idl:101
com::sun::star::presentation::Shape::IsEmptyPresentationObject
boolean IsEmptyPresentationObject
If this is a default presentation object and if it is empty, this property is TRUE.
Definition: Shape.idl:68
com::sun::star::presentation::Shape::DimColor
com::sun::star::util::Color DimColor
This is the color for dimming this shape.
Definition: Shape.idl:44