xref: /aoo41x/main/offapi/com/sun/star/text/TextFrames.idl (revision d1766043)
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_text_TextFrames_idl__
24#define __com_sun_star_text_TextFrames_idl__
25
26#ifndef __com_sun_star_container_XNameAccess_idl__
27#include <com/sun/star/container/XNameAccess.idl>
28#endif
29#ifndef __com_sun_star_container_XIndexAccess_idl__
30#include <com/sun/star/container/XIndexAccess.idl>
31#endif
32
33#ifndef __com_sun_star_container_XContainer_idl__
34#include <com/sun/star/container/XContainer.idl>
35#endif
36
37
38//=============================================================================
39
40 module com {  module sun {  module star {  module text {
41
42//=============================================================================
43
44// DocMerge from xml: service com::sun::star::text::TextFrames
45/** This is the collection of all <type>TextFrame</type> instances within a
46	context (e.g. a document).
47 */
48published service TextFrames
49{
50
51
52	// DocMerge from xml: service com::sun::star::text::TextFrames: interface com::sun::star::container::XNameAccess
53	/** This interface makes it possible to access all <type>TextFrame</type>
54				instances within this context (e.g. a document) by its name.
55
56				<p>The type of the interfaces returned by this collection is
57				always "XTextFrame".
58	 */
59	interface com::sun::star::container::XNameAccess;
60	/** This interface makes it possible to access all <type>TextFrame</type>
61				instances within this context (e.g. a document) by its index.
62
63				<p>The type of the interfaces returned by this collection is
64				always "XTextFrame".
65	 */
66	interface com::sun::star::container::XIndexAccess;
67
68
69	// DocMerge from xml: service com::sun::star::text::TextFrames: interface com::sun::star::container::XContainer
70	/** This optional interface makes it possible to register for events
71				which occur upon insertion and removal of <type>TextFrame</type>
72				instances.
73	 */
74	[optional] interface com::sun::star::container::XContainer;
75
76};
77
78//=============================================================================
79
80}; }; }; };
81
82#endif
83