1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_drawing_GenericDrawPage_idl__ 24cdf0e10cSrcweir#define __com_sun_star_drawing_GenericDrawPage_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_drawing_XShapes_idl__ 27cdf0e10cSrcweir#include <com/sun/star/drawing/XShapes.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir#ifndef __com_sun_star_drawing_XShapeGrouper_idl__ 31cdf0e10cSrcweir#include <com/sun/star/drawing/XShapeGrouper.idl> 32cdf0e10cSrcweir#endif 33cdf0e10cSrcweir 34cdf0e10cSrcweir#ifndef __com_sun_star_drawing_XShapeCombiner_idl__ 35cdf0e10cSrcweir#include <com/sun/star/drawing/XShapeCombiner.idl> 36cdf0e10cSrcweir#endif 37cdf0e10cSrcweir 38cdf0e10cSrcweir#ifndef __com_sun_star_drawing_XShapeBinder_idl__ 39cdf0e10cSrcweir#include <com/sun/star/drawing/XShapeBinder.idl> 40cdf0e10cSrcweir#endif 41cdf0e10cSrcweir 42cdf0e10cSrcweir#ifndef __com_sun_star_container_XNamed_idl__ 43cdf0e10cSrcweir#include <com/sun/star/container/XNamed.idl> 44cdf0e10cSrcweir#endif 45cdf0e10cSrcweir 46cdf0e10cSrcweir#ifndef __com_sun_star_lang_XServiceInfo_idl__ 47cdf0e10cSrcweir#include <com/sun/star/lang/XServiceInfo.idl> 48cdf0e10cSrcweir#endif 49cdf0e10cSrcweir 50cdf0e10cSrcweir#ifndef __com_sun_star_beans_XPropertySet_idl__ 51cdf0e10cSrcweir#include <com/sun/star/beans/XPropertySet.idl> 52cdf0e10cSrcweir#endif 53cdf0e10cSrcweir 54cdf0e10cSrcweir#ifndef __com_sun_star_view_PaperOrientation_idl__ 55cdf0e10cSrcweir#include <com/sun/star/view/PaperOrientation.idl> 56cdf0e10cSrcweir#endif 57cdf0e10cSrcweir 58cdf0e10cSrcweir#ifndef __com_sun_star_container_XNameContainer_idl__ 59cdf0e10cSrcweir#include <com/sun/star/container/XNameContainer.idl> 60cdf0e10cSrcweir#endif 61cdf0e10cSrcweir 62cdf0e10cSrcweir//============================================================================= 63cdf0e10cSrcweir 64cdf0e10cSrcweir module com { module sun { module star { module drawing { 65cdf0e10cSrcweir 66cdf0e10cSrcweir//============================================================================= 67cdf0e10cSrcweir 68cdf0e10cSrcweir// DocMerge from xml: service com::sun::star::drawing::GenericDrawPage 69cdf0e10cSrcweir/** This abstract service is implemented by every page of a 70cdf0e10cSrcweir <type>DrawingDocument</type>. 71cdf0e10cSrcweir 72cdf0e10cSrcweir 73cdf0e10cSrcweir 74cdf0e10cSrcweir @example create and insert a couple of <type>LineShape</type>s: 75cdf0e10cSrcweir 76cdf0e10cSrcweir <listing> 77cdf0e10cSrcweir xPage = xDoc.DrawPages(0) 78cdf0e10cSrcweir for x% = 0 to 200 79cdf0e10cSrcweir xShape = xProv.createInstance( "com::sun::star::drawing::LineShape" ) 80cdf0e10cSrcweir xShape.LineColor = rgb( 255, 0, n%+20 ) 81cdf0e10cSrcweir xShape.LineWidth = 20 82cdf0e10cSrcweir xShape.Position = Point( x%, 2*x% ) 83cdf0e10cSrcweir xShape.Size = Size( 300-x%, 20 ) 84cdf0e10cSrcweir xPage.add( xShape ) 85cdf0e10cSrcweir next x% 86cdf0e10cSrcweir </listing> 87cdf0e10cSrcweir */ 88cdf0e10cSrcweirpublished service GenericDrawPage 89cdf0e10cSrcweir{ 90cdf0e10cSrcweir 91cdf0e10cSrcweir 92cdf0e10cSrcweir // DocMerge from xml: service com::sun::star::drawing::GenericDrawPage: interface com::sun::star::drawing::XShapes 93cdf0e10cSrcweir /** manages the <type>Shape</type>s of this page. 94cdf0e10cSrcweir 95cdf0e10cSrcweir <p>It also lets you add new <type>Shape</type>s. The program currently 96cdf0e10cSrcweir requires that these <type>Shape</type>s be created by the factory of 97cdf0e10cSrcweir the document. 98cdf0e10cSrcweir 99cdf0e10cSrcweir @see <type>DrawingDocument</type> 100cdf0e10cSrcweir */ 101cdf0e10cSrcweir interface com::sun::star::drawing::XShapes; 102cdf0e10cSrcweir 103cdf0e10cSrcweir 104cdf0e10cSrcweir // DocMerge from xml: service com::sun::star::drawing::GenericDrawPage: interface com::sun::star::drawing::XShapeGrouper 105cdf0e10cSrcweir /** With this interface you can group/ungroup a collection of 106cdf0e10cSrcweir <type>Shape</type>s. 107cdf0e10cSrcweir */ 108cdf0e10cSrcweir interface com::sun::star::drawing::XShapeGrouper; 109cdf0e10cSrcweir 110cdf0e10cSrcweir 111cdf0e10cSrcweir // DocMerge from xml: service com::sun::star::drawing::GenericDrawPage: interface com::sun::star::drawing::XShapeCombiner 112cdf0e10cSrcweir /** With this interface you can combine/split a collection of 113cdf0e10cSrcweir <type>Shape</type>s. 114cdf0e10cSrcweir */ 115cdf0e10cSrcweir [optional] interface com::sun::star::drawing::XShapeCombiner; 116cdf0e10cSrcweir 117cdf0e10cSrcweir 118cdf0e10cSrcweir // DocMerge from xml: service com::sun::star::drawing::GenericDrawPage: interface com::sun::star::drawing::XShapeBinder 119cdf0e10cSrcweir /** With this interface you can bind/unbind a collection of 120cdf0e10cSrcweir <type>Shape</type>s. 121cdf0e10cSrcweir */ 122cdf0e10cSrcweir [optional] interface com::sun::star::drawing::XShapeBinder; 123cdf0e10cSrcweir 124cdf0e10cSrcweir 125cdf0e10cSrcweir // DocMerge from xml: service com::sun::star::drawing::GenericDrawPage: interface com::sun::star::container::XNamed 126cdf0e10cSrcweir /** Gets or sets the name of this page. 127cdf0e10cSrcweir 128cdf0e10cSrcweir <p>Duplicated pagenames inside a document are not allowed. 129cdf0e10cSrcweir */ 130cdf0e10cSrcweir [optional] interface com::sun::star::container::XNamed; 131cdf0e10cSrcweir 132cdf0e10cSrcweir 133cdf0e10cSrcweir // DocMerge from xml: service com::sun::star::drawing::GenericDrawPage: interface com::sun::star::lang::XServiceInfo 134cdf0e10cSrcweir /** returns the services implemented by this 135cdf0e10cSrcweir instance. 136cdf0e10cSrcweir */ 137cdf0e10cSrcweir interface com::sun::star::lang::XServiceInfo; 138cdf0e10cSrcweir 139cdf0e10cSrcweir 140cdf0e10cSrcweir // DocMerge from xml: service com::sun::star::drawing::GenericDrawPage: interface com::sun::star::beans::XPropertySet 141cdf0e10cSrcweir /** gives you access to the properties of this 142cdf0e10cSrcweir <type>DrawPage</type>. 143cdf0e10cSrcweir */ 144cdf0e10cSrcweir [optional] interface com::sun::star::beans::XPropertySet; 145cdf0e10cSrcweir 146cdf0e10cSrcweir //------------------------------------------------------------------------- 147cdf0e10cSrcweir 148cdf0e10cSrcweir // DocMerge from xml: property com::sun::star::drawing::GenericDrawPage::BorderBottom 149cdf0e10cSrcweir /** This is the border at the bottom. 150cdf0e10cSrcweir */ 151cdf0e10cSrcweir [optional, property] long BorderBottom; 152cdf0e10cSrcweir 153cdf0e10cSrcweir //------------------------------------------------------------------------- 154cdf0e10cSrcweir 155cdf0e10cSrcweir // DocMerge from xml: property com::sun::star::drawing::GenericDrawPage::BorderLeft 156cdf0e10cSrcweir /** This is the border at the left. 157cdf0e10cSrcweir */ 158cdf0e10cSrcweir [optional, property] long BorderLeft; 159cdf0e10cSrcweir 160cdf0e10cSrcweir //------------------------------------------------------------------------- 161cdf0e10cSrcweir 162cdf0e10cSrcweir // DocMerge from xml: property com::sun::star::drawing::GenericDrawPage::BorderRight 163cdf0e10cSrcweir /** This is the border at the right. 164cdf0e10cSrcweir */ 165cdf0e10cSrcweir [optional, property] long BorderRight; 166cdf0e10cSrcweir 167cdf0e10cSrcweir //------------------------------------------------------------------------- 168cdf0e10cSrcweir 169cdf0e10cSrcweir // DocMerge from xml: property com::sun::star::drawing::GenericDrawPage::BorderTop 170cdf0e10cSrcweir /** This is the border at the top. 171cdf0e10cSrcweir */ 172cdf0e10cSrcweir [optional, property] long BorderTop; 173cdf0e10cSrcweir 174cdf0e10cSrcweir //------------------------------------------------------------------------- 175cdf0e10cSrcweir 176cdf0e10cSrcweir // DocMerge from xml: property com::sun::star::drawing::GenericDrawPage::Height 177cdf0e10cSrcweir /** This is the height. 178cdf0e10cSrcweir */ 179cdf0e10cSrcweir [optional, property] long Height; 180cdf0e10cSrcweir 181cdf0e10cSrcweir //------------------------------------------------------------------------- 182cdf0e10cSrcweir 183cdf0e10cSrcweir // DocMerge from xml: property com::sun::star::drawing::GenericDrawPage::Width 184cdf0e10cSrcweir /** This is the width. 185cdf0e10cSrcweir */ 186cdf0e10cSrcweir [optional, property] long Width; 187cdf0e10cSrcweir 188cdf0e10cSrcweir //------------------------------------------------------------------------- 189cdf0e10cSrcweir 190cdf0e10cSrcweir // DocMerge from xml: property com::sun::star::drawing::GenericDrawPage::Number 191cdf0e10cSrcweir /** This is the number of this page, starting with 1. 192cdf0e10cSrcweir */ 193cdf0e10cSrcweir [optional, readonly, property] short Number; 194cdf0e10cSrcweir 195cdf0e10cSrcweir //------------------------------------------------------------------------- 196cdf0e10cSrcweir 197cdf0e10cSrcweir // DocMerge from xml: property com::sun::star::drawing::GenericDrawPage::Orientation 198cdf0e10cSrcweir /** This is the orientation of this page. 199cdf0e10cSrcweir */ 200cdf0e10cSrcweir [optional, property] com::sun::star::view::PaperOrientation Orientation; 201cdf0e10cSrcweir 202cdf0e10cSrcweir //------------------------------------------------------------------------- 203cdf0e10cSrcweir 204cdf0e10cSrcweir /** this property stores xml attributes. 205cdf0e10cSrcweir They will be saved to and restored from automatic styles inside xml files. 206cdf0e10cSrcweir 207cdf0e10cSrcweir @see com::sun::star::xml::AttributeContainer 208cdf0e10cSrcweir */ 209cdf0e10cSrcweir [optional, property] com::sun::star::container::XNameContainer UserDefinedAttributes; 210cdf0e10cSrcweir 211cdf0e10cSrcweir //------------------------------------------------------------------------- 212cdf0e10cSrcweir 213cdf0e10cSrcweir /** this property is true if the avveraged background filling colors luminance 214cdf0e10cSrcweir is belove an application specified threshold value. This can be used to 215cdf0e10cSrcweir determine the actuall value of an auto color. 216cdf0e10cSrcweir */ 217cdf0e10cSrcweir [readonly, optional, property] boolean IsBackgroundDark; 218cdf0e10cSrcweir 219cdf0e10cSrcweir //------------------------------------------------------------------------- 220cdf0e10cSrcweir 221cdf0e10cSrcweir /** this index access defines a navigation order for the top level shapes 222cdf0e10cSrcweir inside this page. 223cdf0e10cSrcweir By default this is equal to the index access of the slide itself, 224cdf0e10cSrcweir making the z-order the default navigation order for top level shapes. 225cdf0e10cSrcweir */ 226cdf0e10cSrcweir [optional, property] com::sun::star::container::XIndexAccess NavigationOrder; 227cdf0e10cSrcweir}; 228cdf0e10cSrcweir 229cdf0e10cSrcweir//============================================================================= 230cdf0e10cSrcweir 231cdf0e10cSrcweir}; }; }; }; 232cdf0e10cSrcweir 233cdf0e10cSrcweir#endif 234cdf0e10cSrcweir 235