summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/text/XText.idl
blob: ac6e37f668dfeb736bdc149a1acf1f361c032bea (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: XText.idl,v $
 * $Revision: 1.11 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_text_XText_idl__
#define __com_sun_star_text_XText_idl__

#ifndef __com_sun_star_text_XSimpleText_idl__
#include <com/sun/star/text/XSimpleText.idl>
#endif

#ifndef __com_sun_star_text_XTextCursor_idl__
#include <com/sun/star/text/XTextCursor.idl>
#endif

#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif

#ifndef __com_sun_star_text_XTextContent_idl__
#include <com/sun/star/text/XTextContent.idl>
#endif

#ifndef __com_sun_star_container_NoSuchElementException_idl__
#include <com/sun/star/container/NoSuchElementException.idl>
#endif


//=============================================================================

 module com {  module sun {  module star {  module text {

//=============================================================================

/** extends a <type>XSimpleText</type> by the capability of inserting
        <type>XTextContent</type>s.
 */
published interface XText: com::sun::star::text::XSimpleText
{
    //-------------------------------------------------------------------------

    /** inserts a content, such as a text table, text frame or text
        field.

        <p>Which contents are accepted is implementation-specific. Some
        implementations may only accept contents which were created by the
        factory that supplied the same text or the document which contains
        the text.
        </p>

        @param xRange
            specifies the position of insertion.

        @param xContent
            the text content to be inserted.

        @param bAbsorb
            specifies whether the text spanned by <var>xRange</var> will be
            replaced. If <TRUE/> then the content of <var>xRange</var> will
            be replaced by <var>xContent</var>, otherwise <var>xContent</var>
            will be inserted at the end of <var>xRange</var>.
     */
    void insertTextContent( [in] com::sun::star::text::XTextRange xRange,
             [in] com::sun::star::text::XTextContent xContent,
             [in] boolean bAbsorb )
            raises( com::sun::star::lang::IllegalArgumentException );

    //-------------------------------------------------------------------------

    /** removes the specified content from the text object.

        @example xDoc.removeTextContent( xDoc.TextTables.MyOwnTableName )
     */
    void removeTextContent( [in] com::sun::star::text::XTextContent xContent )
            raises( com::sun::star::container::NoSuchElementException );

};

//=============================================================================

}; }; }; };

#endif