offapi/com/sun/star/drawing/GenericDrawPage.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: GenericDrawPage.idl,v $
  10  * $Revision: 1.14 $
  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_drawing_GenericDrawPage_idl__
  31 #define __com_sun_star_drawing_GenericDrawPage_idl__
  32
  33 #ifndef __com_sun_star_drawing_XShapes_idl__
  34 #include <com/sun/star/drawing/XShapes.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_drawing_XShapeGrouper_idl__
  38 #include <com/sun/star/drawing/XShapeGrouper.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_drawing_XShapeCombiner_idl__
  42 #include <com/sun/star/drawing/XShapeCombiner.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_drawing_XShapeBinder_idl__
  46 #include <com/sun/star/drawing/XShapeBinder.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_container_XNamed_idl__
  50 #include <com/sun/star/container/XNamed.idl>
  51 #endif
  52
  53 #ifndef __com_sun_star_lang_XServiceInfo_idl__
  54 #include <com/sun/star/lang/XServiceInfo.idl>
  55 #endif
  56
  57 #ifndef __com_sun_star_beans_XPropertySet_idl__
  58 #include <com/sun/star/beans/XPropertySet.idl>
  59 #endif
  60
  61 #ifndef __com_sun_star_view_PaperOrientation_idl__
  62 #include <com/sun/star/view/PaperOrientation.idl>
  63 #endif
  64
  65 #ifndef __com_sun_star_container_XNameContainer_idl__
  66 #include <com/sun/star/container/XNameContainer.idl>
  67 #endif
  68
  69 //=============================================================================
  70
  71  module com {  module sun {  module star {  module drawing {
  72
  73 //=============================================================================
  74
  75 // DocMerge from xml: service com::sun::star::drawing::GenericDrawPage
  76 /** This abstract service is implemented by every page of a
  77     <type>DrawingDocument</type>.
  78
  79
  80
  81     @example create and insert a couple of <type>LineShape</type>s:
  82
  83     <listing>
  84     xPage = xDoc.DrawPages(0)
  85     for x% = 0 to 200
  86     xShape = xProv.createInstance( "com::sun::star::drawing::LineShape" )
  87     xShape.LineColor = rgb( 255, 0, n%+20 )
  88     xShape.LineWidth = 20
  89     xShape.Position = Point( x%, 2*x% )
  90     xShape.Size = Size( 300-x%, 20 )
  91     xPage.add( xShape )
  92     next x%
  93     </listing>
  94  */
  95 published service GenericDrawPage
  96 {
  97
  98
  99     // DocMerge from xml: service com::sun::star::drawing::GenericDrawPage: interface com::sun::star::drawing::XShapes
 100     /** manages the <type>Shape</type>s of this page.
 101
 102                 <p>It also lets you add new <type>Shape</type>s. The program currently
 103                 requires that these <type>Shape</type>s be created by the factory of
 104                 the     document.
 105
 106                 @see    <type>DrawingDocument</type>
 107      */
 108     interface com::sun::star::drawing::XShapes;
 109
 110
 111     // DocMerge from xml: service com::sun::star::drawing::GenericDrawPage: interface com::sun::star::drawing::XShapeGrouper
 112     /** With this interface you can group/ungroup a collection of
 113                 <type>Shape</type>s.
 114      */
 115     interface com::sun::star::drawing::XShapeGrouper;
 116
 117
 118     // DocMerge from xml: service com::sun::star::drawing::GenericDrawPage: interface com::sun::star::drawing::XShapeCombiner
 119     /** With this interface you can combine/split a collection of
 120                 <type>Shape</type>s.
 121      */
 122     [optional] interface com::sun::star::drawing::XShapeCombiner;
 123
 124
 125     // DocMerge from xml: service com::sun::star::drawing::GenericDrawPage: interface com::sun::star::drawing::XShapeBinder
 126     /** With this interface you can bind/unbind a collection of
 127                 <type>Shape</type>s.
 128      */
 129     [optional] interface com::sun::star::drawing::XShapeBinder;
 130
 131
 132     // DocMerge from xml: service com::sun::star::drawing::GenericDrawPage: interface com::sun::star::container::XNamed
 133     /** Gets or sets the name of this page.
 134
 135                 <p>Duplicated pagenames inside a document are not allowed.
 136      */
 137     [optional] interface com::sun::star::container::XNamed;
 138
 139
 140     // DocMerge from xml: service com::sun::star::drawing::GenericDrawPage: interface com::sun::star::lang::XServiceInfo
 141     /** returns the services implemented by this
 142                 instance.
 143      */
 144     interface com::sun::star::lang::XServiceInfo;
 145
 146
 147     // DocMerge from xml: service com::sun::star::drawing::GenericDrawPage: interface com::sun::star::beans::XPropertySet
 148     /** gives you access to the properties of this
 149                 <type>DrawPage</type>.
 150      */
 151     [optional] interface com::sun::star::beans::XPropertySet;
 152
 153     //-------------------------------------------------------------------------
 154
 155     // DocMerge from xml: property com::sun::star::drawing::GenericDrawPage::BorderBottom
 156     /** This is the border at the bottom.
 157      */
 158         [optional, property] long BorderBottom;
 159
 160     //-------------------------------------------------------------------------
 161
 162     // DocMerge from xml: property com::sun::star::drawing::GenericDrawPage::BorderLeft
 163     /** This is the border at the left.
 164      */
 165         [optional, property] long BorderLeft;
 166
 167     //-------------------------------------------------------------------------
 168
 169     // DocMerge from xml: property com::sun::star::drawing::GenericDrawPage::BorderRight
 170     /** This is the border at the right.
 171      */
 172         [optional, property] long BorderRight;
 173
 174     //-------------------------------------------------------------------------
 175
 176     // DocMerge from xml: property com::sun::star::drawing::GenericDrawPage::BorderTop
 177     /** This is the border at the top.
 178      */
 179         [optional, property] long BorderTop;
 180
 181     //-------------------------------------------------------------------------
 182
 183     // DocMerge from xml: property com::sun::star::drawing::GenericDrawPage::Height
 184     /** This is the height.
 185      */
 186         [optional, property] long Height;
 187
 188     //-------------------------------------------------------------------------
 189
 190     // DocMerge from xml: property com::sun::star::drawing::GenericDrawPage::Width
 191     /** This is the width.
 192      */
 193         [optional, property] long Width;
 194
 195     //-------------------------------------------------------------------------
 196
 197     // DocMerge from xml: property com::sun::star::drawing::GenericDrawPage::Number
 198     /** This is the number of this page, starting with 1.
 199      */
 200         [optional, readonly, property] short Number;
 201
 202     //-------------------------------------------------------------------------
 203
 204     // DocMerge from xml: property com::sun::star::drawing::GenericDrawPage::Orientation
 205     /** This is the orientation of this page.
 206      */
 207         [optional, property] com::sun::star::view::PaperOrientation Orientation;
 208
 209     //-------------------------------------------------------------------------
 210
 211     /** this property stores xml attributes.
 212         They will be saved to and restored from automatic styles inside xml files.
 213
 214         @see com::sun::star::xml::AttributeContainer
 215     */
 216     [optional, property] com::sun::star::container::XNameContainer UserDefinedAttributes;
 217
 218     //-------------------------------------------------------------------------
 219
 220     /** this property is true if the avveraged background filling colors luminance
 221         is belove an application specified threshold value. This can be used to
 222         determine the actuall value of an auto color.
 223     */
 224     [readonly, optional, property] boolean IsBackgroundDark;
 225
 226     //-------------------------------------------------------------------------
 227
 228     /** this index access defines a navigation order for the top level shapes
 229         inside this page.
 230         By default this is equal to the index access of the slide itself,
 231         making the z-order the default navigation order for top level shapes.
 232     */
 233     [optional, property] com::sun::star::container::XIndexAccess NavigationOrder;
 234 };
 235
 236 //=============================================================================
 237
 238 }; }; }; };
 239
 240 #endif
 241