LibreOffice LibreOffice 4.2 SDK API Reference

- Main Page
- Related Pages
- Namespaces
- Classes
- Files

- File List
- File Members

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
BaseFrameProperties.idl
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19 #ifndef __com_sun_star_text_BaseFrameProperties_idl__
20 #define __com_sun_star_text_BaseFrameProperties_idl__
21
22 #include <com/sun/star/style/GraphicLocation.idl>
23 #include <com/sun/star/table/BorderLine.idl>
24 #include <com/sun/star/table/ShadowFormat.idl>
25 #include <com/sun/star/text/XTextFrame.idl>
26 #include <com/sun/star/text/WrapTextMode.idl>
27 #include <com/sun/star/awt/Size.idl>
28 #include <com/sun/star/util/Color.idl>
29 #include <com/sun/star/xml/UserDefinedAttributesSupplier.idl>
30 #include <com/sun/star/drawing/FillStyle.idl>
31 #include <com/sun/star/awt/Gradient.idl>
32
33
34 module com { module sun { module star { module text {
35
36
40 published service BaseFrameProperties
41 {
45 [optional] service com::sun::star::xml::UserDefinedAttributesSupplier;
46
52 [property] short AnchorPageNo;
57 [property] com::sun::star::text::XTextFrame AnchorFrame;
60 [property] com::sun::star::util::Color BackColor;
63 [property] string BackGraphicURL;
64
67 [property] string BackGraphicFilter;
68
71 [property] com::sun::star::style::GraphicLocation BackGraphicLocation;
72
77 [property] com::sun::star::table::BorderLine LeftBorder;
78
83 [property] com::sun::star::table::BorderLine RightBorder;
84
89 [property] com::sun::star::table::BorderLine TopBorder;
90
95 [property] com::sun::star::table::BorderLine BottomBorder;
96
99 [property] long BorderDistance;
100
103 [property] long LeftBorderDistance;
104
107 [property] long RightBorderDistance;
108
111 [property] long TopBorderDistance;
112
115 [property] long BottomBorderDistance;
116
119 [property] boolean BackTransparent;
120
121
124 [property] boolean ContentProtected;
127 [property] long LeftMargin;
128
131 [property] long RightMargin;
132
133
136 [property] long TopMargin;
137
140 [property] long BottomMargin;
141
145 [property] long Height;
146
150 [property] long Width;
154 [property] short RelativeHeight;
155
159 [property] short RelativeWidth;
162 [property] boolean IsSyncWidthToHeight;
165 [property] boolean IsSyncHeightToWidth;
170 [property] short HoriOrient;
174 [property] long HoriOrientPosition;
175
181 [property] short HoriOrientRelation;
182
187 [property] short VertOrient;
188
194 [property] long VertOrientPosition;
195
196
201 [property] short VertOrientRelation;
202
205 [property] string HyperLinkURL;
206
209 [property] string HyperLinkTarget;
210
213 [property] string HyperLinkName;
214
217 [property] boolean Opaque;
218
221 [property] boolean PageToggle;
222
225 [property] boolean PositionProtected;
226
229 [property] boolean Print;
230
233 [property] com::sun::star::table::ShadowFormat ShadowFormat;
234
237 [property] boolean ServerMap;
238
244 [property] com::sun::star::awt::Size Size;
245
248 [property] boolean SizeProtected;
253 [property] com::sun::star::text::WrapTextMode Surround;
254
258 [property] boolean SurroundAnchorOnly;
259
269 [optional, property] short WrapInfluenceOnPosition;
270
280 [optional, property, maybevoid] com::sun::star::awt::Size LayoutSize;
281
289 [optional, property] string Title;
290
299 [optional, property] string Description;
306 [optional, property] com::sun::star::drawing::FillStyle FillStyle;
312 [optional, property] com::sun::star::awt::Gradient FillGradient;
318 [optional, property] string FillGradientName;
319
327 [optional, property] short ShadowTransparence;
328
337 [optional, property] sequence<com::sun::star::beans::PropertyValue> FrameInteropGrabBag;
338
339 };
340
341
342 }; }; }; };
343
344 #endif
345
346 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
Gradient.idl
com::sun::star::text::BaseFrameProperties::BottomMargin
long BottomMargin
contains the bottom margin of the object.
Definition: BaseFrameProperties.idl:140
com::sun::star::text::BaseFrameProperties::FrameInteropGrabBag
sequence< com::sun::star::beans::PropertyValue > FrameInteropGrabBag
Grab bag of frame properties, used as a string-any map for interim interop purposes.
Definition: BaseFrameProperties.idl:337
com::sun::star::text::BaseFrameProperties::VertOrientPosition
long VertOrientPosition
contains the vertical position of the object (1/100 mm).
Definition: BaseFrameProperties.idl:194
com::sun::star::text::BaseFrameProperties::BorderDistance
long BorderDistance
contains the distance from the border to the object.
Definition: BaseFrameProperties.idl:99
com::sun::star::text::BaseFrameProperties::Size
com::sun::star::awt::Size Size
contains the size of the object.
Definition: BaseFrameProperties.idl:244
com::sun::star::text::BaseFrameProperties::BottomBorder
com::sun::star::table::BorderLine BottomBorder
contains the bottom border of the object.
Definition: BaseFrameProperties.idl:95
com::sun::star::text::BaseFrameProperties::HoriOrientRelation
short HoriOrientRelation
determines the environment of the object to which the orientation is related.
Definition: BaseFrameProperties.idl:181
com::sun::star::text::XTextFrame
provides access to the Text of a TextFrame.
Definition: XTextFrame.idl:32
com::sun::star::text::BaseFrameProperties::WrapInfluenceOnPosition
short WrapInfluenceOnPosition
determines the influence of the text wrap on the positioning of the shape
Definition: BaseFrameProperties.idl:269
com::sun::star::text::BaseFrameProperties::HoriOrientPosition
long HoriOrientPosition
contains the horizontal position of the object (1/100 mm).
Definition: BaseFrameProperties.idl:174
com::sun::star::text::BaseFrameProperties::RightBorderDistance
long RightBorderDistance
contains the distance from the right border to the object.
Definition: BaseFrameProperties.idl:107
com::sun::star::text::BaseFrameProperties::ShadowTransparence
short ShadowTransparence
This defines the degree of transparence of the shadow in percent.
Definition: BaseFrameProperties.idl:327
com::sun::star::text::BaseFrameProperties::BackGraphicURL
string BackGraphicURL
contains the URL for the background graphic.
Definition: BaseFrameProperties.idl:63
FillStyle.idl
com::sun::star::text::BaseFrameProperties::FillGradient
com::sun::star::awt::Gradient FillGradient
If the property FillStyle is set to FillStyle::GRADIENT, this describes the gradient used...
Definition: BaseFrameProperties.idl:312
com::sun::star::text::BaseFrameProperties::PositionProtected
boolean PositionProtected
determines if the position is protected.
Definition: BaseFrameProperties.idl:225
com::sun::star::text::BaseFrameProperties::TopBorderDistance
long TopBorderDistance
contains the distance from the top border to the object.
Definition: BaseFrameProperties.idl:111
ShadowFormat.idl
WrapTextMode.idl
Size.idl
com::sun::star::text::BaseFrameProperties::RightBorder
com::sun::star::table::BorderLine RightBorder
contains the right border of the object.
Definition: BaseFrameProperties.idl:83
com::sun::star::text::BaseFrameProperties::FillStyle
com::sun::star::drawing::FillStyle FillStyle
This enumeration selects the style the area will be filled with.
Definition: BaseFrameProperties.idl:306
com::sun::star::text::BaseFrameProperties::TopBorder
com::sun::star::table::BorderLine TopBorder
contains the top border of the object.
Definition: BaseFrameProperties.idl:89
com::sun::star::drawing::FillStyle
FillStyle
specifies how an area will be filled.
Definition: FillStyle.idl:28
GraphicLocation.idl
com::sun::star::text::BaseFrameProperties::RelativeWidth
short RelativeWidth
contains the relative width of the object.
Definition: BaseFrameProperties.idl:159
com::sun::star::text::BaseFrameProperties::IsSyncWidthToHeight
boolean IsSyncWidthToHeight
determines whether the width follows the height.
Definition: BaseFrameProperties.idl:162
com::sun::star::text::BaseFrameProperties::LeftMargin
long LeftMargin
contains the left margin of the object.
Definition: BaseFrameProperties.idl:127
BorderLine.idl
com::sun::star::text::BaseFrameProperties::Description
string Description
contains description for the object
Definition: BaseFrameProperties.idl:299
com::sun::star::text::BaseFrameProperties::Print
boolean Print
determines if the object is included in printing.
Definition: BaseFrameProperties.idl:229
com::sun::star::text::BaseFrameProperties::RightMargin
long RightMargin
contains the right margin of the object.
Definition: BaseFrameProperties.idl:131
com::sun::star::text::BaseFrameProperties::ContentProtected
boolean ContentProtected
determines if the content is protected.
Definition: BaseFrameProperties.idl:124
com::sun::star::style::GraphicLocation
GraphicLocation
These enumeration values are used to specify the location of a graphic object within its surroundings...
Definition: GraphicLocation.idl:29
com::sun::star::text::BaseFrameProperties::RelativeHeight
short RelativeHeight
contains the relative height of the object.
Definition: BaseFrameProperties.idl:154
com::sun::star::xml::UserDefinedAttributesSupplier
A component that supports this service preserves XML attributes, unknown by its parser, that belong to the XML element representing it (the component).
Definition: UserDefinedAttributesSupplier.idl:32
com::sun::star::text::BaseFrameProperties::SizeProtected
boolean SizeProtected
determines if the size is protected.
Definition: BaseFrameProperties.idl:248
com::sun::star::text::BaseFrameProperties::AnchorFrame
com::sun::star::text::XTextFrame AnchorFrame
contains the text frame the current frame is anchored to.
Definition: BaseFrameProperties.idl:57
com::sun::star::text::BaseFrameProperties::ServerMap
boolean ServerMap
determines if the object gets an image map from a server.
Definition: BaseFrameProperties.idl:237
com::sun::star::text::BaseFrameProperties
specifies the properties that are provided by all text frames, graphic objects, embedded objects and ...
Definition: BaseFrameProperties.idl:40
com::sun::star::text::BaseFrameProperties::BackTransparent
boolean BackTransparent
If TRUE, the "BackColor" is ignored.
Definition: BaseFrameProperties.idl:119
XTextFrame.idl
com::sun::star::text::BaseFrameProperties::Surround
com::sun::star::text::WrapTextMode Surround
determines the type of the surrounding text.
Definition: BaseFrameProperties.idl:253
com::sun::star::text::BaseFrameProperties::SurroundAnchorOnly
boolean SurroundAnchorOnly
determines if the text of the paragraph in which the object is anchored, wraps around the object...
Definition: BaseFrameProperties.idl:258
com::sun::star::text::BaseFrameProperties::LeftBorderDistance
long LeftBorderDistance
contains the distance from the left border to the object.
Definition: BaseFrameProperties.idl:103
com::sun::star::table::ShadowFormat
describes the settings of a cell shadow.
Definition: ShadowFormat.idl:32
com::sun::star::text::BaseFrameProperties::HyperLinkURL
string HyperLinkURL
contains the URL of a hyperlink that is set at the object.
Definition: BaseFrameProperties.idl:205
com::sun::star::text::BaseFrameProperties::TopMargin
long TopMargin
contains the top margin of the object.
Definition: BaseFrameProperties.idl:136
com::sun::star::text::BaseFrameProperties::FillGradientName
string FillGradientName
If the property FillStyle is set to FillStyle::GRADIENT, this is the name of the gradient used...
Definition: BaseFrameProperties.idl:318
com::sun::star::text::BaseFrameProperties::BackGraphicLocation
com::sun::star::style::GraphicLocation BackGraphicLocation
determines the position of the background graphic.
Definition: BaseFrameProperties.idl:71
com::sun::star::text::BaseFrameProperties::HyperLinkTarget
string HyperLinkTarget
contains the name of the target for a hyperlink that is set at the object.
Definition: BaseFrameProperties.idl:209
com::sun::star::text::BaseFrameProperties::LeftBorder
com::sun::star::table::BorderLine LeftBorder
contains the left border of the object.
Definition: BaseFrameProperties.idl:77
com::sun::star::awt::Size
specifies the 2-dimensional size of an area using width and height.
Definition: Size.idl:29
com::sun::star::text::BaseFrameProperties::BackGraphicFilter
string BackGraphicFilter
contains the name of the file filter for the background graphic.
Definition: BaseFrameProperties.idl:67
com::sun::star::text::BaseFrameProperties::Title
string Title
contains short title for the object
Definition: BaseFrameProperties.idl:289
com::sun::star::awt::Gradient
describes a color dispersion within an area.
Definition: Gradient.idl:33
com::sun::star::text::WrapTextMode
WrapTextMode
enumeration values specify the text wrap around objects in a text.
Definition: WrapTextMode.idl:28
com::sun::star::text::BaseFrameProperties::ShadowFormat
com::sun::star::table::ShadowFormat ShadowFormat
contains the type of the shadow of the object.
Definition: BaseFrameProperties.idl:233
com::sun::star::text::BaseFrameProperties::VertOrientRelation
short VertOrientRelation
determines the environment of the object to which the orientation is related.
Definition: BaseFrameProperties.idl:201
com::sun::star::util::Color
long Color
describes an RGB color value with an optional alpha channel.
Definition: Color.idl:36
com::sun::star::text::BaseFrameProperties::LayoutSize
com::sun::star::awt::Size LayoutSize
returns the actual size of the object.
Definition: BaseFrameProperties.idl:280
com::sun::star::table::BorderLine
describes the line type for a single cell edge.
Definition: BorderLine.idl:31
com::sun::star::text::BaseFrameProperties::HyperLinkName
string HyperLinkName
contains the name of the hyperlink that is set at the object.
Definition: BaseFrameProperties.idl:213
com::sun::star::text::BaseFrameProperties::Opaque
boolean Opaque
determines if the object is opaque or transparent for text.
Definition: BaseFrameProperties.idl:217
Color.idl
com::sun::star::text::BaseFrameProperties::VertOrient
short VertOrient
determines the vertical orientation of the object.
Definition: BaseFrameProperties.idl:187
com::sun::star::text::BaseFrameProperties::HoriOrient
short HoriOrient
determines the horizontal orientation of the object.
Definition: BaseFrameProperties.idl:170
com::sun::star::text::BaseFrameProperties::BackColor
com::sun::star::util::Color BackColor
contains the color of the background of the object.
Definition: BaseFrameProperties.idl:60
com::sun::star::text::BaseFrameProperties::PageToggle
boolean PageToggle
determines if the object is mirrored on even pages.
Definition: BaseFrameProperties.idl:221
com::sun::star::text::BaseFrameProperties::BottomBorderDistance
long BottomBorderDistance
contains the distance from the bottom border to the object.
Definition: BaseFrameProperties.idl:115
com::sun::star::text::BaseFrameProperties::Width
long Width
contains the width of the object (1/100 mm).
Definition: BaseFrameProperties.idl:150
com::sun::star::text::BaseFrameProperties::IsSyncHeightToWidth
boolean IsSyncHeightToWidth
determines whether the height follows the width.
Definition: BaseFrameProperties.idl:165
UserDefinedAttributesSupplier.idl
com::sun::star::text::BaseFrameProperties::Height
long Height
contains the height of the object (1/100 mm).
Definition: BaseFrameProperties.idl:145