xref: /AOO41X/main/offapi/com/sun/star/drawing/XDrawPages.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
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_XDrawPages_idl__
24#define __com_sun_star_drawing_XDrawPages_idl__
25
26#ifndef __com_sun_star_container_XIndexAccess_idl__
27#include <com/sun/star/container/XIndexAccess.idl>
28#endif
29
30#ifndef __com_sun_star_drawing_XDrawPage_idl__
31#include <com/sun/star/drawing/XDrawPage.idl>
32#endif
33
34
35//=============================================================================
36
37 module com {  module sun {  module star {  module drawing {
38
39//=============================================================================
40
41/** gives access to a container of <type>DrawPage</type>s or <type>MasterPage</type>s.
42
43    <p>The pages are stored in an index container. The order is determined by
44    the index.
45
46    You usualy get this interface if you use the
47    <type>XDrawPagesSupplier</type> or the <type>XMasterPagesSupplier</type>
48    at a model that contains <type>DrawPage</type>s or <type>MasterPage</type>s
49*/
50published interface XDrawPages: com::sun::star::container::XIndexAccess
51{
52    //-------------------------------------------------------------------------
53
54    /** creates and inserts a new <type>DrawPage</type> or <type>MasterPage</type>
55        into this container
56
57        @param nIndex
58            the index at which the newly created <type>DrawPage</type> or
59            <type>MasterPage</type> will be inserted.
60
61        @return
62            the newly created and already inserted <type>DrawPage</type> or
63            <type>MasterPage</type>.
64    */
65    com::sun::star::drawing::XDrawPage insertNewByIndex( [in] long nIndex );
66
67    //-------------------------------------------------------------------------
68
69    /** removes a <type>DrawPage</type> or <type>MasterPage</type> from this
70        container.
71
72        @param xPage
73            this <type>DrawPage</type> or <type>MasterPage</type> must be
74            contained and will be removed from this container. It will
75            also be disposed and shouldn't be used any further.
76    */
77    void remove( [in] com::sun::star::drawing::XDrawPage xPage );
78
79};
80
81//=============================================================================
82
83}; }; }; };
84
85#endif
86
87