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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_presentation_Presentation_idl__
  20 #define __com_sun_star_presentation_Presentation_idl__
  21
  22 #include <com/sun/star/presentation/XPresentation.idl>
  23
  24 #include <com/sun/star/beans/XPropertySet.idl>
  25
  26
  27
  28  module com {  module sun {  module star {  module presentation {
  29
  30
  31 /** This service is a presentation that is available from a
  32     PresentationDocument via the
  33     XPresentationSupplier interface.
  34  */
  35 published service Presentation
  36 {
  37     /** lets you start and stop a presentation.
  38
  39         <p>It also gives you access to the more advanced features, like
  40         rehearse timing and the live modes.
  41      */
  42     interface com::sun::star::presentation::XPresentation;
  43
  44
  45     /** This is the standard interface for access to the properties from this
  46         service.
  47      */
  48     interface com::sun::star::beans::XPropertySet;
  49
  50
  51     /** enables/disables the shape animations.
  52      */
  53     [property] boolean AllowAnimations;
  54
  55
  56     /** If this string is not empty, it contains the name of a customized
  57         show that is used for the presentation.
  58      */
  59     [property] string CustomShow;
  60
  61
  62     /** If this string is not empty, it contains the name of the page where
  63         the presentation is started.
  64      */
  65     [property] string FirstPage;
  66
  67
  68     /** If this property is set to `TRUE`, the window of the presentation is
  69         always on top of all other windows.
  70      */
  71     [property] boolean IsAlwaysOnTop;
  72
  73
  74     /** If this property is `TRUE`, all pages are changed automatically.
  75
  76         <p>This overrides the properties of the pages.</p>
  77      */
  78     [property] boolean IsAutomatic;
  79
  80
  81     /** If this property is set to `TRUE`, the presentation is repeated
  82         endlessly.
  83      */
  84     [property] boolean IsEndless;
  85
  86
  87     /** If this property is set to `TRUE`, the presentation runs in
  88         full-screen mode.
  89      */
  90     [property] boolean IsFullScreen;
  91
  92
  93     /** With this property, you can set the presentation to live mode.
  94         <p>Implementations that have no live mode capability may ignore this
  95         property and always return false.
  96      */
  97     [property] boolean IsLivePresentation;
  98
  99
 100     /** If this property is `TRUE`, the mouse is visible during the
 101         presentation.
 102      */
 103     [property] boolean IsMouseVisible;
 104
 105
 106     /** is the duration of the black screen after the
 107         presentation has finished.
 108
 109         <p>If this is set to <code>0</code>, no black screen is shown.</p>
 110      */
 111     [property] long Pause;
 112
 113
 114     /** If this is set to `TRUE`, the Navigator is opened at the start of the
 115         presentation.
 116      */
 117     [property] boolean StartWithNavigator;
 118
 119
 120     /** If this is `TRUE`, a pen is shown during presentation.
 121
 122         <p>You can draw on the presentation with this pen.</p>
 123      */
 124     [property] boolean UsePen;
 125
 126 };
 127
 128
 129 }; }; }; };
 130
 131 #endif
 132
 133 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */