1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_presentation_DrawPage_idl__
28#define __com_sun_star_presentation_DrawPage_idl__
29
30#ifndef __com_sun_star_drawing_DrawPage_idl__
31#include <com/sun/star/drawing/DrawPage.idl>
32#endif
33
34#ifndef __com_sun_star_document_LinkTarget_idl__
35#include <com/sun/star/document/LinkTarget.idl>
36#endif
37
38#ifndef __com_sun_star_presentation_FadeEffect_idl__
39#include <com/sun/star/presentation/FadeEffect.idl>
40#endif
41
42#ifndef __com_sun_star_presentation_AnimationSpeed_idl__
43#include <com/sun/star/presentation/AnimationSpeed.idl>
44#endif
45
46
47//=============================================================================
48
49 module com {  module sun {  module star {  module presentation {
50
51//=============================================================================
52
53/** This is the service provided by a <type scope="com::sun::star::drawing">DrawPage</type> inside a
54	<type>PresentationDocument</type>.
55
56	@see PresentationDocument
57 */
58published service DrawPage
59{
60	service com::sun::star::drawing::DrawPage;
61
62	/** Every page is a link target inside the document object model.
63	 */
64	service com::sun::star::document::LinkTarget;
65
66	//-------------------------------------------------------------------------
67
68	/** specifies how the page change is triggered.
69
70		<p>If this is 0, the user must click to start each object animation
71		and to change the page.  If set to 1, the page is
72		automatically switched.  If it is set to 2, all object effects run
73		automatically, but the user has to click on the page to change it.</p>
74	 */
75	[property] long Change;
76
77	//-------------------------------------------------------------------------
78
79	/** If the property <member scope="com::sun::star::drawing">DrawPage::Change</member> is set to 1,
80		this is the time in seconds this page is shown before switching
81		to the next page.
82	 */
83	[property] long Duration;
84
85	//-------------------------------------------------------------------------
86
87	/** This is the effect that is used to fade in this page.
88	 */
89	[property] com::sun::star::presentation::FadeEffect Effect;
90
91	//-------------------------------------------------------------------------
92
93	/** If this property is not ZERO, this number specifies a presentation
94		layout for this page.
95	 */
96	[property] short Layout;
97
98	//-------------------------------------------------------------------------
99
100	/** defines the speed of the fade-in effect of this page.
101	 */
102	[property] com::sun::star::presentation::AnimationSpeed Speed;
103
104	//-------------------------------------------------------------------------
105
106	/** defines if a header presentation shape from the master page is visible
107		on this page.
108	*/
109
110	[optional, property] boolean IsHeaderVisible;
111
112	//-------------------------------------------------------------------------
113
114	/** defines the text that is displayd in a header textfield rendered on this
115		page.
116	*/
117	[optional, property] string HeaderText;
118
119	//-------------------------------------------------------------------------
120
121	/** defines if a footer presentation shape from the master page is visible
122		on this page.
123	*/
124
125	[optional, property] boolean IsFooterVisible;
126
127	//-------------------------------------------------------------------------
128
129	/** defines the text that is displayd in a footer textfield rendered on this
130		page.
131	*/
132	[optional, property] string FooterText;
133
134	//-------------------------------------------------------------------------
135
136	/** defines if a page number presentation shape from the master page is visible
137		on this page.
138	*/
139
140	[optional, property] boolean IsPageNumberVisible;
141
142	//-------------------------------------------------------------------------
143
144	/** defines if a date and time presentation shape from the master page is visible
145		on this page.
146	*/
147
148	[optional, property] boolean IsDateTimeVisible;
149
150	//-------------------------------------------------------------------------
151
152	/** defines if a date and time text field shows a fixed string value or the
153		current date on this page.
154	*/
155
156	[optional, property] boolean IsDateTimeFixed;
157
158	//-------------------------------------------------------------------------
159
160	/** defines the text that is displayd in a date and time textfield rendered on this
161		page. This value is only used if <code>IsDateTimeFixed</code> is <true/>.
162	*/
163	[optional, property] string DateTimeText;
164
165	//-------------------------------------------------------------------------
166
167	/** defines the format that is used to format a date and time text field on
168		this page. This is only used if <code>IsDateTimeFixed</code> is <false/>.
169	*/
170	[optional, property] long DateTimeFormat;
171};
172
173//=============================================================================
174
175}; }; }; };
176
177#endif
178