offapi/com/sun/star/presentation/DrawPage.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_DrawPage_idl__
  20 #define __com_sun_star_presentation_DrawPage_idl__
  21
  22 #include <com/sun/star/drawing/DrawPage.idl>
  23
  24 #include <com/sun/star/document/LinkTarget.idl>
  25
  26 #include <com/sun/star/presentation/FadeEffect.idl>
  27
  28 #include <com/sun/star/presentation/AnimationSpeed.idl>
  29
  30
  31
  32  module com {  module sun {  module star {  module presentation {
  33
  34
  35 /** This is the service provided by a com::sun::star::drawing::DrawPage inside a
  36     PresentationDocument.
  37
  38     @see PresentationDocument
  39  */
  40 published service DrawPage
  41 {
  42     service com::sun::star::drawing::DrawPage;
  43
  44     /** Every page is a link target inside the document object model.
  45      */
  46     service com::sun::star::document::LinkTarget;
  47
  48
  49     /** specifies how the page change is triggered.
  50
  51         <p>If this is 0, the user must click to start each object animation
  52         and to change the page.  If set to 1, the page is
  53         automatically switched.  If it is set to 2, all object effects run
  54         automatically, but the user has to click on the page to change it.</p>
  55      */
  56     [property] long Change;
  57
  58
  59     /** If the property com::sun::star::drawing::DrawPage::Change is set to 1,
  60         this is the time in seconds this page is shown before switching
  61         to the next page.
  62      */
  63     [property] long Duration;
  64
  65     /** If the property com::sun::star::drawing::DrawPage::Change is set to 1,
  66         this is the time in seconds this page is shown before switching
  67         to the next page, also permitting sub-second precision here.
  68      */
  69     [optional, property] double HighResDuration;
  70
  71     /** This is the effect that is used to fade in this page.
  72      */
  73     [property] com::sun::star::presentation::FadeEffect Effect;
  74
  75
  76     /** If this property is not ZERO, this number specifies a presentation
  77         layout for this page.
  78      */
  79     [property] short Layout;
  80
  81
  82     /** defines the speed of the fade-in effect of this page.
  83      */
  84     [property] com::sun::star::presentation::AnimationSpeed Speed;
  85
  86
  87     /** defines if a header presentation shape from the master page is visible
  88         on this page.
  89     */
  90
  91     [optional, property] boolean IsHeaderVisible;
  92
  93
  94     /** defines the text that is displayed in a header textfield rendered on this
  95         page.
  96     */
  97     [optional, property] string HeaderText;
  98
  99
 100     /** defines if a footer presentation shape from the master page is visible
 101         on this page.
 102     */
 103
 104     [optional, property] boolean IsFooterVisible;
 105
 106
 107     /** defines the text that is displayed in a footer textfield rendered on this
 108         page.
 109     */
 110     [optional, property] string FooterText;
 111
 112
 113     /** defines if a page number presentation shape from the master page is visible
 114         on this page.
 115     */
 116
 117     [optional, property] boolean IsPageNumberVisible;
 118
 119
 120     /** defines if a date and time presentation shape from the master page is visible
 121         on this page.
 122     */
 123
 124     [optional, property] boolean IsDateTimeVisible;
 125
 126
 127     /** defines if a date and time text field shows a fixed string value or the
 128         current date on this page.
 129     */
 130
 131     [optional, property] boolean IsDateTimeFixed;
 132
 133
 134     /** defines the text that is displayed in a date and time textfield rendered on this
 135         page. This value is only used if <code>IsDateTimeFixed</code> is `TRUE`.
 136     */
 137     [optional, property] string DateTimeText;
 138
 139
 140     /** defines the format that is used to format a date and time text field on
 141         this page. This is only used if <code>IsDateTimeFixed</code> is `FALSE`.
 142     */
 143     [optional, property] long DateTimeFormat;
 144
 145 };
 146
 147
 148 }; }; }; };
 149
 150 #endif
 151
 152 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */