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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: DrawPage.idl,v $
  10  * $Revision: 1.11 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_presentation_DrawPage_idl__
  31 #define __com_sun_star_presentation_DrawPage_idl__
  32
  33 #ifndef __com_sun_star_drawing_DrawPage_idl__
  34 #include <com/sun/star/drawing/DrawPage.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_document_LinkTarget_idl__
  38 #include <com/sun/star/document/LinkTarget.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_presentation_FadeEffect_idl__
  42 #include <com/sun/star/presentation/FadeEffect.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_presentation_AnimationSpeed_idl__
  46 #include <com/sun/star/presentation/AnimationSpeed.idl>
  47 #endif
  48
  49
  50 //=============================================================================
  51
  52  module com {  module sun {  module star {  module presentation {
  53
  54 //=============================================================================
  55
  56 /** This is the service provided by a <type scope="com::sun::star::drawing">DrawPage</type> inside a
  57     <type>PresentationDocument</type>.
  58
  59     @see PresentationDocument
  60  */
  61 published service DrawPage
  62 {
  63     service com::sun::star::drawing::DrawPage;
  64
  65     /** Every page is a link target inside the document object model.
  66      */
  67     service com::sun::star::document::LinkTarget;
  68
  69     //-------------------------------------------------------------------------
  70
  71     /** specifies how the page change is triggered.
  72
  73         <p>If this is 0, the user must click to start each object animation
  74         and to change the page.  If set to 1, the page is
  75         automatically switched.  If it is set to 2, all object effects run
  76         automatically, but the user has to click on the page to change it.</p>
  77      */
  78     [property] long Change;
  79
  80     //-------------------------------------------------------------------------
  81
  82     /** If the property <member scope="com::sun::star::drawing">DrawPage::Change</member> is set to 1,
  83         this is the time in seconds this page is shown before switching
  84         to the next page.
  85      */
  86     [property] long Duration;
  87
  88     //-------------------------------------------------------------------------
  89
  90     /** This is the effect that is used to fade in this page.
  91      */
  92     [property] com::sun::star::presentation::FadeEffect Effect;
  93
  94     //-------------------------------------------------------------------------
  95
  96     /** If this property is not ZERO, this number specifies a presentation
  97         layout for this page.
  98      */
  99     [property] short Layout;
 100
 101     //-------------------------------------------------------------------------
 102
 103     /** defines the speed of the fade-in effect of this page.
 104      */
 105     [property] com::sun::star::presentation::AnimationSpeed Speed;
 106
 107     //-------------------------------------------------------------------------
 108
 109     /** defines if a header presentation shape from the master page is visible
 110         on this page.
 111     */
 112
 113     [optional, property] boolean IsHeaderVisible;
 114
 115     //-------------------------------------------------------------------------
 116
 117     /** defines the text that is displayd in a header textfield rendered on this
 118         page.
 119     */
 120     [optional, property] string HeaderText;
 121
 122     //-------------------------------------------------------------------------
 123
 124     /** defines if a footer presentation shape from the master page is visible
 125         on this page.
 126     */
 127
 128     [optional, property] boolean IsFooterVisible;
 129
 130     //-------------------------------------------------------------------------
 131
 132     /** defines the text that is displayd in a footer textfield rendered on this
 133         page.
 134     */
 135     [optional, property] string FooterText;
 136
 137     //-------------------------------------------------------------------------
 138
 139     /** defines if a page number presentation shape from the master page is visible
 140         on this page.
 141     */
 142
 143     [optional, property] boolean IsPageNumberVisible;
 144
 145     //-------------------------------------------------------------------------
 146
 147     /** defines if a date and time presentation shape from the master page is visible
 148         on this page.
 149     */
 150
 151     [optional, property] boolean IsDateTimeVisible;
 152
 153     //-------------------------------------------------------------------------
 154
 155     /** defines if a date and time text field shows a fixed string value or the
 156         current date on this page.
 157     */
 158
 159     [optional, property] boolean IsDateTimeFixed;
 160
 161     //-------------------------------------------------------------------------
 162
 163     /** defines the text that is displayd in a date and time textfield rendered on this
 164         page. This value is only used if <code>IsDateTimeFixed</code> is <true/>.
 165     */
 166     [optional, property] string DateTimeText;
 167
 168     //-------------------------------------------------------------------------
 169
 170     /** defines the format that is used to format a date and time text field on
 171         this page. This is only used if <code>IsDateTimeFixed</code> is <false/>.
 172     */
 173     [optional, property] long DateTimeFormat;
 174 };
 175
 176 //=============================================================================
 177
 178 }; }; }; };
 179
 180 #endif