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