xref: /aoo41x/main/offapi/com/sun/star/text/XTextFrame.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_XTextFrame_idl__
28#define __com_sun_star_text_XTextFrame_idl__
29
30#ifndef __com_sun_star_text_XTextContent_idl__
31#include <com/sun/star/text/XTextContent.idl>
32#endif
33
34#ifndef __com_sun_star_text_XText_idl__
35#include <com/sun/star/text/XText.idl>
36#endif
37
38
39//=============================================================================
40
41 module com {  module sun {  module star {  module text {
42
43//=============================================================================
44
45// DocMerge from xml: interface com::sun::star::text::XTextFrame
46/** provides access to the <type>Text</type> of a <type>TextFrame</type>.
47    @see TextFrame
48 */
49published interface XTextFrame: com::sun::star::text::XTextContent
50{
51	//-------------------------------------------------------------------------
52
53	// DocMerge from idl: method com::sun::star::text::XTextFrame::getText
54	/** @returns
55				the text within this frame. The returned interface belongs
56				to an object which implements the service <type>Text</type>.
57	 */
58	com::sun::star::text::XText getText();
59
60};
61
62//=============================================================================
63
64}; }; }; };
65
66#endif
67