xref: /trunk/main/offapi/com/sun/star/text/TextFrames.idl (revision cdf0e10c)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_text_TextFrames_idl__
28#define __com_sun_star_text_TextFrames_idl__
29
30#ifndef __com_sun_star_container_XNameAccess_idl__
31#include <com/sun/star/container/XNameAccess.idl>
32#endif
33#ifndef __com_sun_star_container_XIndexAccess_idl__
34#include <com/sun/star/container/XIndexAccess.idl>
35#endif
36
37#ifndef __com_sun_star_container_XContainer_idl__
38#include <com/sun/star/container/XContainer.idl>
39#endif
40
41
42//=============================================================================
43
44 module com {  module sun {  module star {  module text {
45
46//=============================================================================
47
48// DocMerge from xml: service com::sun::star::text::TextFrames
49/** This is the collection of all <type>TextFrame</type> instances within a
50	context (e.g. a document).
51 */
52published service TextFrames
53{
54
55
56	// DocMerge from xml: service com::sun::star::text::TextFrames: interface com::sun::star::container::XNameAccess
57	/** This interface makes it possible to access all <type>TextFrame</type>
58				instances within this context (e.g. a document) by its name.
59
60				<p>The type of the interfaces returned by this collection is
61				always "XTextFrame".
62	 */
63	interface com::sun::star::container::XNameAccess;
64	/** This interface makes it possible to access all <type>TextFrame</type>
65				instances within this context (e.g. a document) by its index.
66
67				<p>The type of the interfaces returned by this collection is
68				always "XTextFrame".
69	 */
70	interface com::sun::star::container::XIndexAccess;
71
72
73	// DocMerge from xml: service com::sun::star::text::TextFrames: interface com::sun::star::container::XContainer
74	/** This optional interface makes it possible to register for events
75				which occur upon insertion and removal of <type>TextFrame</type>
76				instances.
77	 */
78	[optional] interface com::sun::star::container::XContainer;
79
80};
81
82//=============================================================================
83
84}; }; }; };
85
86#endif
87