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