xref: /aoo41x/main/offapi/com/sun/star/text/Paragraph.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_Paragraph_idl__
24#define __com_sun_star_text_Paragraph_idl__
25
26#ifndef __com_sun_star_style_ParagraphProperties_idl__
27#include <com/sun/star/style/ParagraphProperties.idl>
28#endif
29#ifndef __com_sun_star_style_ParagraphPropertiesAsian_idl__
30#include <com/sun/star/style/ParagraphPropertiesAsian.idl>
31#endif
32#ifndef __com_sun_star_style_ParagraphPropertiesComplex_idl__
33#include <com/sun/star/style/ParagraphPropertiesComplex.idl>
34#endif
35
36#ifndef __com_sun_star_style_CharacterProperties_idl__
37#include <com/sun/star/style/CharacterProperties.idl>
38#endif
39#ifndef __com_sun_star_style_CharacterPropertiesAsian_idl__
40#include <com/sun/star/style/CharacterPropertiesAsian.idl>
41#endif
42#ifndef __com_sun_star_style_CharacterPropertiesComplex_idl__
43#include <com/sun/star/style/CharacterPropertiesComplex.idl>
44#endif
45
46#ifndef __com_sun_star_text_TextContent_idl__
47#include <com/sun/star/text/TextContent.idl>
48#endif
49
50#ifndef __com_sun_star_beans_XPropertySet_idl__
51#include <com/sun/star/beans/XPropertySet.idl>
52#endif
53
54#ifndef __com_sun_star_beans_XTolerantMultiPropertySet_idl__
55#include <com/sun/star/beans/XTolerantMultiPropertySet.idl>
56#endif
57
58#ifndef __com_sun_star_beans_XPropertyState_idl__
59#include <com/sun/star/beans/XPropertyState.idl>
60#endif
61
62#ifndef __com_sun_star_container_XEnumerationAccess_idl__
63#include <com/sun/star/container/XEnumerationAccess.idl>
64#endif
65
66#ifndef __com_sun_star_text_TextTable_idl__
67#include <com/sun/star/text/TextTable.idl>
68#endif
69
70
71//=============================================================================
72
73 module com {  module sun {  module star {  module text {
74
75//=============================================================================
76
77// DocMerge from xml: service com::sun::star::text::Paragraph
78/** is a piece of text which can take its own paragraph-specific
79	attributes (technically, properties).
80 */
81published service Paragraph
82{
83    /** This service is present when the paragraph object refers
84        to a text range */
85    [optional] service com::sun::star::style::ParagraphProperties;
86    /** This service is present when the paragraph object refers
87        to a text range */
88    [optional] service com::sun::star::style::ParagraphPropertiesAsian;
89    /** This service is present when the paragraph object refers
90        to a text range */
91    [optional] service com::sun::star::style::ParagraphPropertiesComplex;
92    /** This service is present when the paragraph object refers
93        to a text range */
94    [optional] service com::sun::star::style::CharacterProperties;
95    /** This service is present when the paragraph object refers
96        to a text range */
97    [optional] service com::sun::star::style::CharacterPropertiesAsian;
98    /** This service is present when the paragraph object refers
99        to a text range */
100    [optional] service com::sun::star::style::CharacterPropertiesComplex;
101    /** This service is present when the paragraph object refers
102        to a text table */
103    [optional] service com::sun::star::text::TextTable;
104
105	// DocMerge: empty anyway
106	service com::sun::star::text::TextContent;
107
108
109	// DocMerge from xml: service com::sun::star::text::Paragraph: interface com::sun::star::beans::XPropertySet
110	/** This interface gives access to the properties of the paragraph
111				itself (or its style sheet). So this interface may show
112				property values which are not valid for any of the
113				text portions of the paragraph, if the text itself has its
114				own style properties set.
115	 */
116	interface com::sun::star::beans::XPropertySet;
117
118
119	// DocMerge from xml: service com::sun::star::text::Paragraph: interface com::sun::star::beans::XPropertyState
120	/** This interface gives access to the state of the property values
121				in these properties. So, it is possible to determine if a specific
122				properties value is defined in the paragraph or its style sheet.
123	 */
124	interface com::sun::star::beans::XPropertyState;
125
126
127	// DocMerge from xml: service com::sun::star::text::Paragraph: interface com::sun::star::container::XEnumerationAccess
128	/** This interface enumerates the text portions of this paragraph.
129
130				<p>A text portion is defined as the largest possible <type>TextRange</type>
131				within a paragraph with the same property values and the same bound objects.
132
133				<p>In general this interface is used for exporting into file
134				formats.
135
136				@see com::sun::star::text::TextRange@see com::sun::star::text::TextRange
137	 */
138	interface com::sun::star::container::XEnumerationAccess;
139
140    /** gives access to a sequence of properties.
141        @since OOo 2.0
142     */
143    [optional] interface ::com::sun::star::beans::XTolerantMultiPropertySet;
144};
145
146//=============================================================================
147
148}; }; }; };
149
150#endif
151