offapi/com/sun/star/presentation/Presentation.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: Presentation.idl,v $
  10  * $Revision: 1.13 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_presentation_Presentation_idl__
  31 #define __com_sun_star_presentation_Presentation_idl__
  32
  33 #ifndef __com_sun_star_presentation_XPresentation_idl__
  34 #include <com/sun/star/presentation/XPresentation.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_beans_XPropertySet_idl__
  38 #include <com/sun/star/beans/XPropertySet.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44  module com {  module sun {  module star {  module presentation {
  45
  46 //=============================================================================
  47
  48 /** This service is a presentation that is available from a
  49     <type>PresentationDocument</type> via the
  50     <type>XPresentationSupplier</type> interface.
  51  */
  52 published service Presentation
  53 {
  54     /** lets you start and stop a presentation.
  55
  56         <p>It also gives you access to the more advanced features, like
  57         rehearse timing and the live modes.
  58      */
  59     interface com::sun::star::presentation::XPresentation;
  60
  61     //-------------------------------------------------------------------------
  62
  63     /** This is the standard interface for access to the properties from this
  64         service.
  65      */
  66     interface com::sun::star::beans::XPropertySet;
  67
  68     //-------------------------------------------------------------------------
  69
  70     /** enables/disables the shape animations.
  71      */
  72     [property] boolean AllowAnimations;
  73
  74     //-------------------------------------------------------------------------
  75
  76     /** If this string is not empty, it contains the name of a customized
  77         show that is used for the presentation.
  78      */
  79     [property] string CustomShow;
  80
  81     //-------------------------------------------------------------------------
  82
  83     /** If this string is not empty, it contains the name of the page where
  84         the presentation is started.
  85      */
  86     [property] string FirstPage;
  87
  88     //-------------------------------------------------------------------------
  89
  90     /** If this property is set to <TRUE/>, the window of the presentation is
  91         always on top of all other windows.
  92      */
  93     [property] boolean IsAlwaysOnTop;
  94
  95     //-------------------------------------------------------------------------
  96
  97     /** If this property is <TRUE/>, all pages are changed automatically.
  98
  99         <p>This overrides the properties of the pages.</p>
 100      */
 101     [property] boolean IsAutomatic;
 102
 103     //-------------------------------------------------------------------------
 104
 105     /** If this property is set to <TRUE/>, the presentation is repeated
 106         endlessly.
 107      */
 108     [property] boolean IsEndless;
 109
 110     //-------------------------------------------------------------------------
 111
 112     /** If this property is set to <TRUE/>, the presentation runs in
 113         full-screen mode.
 114      */
 115     [property] boolean IsFullScreen;
 116
 117     //-------------------------------------------------------------------------
 118
 119     /** With this property, you can set the presentation to live mode.
 120         <p>Implementations that have no live mode capability may ignore this
 121         property and always return false.
 122      */
 123     [property] boolean IsLivePresentation;
 124
 125     //-------------------------------------------------------------------------
 126
 127     /** If this property is <TRUE/>, the mouse is visible during the
 128         presentation.
 129      */
 130     [property] boolean IsMouseVisible;
 131
 132     //-------------------------------------------------------------------------
 133
 134     /** is the duration of the black screen after the
 135         presentation has finished.
 136
 137         <p>If this is set to <literal>0</literal>, no black screen is shown.</p>
 138      */
 139     [property] long Pause;
 140
 141     //-------------------------------------------------------------------------
 142
 143     /** If this is set to <TRUE/>, the Navigator is opened at the start of the
 144         presentation.
 145      */
 146     [property] boolean StartWithNavigator;
 147
 148     //-------------------------------------------------------------------------
 149
 150     /** If this is <TRUE/>, a pen is shown during presentation.
 151
 152         <p>You can draw on the presentation with this pen.</p>
 153      */
 154     [property] boolean UsePen;
 155
 156 };
 157
 158 //=============================================================================
 159
 160 }; }; }; };
 161
 162 #endif