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
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
module com { module sun { module star { module text {
/** A TextPortion is a piece of text within a paragraph that does not
contain changes of its attributes inside.
<p>
It is created by an enumeration implemented in a paragraph service.
It may be used to export the content of the paragraph to an external
document format.
</p>
@see com::sun::star::text::TextPortionEnumeration
@see com::sun::star::text::XTextPortionEnumeration
*/
published service TextPortion
{
service ::com::sun::star::text::TextRange;
/** contains text frames, graphic objects, embedded objects or
shapes that are anchored at or as character.
@see com::sun::star::text::TextFrame
@see com::sun::star::text::TextGraphicObject
*/
[optional]
interface ::com::sun::star::container::XContentEnumerationAccess;
/** gives access to a sequence of properties.
@since OOo 2.0
*/
[optional]
interface ::com::sun::star::beans::XTolerantMultiPropertySet;
/** contains the type of the text portion.
<p> Valid content type names are:</p>
<dl>
<dt>Text</dt><dd>string content</dd>
<dt>TextField</dt><dd>a text field</dd>
<dt>TextContent</dt><dd>text content - supplied via the
interface com::sun::star::container::XContentEnumerationAccess</dd>
<dt>ControlCharacter</dt><dd>a control character</dd>
<dt>Footnote</dt><dd>a footnote or an endnote</dd>
<dt>ReferenceMark</dt><dd>a reference mark</dd>
<dt>DocumentIndexMark</dt><dd>a document index mark</dd>
<dt>Bookmark</dt><dd>a bookmark</dd>
<dt>Redline</dt><dd>a redline portion which is a result
of the change tracking feature</dd>
<dt>Ruby</dt><dd>a ruby attribute which is used in Asian text</dd>
<dt>Frame</dt><dd>a frame</dd>
<dt>SoftPageBreak</dt><dd>a soft page break</dd>
<dt>InContentMetadata</dt><dd>a text range with attached metadata</dd>
</dl>
<p>For Reference marks, document index marks, etc., 2 text portions
will be generated, one for the start position and one for the
end position.</p>
*/
[readonly, property] string TextPortionType;
/** contains the control character of a text portion of type
ControlCharacter.
@deprecated type ControlCharacter no longer implemented
*/
[readonly, property] short ControlCharacter;
/** contains the bookmark of a text portion of type Bookmark. */
[optional, readonly, property]
::com::sun::star::text::XTextContent Bookmark;
/** contains the document index mark of a text portion of type
DocumentIndexMark. */
[optional, readonly, property]
::com::sun::star::text::XTextContent DocumentIndexMark;
/** contains the bookmark of a text portion of type ReferenceMark. */
[optional, readonly, property]
::com::sun::star::text::XTextContent ReferenceMark;
/** contains the footnote of a text portion of type Footnote. */
[optional, readonly, property]
::com::sun::star::text::XFootnote Footnote;
/** contains the text field of a text portion of type TextField. */
[optional, readonly, property]
::com::sun::star::text::XTextField TextField;
/** contains the text range of a text portion of type InContentMetadata.
@since OOo 3.2
*/
[optional, readonly, property]
::com::sun::star::text::XTextContent InContentMetadata;
/** contains whether the portion is a point only. */
[optional, readonly, property] boolean IsCollapsed;
/** contains whether the portion is the start of the portion.
<p>This is used for portions which are represented by
2 TextPortion objects (e.g., DocmentIndexMark).</p>
*/
[optional, readonly, property] boolean IsStart;
};
}; }; }; };
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
