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

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