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