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_DrawPage_idl__
24#define __com_sun_star_presentation_DrawPage_idl__
25
26#ifndef __com_sun_star_drawing_DrawPage_idl__
27#include <com/sun/star/drawing/DrawPage.idl>
28#endif
29
30#ifndef __com_sun_star_document_LinkTarget_idl__
31#include <com/sun/star/document/LinkTarget.idl>
32#endif
33
34#ifndef __com_sun_star_presentation_FadeEffect_idl__
35#include <com/sun/star/presentation/FadeEffect.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 is the service provided by a <type scope="com::sun::star::drawing">DrawPage</type> inside a
50	<type>PresentationDocument</type>.
51
52	@see PresentationDocument
53 */
54published service DrawPage
55{
56	service com::sun::star::drawing::DrawPage;
57
58	/** Every page is a link target inside the document object model.
59	 */
60	service com::sun::star::document::LinkTarget;
61
62	//-------------------------------------------------------------------------
63
64	/** specifies how the page change is triggered.
65
66		<p>If this is 0, the user must click to start each object animation
67		and to change the page.  If set to 1, the page is
68		automatically switched.  If it is set to 2, all object effects run
69		automatically, but the user has to click on the page to change it.</p>
70	 */
71	[property] long Change;
72
73	//-------------------------------------------------------------------------
74
75	/** If the property <member scope="com::sun::star::drawing">DrawPage::Change</member> is set to 1,
76		this is the time in seconds this page is shown before switching
77		to the next page.
78	 */
79	[property] long Duration;
80
81	//-------------------------------------------------------------------------
82
83	/** This is the effect that is used to fade in this page.
84	 */
85	[property] com::sun::star::presentation::FadeEffect Effect;
86
87	//-------------------------------------------------------------------------
88
89	/** If this property is not ZERO, this number specifies a presentation
90		layout for this page.
91	 */
92	[property] short Layout;
93
94	//-------------------------------------------------------------------------
95
96	/** defines the speed of the fade-in effect of this page.
97	 */
98	[property] com::sun::star::presentation::AnimationSpeed Speed;
99
100	//-------------------------------------------------------------------------
101
102	/** defines if a header presentation shape from the master page is visible
103		on this page.
104	*/
105
106	[optional, property] boolean IsHeaderVisible;
107
108	//-------------------------------------------------------------------------
109
110	/** defines the text that is displayd in a header textfield rendered on this
111		page.
112	*/
113	[optional, property] string HeaderText;
114
115	//-------------------------------------------------------------------------
116
117	/** defines if a footer presentation shape from the master page is visible
118		on this page.
119	*/
120
121	[optional, property] boolean IsFooterVisible;
122
123	//-------------------------------------------------------------------------
124
125	/** defines the text that is displayd in a footer textfield rendered on this
126		page.
127	*/
128	[optional, property] string FooterText;
129
130	//-------------------------------------------------------------------------
131
132	/** defines if a page number presentation shape from the master page is visible
133		on this page.
134	*/
135
136	[optional, property] boolean IsPageNumberVisible;
137
138	//-------------------------------------------------------------------------
139
140	/** defines if a date and time presentation shape from the master page is visible
141		on this page.
142	*/
143
144	[optional, property] boolean IsDateTimeVisible;
145
146	//-------------------------------------------------------------------------
147
148	/** defines if a date and time text field shows a fixed string value or the
149		current date on this page.
150	*/
151
152	[optional, property] boolean IsDateTimeFixed;
153
154	//-------------------------------------------------------------------------
155
156	/** defines the text that is displayd in a date and time textfield rendered on this
157		page. This value is only used if <code>IsDateTimeFixed</code> is <true/>.
158	*/
159	[optional, property] string DateTimeText;
160
161	//-------------------------------------------------------------------------
162
163	/** defines the format that is used to format a date and time text field on
164		this page. This is only used if <code>IsDateTimeFixed</code> is <false/>.
165	*/
166	[optional, property] long DateTimeFormat;
167};
168
169//=============================================================================
170
171}; }; }; };
172
173#endif
174