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