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
24#ifndef __com_sun_star_text_TextRangeContentProperties_idl__
25#define __com_sun_star_text_TextRangeContentProperties_idl__
26
27#ifndef __com_sun_star_table_XCell_idl__
28#include <com/sun/star/table/XCell.idl>
29#endif
30
31#ifndef __com_sun_star_text_XTextContent_idl__
32#include <com/sun/star/text/XTextContent.idl>
33#endif
34
35#ifndef __com_sun_star_text_XDocumentIndex_idl__
36#include <com/sun/star/text/XDocumentIndex.idl>
37#endif
38
39#ifndef __com_sun_star_text_XTextTable_idl__
40#include <com/sun/star/text/XTextTable.idl>
41#endif
42
43#ifndef __com_sun_star_text_XTextFrame_idl__
44#include <com/sun/star/text/XTextFrame.idl>
45#endif
46
47#ifndef __com_sun_star_text_XTextSection_idl__
48#include <com/sun/star/text/XTextSection.idl>
49#endif
50
51#ifndef __com_sun_star_text_XDocumentIndexMark_idl__
52#include <com/sun/star/text/XDocumentIndexMark.idl>
53#endif
54
55#ifndef __com_sun_star_text_XFootnote_idl__
56#include <com/sun/star/text/XFootnote.idl>
57#endif
58
59
60//=============================================================================
61
62module com {  module sun {  module star {  module text {
63
64//=============================================================================
65
66/** describes the structural properties to retrieve text contents.
67
68    @since OpenOffice 3.3
69 */
70service TextRangeContentProperties
71{
72    //-------------------------------------------------------------------------
73    /** may contain a document index. */
74    [optional, readonly, property] com::sun::star::text::XDocumentIndex
75        DocumentIndex;
76
77    //-------------------------------------------------------------------------
78    /** may contain a text table. */
79    [optional, readonly, property] com::sun::star::text::XTextTable
80        TextTable;
81
82    //-------------------------------------------------------------------------
83    /** may contain a table cell. */
84    [optional, readonly, property] com::sun::star::table::XCell Cell;
85
86    //-------------------------------------------------------------------------
87    /** may contain a text frame. */
88    [optional, readonly, property] com::sun::star::text::XTextFrame
89        TextFrame;
90
91    //-------------------------------------------------------------------------
92    /** may contain a text section. */
93    [optional, readonly, property] com::sun::star::text::XTextSection
94        TextSection;
95
96    //-------------------------------------------------------------------------
97    /** may contain a document index mark. */
98    [optional, readonly, property] com::sun::star::text::XDocumentIndexMark
99        DocumentIndexMark;
100
101    //-------------------------------------------------------------------------
102    /** may contain a reference mark. */
103    [optional, readonly, property] com::sun::star::text::XTextContent
104        ReferenceMark;
105
106    //-------------------------------------------------------------------------
107    /** may contain a footnote. */
108    [optional, readonly, property] com::sun::star::text::XFootnote Footnote;
109
110    //-------------------------------------------------------------------------
111    /** may contain a endnote. */
112    [optional, readonly, property] com::sun::star::text::XFootnote Endnote;
113
114    //-------------------------------------------------------------------------
115    /** may contain a nested text content.
116
117        For example, may contain an <type>InContentMetadata</type> or a
118        <type scope="com::sun::star::text::textfield">MetadataField</type>.
119     */
120    [optional, readonly, property] com::sun::star::text::XTextContent
121        NestedTextContent;
122
123};
124
125//=============================================================================
126
127}; }; }; };
128
129#endif
130