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
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
|
/*************************************************************************
*
* $RCSfile: TextFrame.idl,v $
*
* $Revision: 1.1 $
*
* last change: $Author: mi $ $Date: 2000-11-06 09:22:20 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library 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 for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (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.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef __com_sun_star_text_TextFrame_idl__
#define __com_sun_star_text_TextFrame_idl__
#ifndef __com_sun_star_text_TextContent_idl__
#include <com/sun/star/text/TextContent.idl>
#endif
#ifndef __com_sun_star_text_XTextFrame_idl__
#include <com/sun/star/text/XTextFrame.idl>
#endif
#ifndef __com_sun_star_drawing_XShape_idl__
#include <com/sun/star/drawing/XShape.idl>
#endif
#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif
#ifndef __com_sun_star_container_XNamed_idl__
#include <com/sun/star/container/XNamed.idl>
#endif
#ifndef __com_sun_star_style_GraphicLocation_idl__
#include <com/sun/star/style/GraphicLocation.idl>
#endif
//=============================================================================
module com { module sun { module star { module text {
//=============================================================================
// DocMerge from xml: service com::sun::star::text::TextFrame
/** specifies a rectangular shape which contains a <type scope="com::sun::star::drawing">Text</type> object
and is attached to a piece of surrounding <type scope="com::sun::star::drawing">Text</type>.
@see service Text
@example StarBasic
<p>This example shows how to create a <type>TextFrame</type> and insert
it at the very beginning of <type>Text</text> component. The macro
is ready to run, if it is a script within a text document. </p>
<listing>
Sub Main
oFrame = ThisComponent.createInstance( "com.sun.star.text.TextFrame" )
oFrame.Width = 6000
ThisComponent.Text.insertTextContent( ThisComponent.Text.Start, oFrame, false )
oFrame.Text.String = "Hello, this text is within the frame."
End Sub
</listing>
*/
service TextFrame
{
// DocMerge: empty anyway
service com::sun::star::text::TextContent;
// DocMerge from xml: service com::sun::star::text::TextFrame: interface com::sun::star::text::XTextFrame
/** This interface makes it possible to access the text within this
text frame.
*/
interface com::sun::star::text::XTextFrame;
// DocMerge from xml: service com::sun::star::text::TextFrame: interface com::sun::star::drawing::XShape
/** This interface specifies the access to the shape data (position
and size) of the text frame.
<p>This interface is valid before the text frame is attached
to a surrounding text, but when attached the values can change
(e.g. due to a revised layout of the surrounding text).
<p>The position is relative to the position of the anchor
[see <method>XTextFrame::getAnchor()</method>]. Size and position are
both measured in 100th mm. The size is not valid if the
size is relative and no layout exists or if the layout is invalid.
<p>This interface is only for the layout. In particular, the
setting of values is only allowed for the layout component of the
owner text of this text component.
*/
interface com::sun::star::drawing::XShape;
// DocMerge from xml: service com::sun::star::text::TextFrame: interface com::sun::star::beans::XPropertySet
/** This interface makes it possible to access the properties of
this text frame.
<p>This interface is valid before the text frame is attached to
a surrounding text.
*/
interface com::sun::star::beans::XPropertySet;
// DocMerge from xml: service com::sun::star::text::TextFrame: interface com::sun::star::container::XNamed
/** This interface specifies the name of this text frame.
<p>The name may be set automatically by the container if it is not
set when inserted. In this case a random, unique name is assigned.
*/
interface com::sun::star::container::XNamed;
//-------------------------------------------------------------------------
// DocMerge from xml: property com::sun::star::text::TextFrame::FrameHeightAbsolute
/** contains the metric height value of the frame.
*/
[property] long FrameHeightAbsolute;
//-------------------------------------------------------------------------
// DocMerge from xml: property com::sun::star::text::TextFrame::FrameWidthAbsolute
/** contains the metric width value of the frame.
*/
[property] long FrameWidthAbsolute;
//-------------------------------------------------------------------------
// DocMerge from xml: property com::sun::star::text::TextFrame::FrameWidthPercent
/** specifies a width relative to the width of the
surrounding text.
<p>If the value for "WidthPercent" is 0, the absolute value from
is used.</p>
*/
[property] byte FrameWidthPercent;
//-------------------------------------------------------------------------
// DocMerge from xml: property com::sun::star::text::TextFrame::FrameHeightPercent
/** specifies a width relative to the width of the
surrounding text.
<p>If the value for "HeightPercent" is 0, the absolute value from
is used.</p>
*/
[property] byte FrameHeightPercent;
//-------------------------------------------------------------------------
// DocMerge from xml: property com::sun::star::text::TextFrame::FrameIsAutomaticHeight
/** If "AutomaticHeight" is set, then the object grows if it is required
by the frame content.
*/
[property] boolean FrameIsAutomaticHeight;
//-------------------------------------------------------------------------
// DocMerge from xml: property com::sun::star::text::TextFrame::BackGraphicURL
/** contains the URL for the background graphic.
*/
[property] string BackGraphicURL;
//-------------------------------------------------------------------------
// DocMerge from xml: property com::sun::star::text::TextFrame::BackGraphicFilter
/** contains the name of the file filter for the background graphic.
*/
[property] string BackGraphicFilter;
//-------------------------------------------------------------------------
// DocMerge from xml: property com::sun::star::text::TextFrame::BackGraphicLocation
/** determines the position of the background graphic.@see enum GraphicLocation
*/
[property] com::sun::star::style::GraphicLocation BackGraphicLocation;
};
//=============================================================================
}; }; }; };
/*=============================================================================
$Log: not supported by cvs2svn $
Revision 1.2 2000/10/16 16:27:27 mi
example code added
Revision 1.1.1.1 2000/09/18 23:36:03 hjs
initial import
Revision 1.7 2000/09/11 11:53:01 mi
documentation merged from XML
Revision 1.5 2000/06/16 11:42:16 os
#75622# BackGraphicLocation/URL/Filter added/changed
Revision 1.4 2000/04/05 13:44:03 os
syntax
Revision 1.3 2000/03/31 11:53:57 os
#74034# Documentation changed
Revision 1.2 2000/02/07 11:25:02 mi
zu #70728# missing documentation marked
Revision 1.1.1.1 1999/11/11 09:48:46 jsc
new
=============================================================================*/
#endif
|
