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_Presentation_idl__
24#define __com_sun_star_presentation_Presentation_idl__
25
26#ifndef __com_sun_star_presentation_XPresentation_idl__
27#include <com/sun/star/presentation/XPresentation.idl>
28#endif
29
30#ifndef __com_sun_star_beans_XPropertySet_idl__
31#include <com/sun/star/beans/XPropertySet.idl>
32#endif
33
34
35//=============================================================================
36
37 module com {  module sun {  module star {  module presentation {
38
39//=============================================================================
40
41/** This service is a presentation that is available from a
42	<type>PresentationDocument</type> via the
43	<type>XPresentationSupplier</type> interface.
44 */
45published service Presentation
46{
47	/** lets you start and stop a presentation.
48
49		<p>It also gives you access to the more advanced features, like
50		rehearse timing and the live modes.
51	 */
52	interface com::sun::star::presentation::XPresentation;
53
54	//-------------------------------------------------------------------------
55
56	/** This is the standard interface for access to the properties from this
57		service.
58	 */
59	interface com::sun::star::beans::XPropertySet;
60
61	//-------------------------------------------------------------------------
62
63	/** enables/disables the shape animations.
64	 */
65	[property] boolean AllowAnimations;
66
67	//-------------------------------------------------------------------------
68
69	/** If this string is not empty, it contains the name of a customized
70		show that is used for the presentation.
71	 */
72	[property] string CustomShow;
73
74	//-------------------------------------------------------------------------
75
76	/** If this string is not empty, it contains the name of the page where
77		the presentation is started.
78	 */
79	[property] string FirstPage;
80
81	//-------------------------------------------------------------------------
82
83	/** If this property is set to <TRUE/>, the window of the presentation is
84		always on top of all other windows.
85	 */
86	[property] boolean IsAlwaysOnTop;
87
88	//-------------------------------------------------------------------------
89
90	/** If this property is <TRUE/>, all pages are changed automatically.
91
92		<p>This overrides the properties of the pages.</p>
93	 */
94	[property] boolean IsAutomatic;
95
96	//-------------------------------------------------------------------------
97
98	/** If this property is set to <TRUE/>, the presentation is repeated
99		endlessly.
100	 */
101	[property] boolean IsEndless;
102
103	//-------------------------------------------------------------------------
104
105	/** If this property is set to <TRUE/>, the presentation runs in
106		full-screen mode.
107	 */
108	[property] boolean IsFullScreen;
109
110	//-------------------------------------------------------------------------
111
112	/** With this property, you can set the presentation to live mode.
113		<p>Implementations that have no live mode capability may ignore this
114		property and always return false.
115	 */
116	[property] boolean IsLivePresentation;
117
118	//-------------------------------------------------------------------------
119
120	/** If this property is <TRUE/>, the mouse is visible during the
121		presentation.
122	 */
123	[property] boolean IsMouseVisible;
124
125	//-------------------------------------------------------------------------
126
127	/** is the duration of the black screen after the
128		presentation has finished.
129
130		<p>If this is set to <literal>0</literal>, no black screen is shown.</p>
131	 */
132	[property] long Pause;
133
134	//-------------------------------------------------------------------------
135
136	/** If this is set to <TRUE/>, the Navigator is opened at the start of the
137		presentation.
138	 */
139	[property] boolean StartWithNavigator;
140
141	//-------------------------------------------------------------------------
142
143	/** If this is <TRUE/>, a pen is shown during presentation.
144
145		<p>You can draw on the presentation with this pen.</p>
146	 */
147	[property] boolean UsePen;
148
149};
150
151//=============================================================================
152
153}; }; }; };
154
155#endif
156