summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/presentation/Presentation.idl
blob: 87a4bf13788feb6ccbef7f4954dc87586fdcc1e0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
/*************************************************************************
 *
 *  $RCSfile: Presentation.idl,v $
 *
 *  $Revision: 1.2 $
 *
 *  last change: $Author: mi $ $Date: 2000-11-06 13:16:17 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_presentation_Presentation_idl__
#define __com_sun_star_presentation_Presentation_idl__

#ifndef __com_sun_star_presentation_XPresentation_idl__
#include <com/sun/star/presentation/XPresentation.idl>
#endif

#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif


//=============================================================================

 module com {  module sun {  module star {  module presentation {

//=============================================================================

// DocMerge from xml: service com::sun::star::presentation::Presentation
/** This service is a presentation that is available from a
    <code>PresentationDocument</code> via the
    <code>XPresentationSupplier</code> interface.
 */
service Presentation
{


    // DocMerge from xml: service com::sun::star::presentation::Presentation: interface com::sun::star::presentation::XPresentation
    /** lets you start and stop a presentation.

                <p>It also gives you access to the more advanced features, like
                rehearse timing and the live modus.
     */
    interface com::sun::star::presentation::XPresentation;


    // DocMerge from xml: service com::sun::star::presentation::Presentation: interface com::sun::star::beans::XPropertySet
    /** This is the standard interface for access to the properties from this
                service.
     */
    interface com::sun::star::beans::XPropertySet;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::presentation::Presentation::AllowAnimations
    /** enables/disables the shape animations.
     */
    [property] boolean AllowAnimations;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::presentation::Presentation::CustomShow
    /** If this string is not empty, it contains the name of a customized
        show that is used for the presentation.
     */
    [property] string CustomShow;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::presentation::Presentation::FirstPage
    /** If this string is not empty, it contains the name of the page where
        the presentation is started.
     */
    [property] string FirstPage;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::presentation::Presentation::IsAlwaysOnTop
    /** If this property is set to <true></true>, the window of the presentation is
        always on top of all other windows.
     */
    [property] boolean IsAlwaysOnTop;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::presentation::Presentation::IsAutomatic
    /** If this property is <true></true>, all pages are changed automatically.



        <p>This overrides the properties of the pages.</p>
     */
    [property] boolean IsAutomatic;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::presentation::Presentation::IsEndless
    /** If this property is set to <true></true>, the presentation is repeated
        endlessly.
     */
    [property] boolean IsEndless;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::presentation::Presentation::IsFullScreen
    /** If this property is set to <true></true>, the presentation runs in
        full-screen mode.
     */
    [property] boolean IsFullScreen;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::presentation::Presentation::IsLivePresentation
    /** With this property, you can set the presentation to live mode.
     */
    [property] boolean IsLivePresentation;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::presentation::Presentation::IsMouseVisible
    /** If this property is <true></true>, the mouse is visible during the
        presentation.
     */
    [property] boolean IsMouseVisible;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::presentation::Presentation::Pause
    /** is the duration of the black screen after the
        presentation has finished.



        <p>If this is set to <literal>0</literal>, no black screen is shown.</p>
     */
    [property] long Pause;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::presentation::Presentation::StartWithNavigator
    /** If this is set to <true></true>, the Navigator is opened at the start of the
        presentation.
     */
    [property] boolean StartWithNavigator;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::presentation::Presentation::UsePen
    /** If this is <true></true>, a pen is shown during presentation.



        <p>You can draw on the presentation with this pen.</p>
     */
    [property] boolean UsePen;

};

//=============================================================================

}; }; }; };

/*=============================================================================

    $Log: not supported by cvs2svn $
    Revision 1.1.1.1  2000/09/18 23:35:31  hjs
    initial import

    Revision 1.5  2000/09/11 11:52:35  mi
    documentation merged from XML

    Revision 1.3  2000/02/21 16:18:02  mi
    string documentation from stardiv...*.idl-files

    Revision 1.2  2000/02/07 11:24:43  mi
    zu #70728# missing documentation marked

    Revision 1.1.1.1  1999/11/11 09:48:44  jsc
    new


=============================================================================*/
#endif