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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
|
/*************************************************************************
*
* 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: TextSection.idl,v $
* $Revision: 1.13.40.1 $
*
* 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_TextSection_idl__
#define __com_sun_star_text_TextSection_idl__
#ifndef __com_sun_star_text_TextContent_idl__
#include <com/sun/star/text/TextContent.idl>
#endif
#ifndef __com_sun_star_text_XTextSection_idl__
#include <com/sun/star/text/XTextSection.idl>
#endif
#ifndef __com_sun_star_container_XNamed_idl__
#include <com/sun/star/container/XNamed.idl>
#endif
#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif
#ifndef __com_sun_star_beans_XPropertyState_idl__
#include <com/sun/star/beans/XPropertyState.idl>
#endif
#ifndef __com_sun_star_text_SectionFileLink_idl__
#include <com/sun/star/text/SectionFileLink.idl>
#endif
#ifndef __com_sun_star_style_GraphicLocation_idl__
#include <com/sun/star/style/GraphicLocation.idl>
#endif
#ifndef __com_sun_star_text_XTextColumns_idl__
#include <com/sun/star/text/XTextColumns.idl>
#endif
#ifndef _com_sun_star_xml_UserDefinedAttributesSupplier_idl_
#include <com/sun/star/xml/UserDefinedAttributesSupplier.idl>
#endif
//=============================================================================
module com { module sun { module star { module text {
//=============================================================================
/** A <type>TextSection</type> is a range of complete paragraphs within a text.
<p>The content of the section may be the content of a link into another
document, a link from the same document, or the result of a DDE
operation.
<p><type>TextSection</type> instances can be linked from and to other
texts.
*/
published service TextSection
{
service com::sun::star::text::TextContent;
[optional] service com::sun::star::xml::UserDefinedAttributesSupplier;
interface com::sun::star::text::XTextSection;
interface com::sun::star::container::XNamed;
interface com::sun::star::beans::XPropertySet;
interface com::sun::star::beans::XPropertyState;
//-------------------------------------------------------------------------
/** This property contains a conditional expression.
<p>If the result of the conditional expression is <true/> and the property
<member>TextSection::IsVisible</member> is <false/>, then the section is hidden.</p>
*/
[property] string Condition;
//-------------------------------------------------------------------------
/** If this property is <FALSE/>, the text section is hidden.
*/
[property] boolean IsVisible;
//-------------------------------------------------------------------------
/** If this property is <TRUE/>, the text section is protected
and cannot be modified from the user interface.
*/
[property] boolean IsProtected;
//-------------------------------------------------------------------------
/** If this property is set, then the content of the section is read
from the specified document.
*/
[property] com::sun::star::text::SectionFileLink FileLink;
//-------------------------------------------------------------------------
/** specifies the source of a file link in the document that is
specified in <member>TextSection::FileLink</member>.
<p>The source may be a text section or a bookmark.
If <member>TextSection::FileLink</member> is empty, then the
current document is searched for the source. If this property
is empty and <member>TextSection::FileLink</member> is set,
then the complete document content is linked into this section.</p>
*/
[property] string LinkRegion;
//-------------------------------------------------------------------------
/** specifies the type of the command string for a DDE operation.
<p>The type can be the name of the application that provides a DDE source.</p>
*/
[property] string DDECommandType;
//-------------------------------------------------------------------------
/** specifies the source file name of the command string for a DDE operation.
*/
[property] string DDECommandFile;
//-------------------------------------------------------------------------
/** specifies the source element of the command string for a DDE operation.
<p>The element can be i.e. a name of a cell in a sheet or a bookmark.</p>
*/
[property] string DDECommandElement;
//-------------------------------------------------------------------------
/** contains the URL for the background graphic.
*/
[property] string BackGraphicURL;
//-------------------------------------------------------------------------
/** contains the name of the file filter for the background graphic.
*/
[property] string BackGraphicFilter;
//-------------------------------------------------------------------------
/** determines the position of the background graphic.
@see GraphicLocation
*/
[property] com::sun::star::style::GraphicLocation BackGraphicLocation;
/** determins whether footnotes inside the section are displayed at the end of the
section text.
*/
[property] boolean FootnoteIsCollectAtTextEnd;
//-------------------------------------------------------------------------
/** determins whether the footnotes numbering restarts within the section.
This is only valid if <code>FootnoteIsRestartNumbering</code> is set.
*/
[property] boolean FootnoteIsRestartNumbering;
//-------------------------------------------------------------------------
/** determins at which number the footnote numbering inside of the section starts.
This is only valid if <code>FootnoteIsRestartNumbering</code> is set.
*/
[property] short FootnoteRestartNumberingAt;
//-------------------------------------------------------------------------
/** determins whether the footnotes within the section use an own numbering format.
This is only valid if <code>FootnoteIsRestartNumbering</code> is set.
*/
[property] boolean FootnoteIsOwnNumbering;
//-------------------------------------------------------------------------
/** determins the numbering type of the footnote numbering as a value of
<type scope="com::sun::star::style">NumberingType</type>.
This is only valid if <code>FootnoteIsOwnNumbering</code> is set.
*/
[property] short FootnoteNumberingType;
//-------------------------------------------------------------------------
/** determins the prefix that is display before the footnote number.
This is only valid if <code>FootnoteIsOwnNumbering</code> is set.
*/
[property] string FootnoteNumberingPrefix;
//-------------------------------------------------------------------------
/** determins the suffix that is display after of the footnote number.
This is only valid if <code>FootnoteIsOwnNumbering</code> is set.
*/
[property] string FootnoteNumberingSuffix;
//-------------------------------------------------------------------------
/** determins whether endnotes inside the section are displayed at the end of the
section text.
*/
[property] boolean EndnoteIsCollectAtTextEnd;
//-------------------------------------------------------------------------
/** determins whether the endnotes numbering restarts within the section.
This is only valid if <code>EndnoteIsRestartNumbering</code> is set.
*/
[property] boolean EndnoteIsRestartNumbering;
//-------------------------------------------------------------------------
/** determins at which number the endnote numbering inside of the section starts.
This is only valid if <code>EndnoteIsRestartNumbering</code> is set.
*/
[property] short EndnoteRestartNumberingAt;
//-------------------------------------------------------------------------
/** determins whether the endnotes within the section use an own numbering format.
This is only valid if <code>EndnoteIsRestartNumbering</code> is set.
*/
[property] boolean EndnoteIsOwnNumbering;
//-------------------------------------------------------------------------
/** determins the numbering type of the endnote numbering as a value of
<type scope="com::sun::star::style">NumberingType</type>.
This is only valid if <code>EndoteIsOwnNumbering</code> is set.
*/
[property] short EndnoteNumberingType;
//-------------------------------------------------------------------------
/** determins the prefix that is display before the endnote number.
This is only valid if <code>EndnoteIsOwnNumbering</code> is set.
*/
[property] string EndnoteNumberingPrefix;
//-------------------------------------------------------------------------
/** determins the suffix that is display after the endnote number.
This is only valid if <code>EndnoteIsOwnNumbering</code> is set.
*/
[property] string EndnoteNumberingSuffix;
//-------------------------------------------------------------------------
/** determins if a DDE link is updated automatically.
*/
[property] boolean IsAutomaticUpdate;
//-------------------------------------------------------------------------
/** allows columns to be set into the text section
*/
[property] com::sun::star::text::XTextColumns TextColumns;
/** determins the left margin of the section
*/
[optional, property] long SectionLeftMargin;
//-------------------------------------------------------------------------
/** determins the left margin of the section
*/
[optional, property] long SectionRightMargin;
//-------------------------------------------------------------------------
};
//=============================================================================
}; }; }; };
#endif
|
