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