1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_presentation_Shape_idl__
24#define __com_sun_star_presentation_Shape_idl__
25
26#ifndef __com_sun_star_util_Color_idl__
27#include <com/sun/star/util/Color.idl>
28#endif
29
30#ifndef __com_sun_star_presentation_AnimationEffect_idl__
31#include <com/sun/star/presentation/AnimationEffect.idl>
32#endif
33
34#ifndef __com_sun_star_presentation_ClickAction_idl__
35#include <com/sun/star/presentation/ClickAction.idl>
36#endif
37
38#ifndef __com_sun_star_presentation_AnimationSpeed_idl__
39#include <com/sun/star/presentation/AnimationSpeed.idl>
40#endif
41
42
43//=============================================================================
44
45 module com {  module sun {  module star {  module presentation {
46
47//=============================================================================
48
49/** this service is supported from all shapes inside a <type>PresentationDocument</type>.
50
51
52	This usually enahnces objects of type <type scope="com::sun::star::drawing">Shape</type> with
53	presentation properties.
54*/
55published service Shape
56{
57	//-------------------------------------------------------------------------
58
59	/** is a generic URL for the property OnClick.
60	 */
61	[property] string Bookmark;
62
63	//-------------------------------------------------------------------------
64
65	/** This is the color for dimming this shape.
66
67		<p>This color is used if the property <member scope="com::sun::star::drawing">Shape::DimPrev</member>
68		is <TRUE/> and <member scope="com::sun::star::drawing">Shape::DimHide</member> is <FALSE/>.</p>
69	 */
70	[property] com::sun::star::util::Color DimColor;
71
72	//-------------------------------------------------------------------------
73
74	/** If this property and the property <member scope="com::sun::star::drawing">Shape::DimPrev</member>
75		are both <TRUE/>, the shape is hidden instead of dimmed to a color.
76	 */
77	[property] boolean DimHide;
78
79	//-------------------------------------------------------------------------
80
81	/** If this property is <TRUE/>, this shape is dimmed to the color of
82		property <member scope="com::sun::star::drawing">Shape::DimColor</member> after executing its
83		animation effect.
84	 */
85	[property] boolean DimPrevious;
86
87	//-------------------------------------------------------------------------
88
89	/** selects the animation effect of this shape.
90	 */
91	[property] com::sun::star::presentation::AnimationEffect Effect;
92
93	//-------------------------------------------------------------------------
94
95	/** If this is a default presentation object and if it is empty,
96		this property is <TRUE/>.
97	 */
98	[property] boolean IsEmptyPresentationObject;
99
100	//-------------------------------------------------------------------------
101
102	/** If this is a presentation object, this property is <TRUE/>.
103		<p>Presentation objects are objects like TitleTextShape and
104		OutlinerShape.</p>
105	 */
106	[readonly, property] boolean IsPresentationObject;
107
108	//-------------------------------------------------------------------------
109
110	/** selects an action performed after the user clicks
111		on this shape.
112	 */
113	[property] com::sun::star::presentation::ClickAction OnClick;
114
115	//-------------------------------------------------------------------------
116
117	/** If this property is <TRUE/>, the sound of this shape is played in
118		full.
119
120		<p>The default behavior is to stop the sound after completing the
121		animation effect.</p>
122	 */
123	[property] boolean PlayFull;
124
125	//-------------------------------------------------------------------------
126
127	/** This is the position of this shape in the order of the shapes which
128		can be animated on its page.
129
130		<p>The animations are executed in this order, starting at the shape
131		with the PresentationOrder "one."  You can change the order by
132		changing this number. Setting it to "one" makes this shape the
133		first shape in the execution order for the animation effects.</p>
134	 */
135	[property] long PresentationOrder;
136
137	//-------------------------------------------------------------------------
138
139	/** This is the URL to a soundfile that is played while the animation
140		effect of this shape is running.
141	 */
142	[property] string Sound;
143
144	//-------------------------------------------------------------------------
145
146	/** If this property is set to <TRUE/>, a sound is played while the
147		animation effect is executed.
148	 */
149	[property] boolean SoundOn;
150
151	//-------------------------------------------------------------------------
152
153	/** This is the speed of the animation effect.
154	 */
155	[property] com::sun::star::presentation::AnimationSpeed Speed;
156
157	//-------------------------------------------------------------------------
158
159	/** This is the animation effect for the text inside this shape.
160	 */
161	[property] com::sun::star::presentation::AnimationEffect TextEffect;
162
163	//-------------------------------------------------------------------------
164
165	/** specifies an "ole2" verb for the ClickAction VERB in
166		the property <member scope="com::sun::star::drawing">Shape::OnClick</member>.
167	 */
168	[property] long Verb;
169
170};
171
172//=============================================================================
173
174}; }; }; };
175
176#endif
177