LibreOffice LibreOffice 6.1 SDK API Reference

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 #include <com/sun/star/drawing/TextVerticalAdjust.hpp>
33 #include <com/sun/star/graphic/XGraphic.idl>
34
35 module com { module sun { module star { module text {
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;
58
61 [property] com::sun::star::util::Color BackColor;
62
73 [property] string BackGraphicURL;
74
77 [property] string BackGraphicFilter;
78
81 [property] com::sun::star::style::GraphicLocation BackGraphicLocation;
82
87 [property] com::sun::star::table::BorderLine LeftBorder;
88
93 [property] com::sun::star::table::BorderLine RightBorder;
94
99 [property] com::sun::star::table::BorderLine TopBorder;
100
105 [property] com::sun::star::table::BorderLine BottomBorder;
106
109 [property] long BorderDistance;
110
113 [property] long LeftBorderDistance;
114
117 [property] long RightBorderDistance;
118
121 [property] long TopBorderDistance;
122
125 [property] long BottomBorderDistance;
126
129 [property] boolean BackTransparent;
130
131
134 [property] boolean ContentProtected;
137 [property] long LeftMargin;
138
141 [property] long RightMargin;
142
143
146 [property] long TopMargin;
147
150 [property] long BottomMargin;
151
155 [property] long Height;
156
160 [property] long Width;
164 [property] short RelativeHeight;
165
169 [property] short RelativeWidth;
172 [property] boolean IsSyncWidthToHeight;
175 [property] boolean IsSyncHeightToWidth;
180 [property] short HoriOrient;
184 [property] long HoriOrientPosition;
185
191 [property] short HoriOrientRelation;
192
197 [property] short VertOrient;
198
204 [property] long VertOrientPosition;
205
206
211 [property] short VertOrientRelation;
212
215 [property] string HyperLinkURL;
216
219 [property] string HyperLinkTarget;
220
223 [property] string HyperLinkName;
224
227 [property] boolean Opaque;
228
231 [property] boolean PageToggle;
232
235 [property] boolean PositionProtected;
236
239 [property] boolean Print;
240
243 [property] com::sun::star::table::ShadowFormat ShadowFormat;
244
247 [property] boolean ServerMap;
248
254 [property] com::sun::star::awt::Size Size;
255
258 [property] boolean SizeProtected;
263 [property] com::sun::star::text::WrapTextMode Surround;
264
268 [property] boolean SurroundAnchorOnly;
269
279 [optional, property] short WrapInfluenceOnPosition;
280
290 [optional, property, maybevoid] com::sun::star::awt::Size LayoutSize;
291
299 [optional, property] string Title;
300
309 [optional, property] string Description;
316 [optional, property] com::sun::star::drawing::FillStyle FillStyle;
322 [optional, property] com::sun::star::awt::Gradient FillGradient;
328 [optional, property] string FillGradientName;
329
337 [optional, property] short ShadowTransparence;
338
347 [optional, property] sequence<com::sun::star::beans::PropertyValue> FrameInteropGrabBag;
348
355 [optional, property] short RelativeHeightRelation;
356
363 [optional, property] short RelativeWidthRelation;
364
369 [optional, property] com::sun::star::graphic::XGraphic BackGraphic;
370 };
371
372
373 }; }; }; };
374
375 #endif
376
377 /* 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:150
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:347
com::sun::star::text::BaseFrameProperties::VertOrientPosition
long VertOrientPosition
contains the vertical position of the object (1/100 mm).
Definition: BaseFrameProperties.idl:204
com::sun::star::text::BaseFrameProperties::BorderDistance
long BorderDistance
contains the distance from the border to the object.
Definition: BaseFrameProperties.idl:109
com::sun::star::text::BaseFrameProperties::RelativeHeightRelation
short RelativeHeightRelation
contains the relation of the relative height of the object.
Definition: BaseFrameProperties.idl:355
com::sun::star::text::BaseFrameProperties::Size
com::sun::star::awt::Size Size
contains the size of the object.
Definition: BaseFrameProperties.idl:254
com::sun::star::text::BaseFrameProperties::BottomBorder
com::sun::star::table::BorderLine BottomBorder
contains the bottom border of the object.
Definition: BaseFrameProperties.idl:105
com::sun::star::text::BaseFrameProperties::HoriOrientRelation
short HoriOrientRelation
determines the environment of the object to which the orientation is related.
Definition: BaseFrameProperties.idl:191
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:279
com::sun::star::text::BaseFrameProperties::HoriOrientPosition
long HoriOrientPosition
contains the horizontal position of the object (1/100 mm).
Definition: BaseFrameProperties.idl:184
com::sun::star::text::BaseFrameProperties::RightBorderDistance
long RightBorderDistance
contains the distance from the right border to the object.
Definition: BaseFrameProperties.idl:117
com::sun::star::text::BaseFrameProperties::ShadowTransparence
short ShadowTransparence
This defines the degree of transparence of the shadow in percent.
Definition: BaseFrameProperties.idl:337
com::sun::star::text::BaseFrameProperties::BackGraphicURL
string BackGraphicURL
contains the URL for the background graphic.
Definition: BaseFrameProperties.idl:73
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:322
com::sun::star::text::BaseFrameProperties::PositionProtected
boolean PositionProtected
determines if the position is protected.
Definition: BaseFrameProperties.idl:235
com::sun::star::text::BaseFrameProperties::TopBorderDistance
long TopBorderDistance
contains the distance from the top border to the object.
Definition: BaseFrameProperties.idl:121
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:93
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:316
com::sun::star::text::BaseFrameProperties::TopBorder
com::sun::star::table::BorderLine TopBorder
contains the top border of the object.
Definition: BaseFrameProperties.idl:99
com
Definition: Ambiguous.idl:22
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:169
com::sun::star::text::BaseFrameProperties::IsSyncWidthToHeight
boolean IsSyncWidthToHeight
determines whether the width follows the height.
Definition: BaseFrameProperties.idl:172
com::sun::star::text::BaseFrameProperties::LeftMargin
long LeftMargin
contains the left margin of the object.
Definition: BaseFrameProperties.idl:137
BorderLine.idl
com::sun::star::graphic::XGraphic
This interface acts as a container for the loaded graphic.
Definition: XGraphic.idl:43
com::sun::star::text::BaseFrameProperties::Description
string Description
contains description for the object
Definition: BaseFrameProperties.idl:309
com::sun::star::text::BaseFrameProperties::Print
boolean Print
determines if the object is included in printing.
Definition: BaseFrameProperties.idl:239
com::sun::star::text::BaseFrameProperties::RightMargin
long RightMargin
contains the right margin of the object.
Definition: BaseFrameProperties.idl:141
com::sun::star::text::BaseFrameProperties::ContentProtected
boolean ContentProtected
determines if the content is protected.
Definition: BaseFrameProperties.idl:134
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:164
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:258
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:247
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:129
XTextFrame.idl
com::sun::star::text::BaseFrameProperties::Surround
com::sun::star::text::WrapTextMode Surround
determines the type of the surrounding text.
Definition: BaseFrameProperties.idl:263
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:268
com::sun::star::text::BaseFrameProperties::LeftBorderDistance
long LeftBorderDistance
contains the distance from the left border to the object.
Definition: BaseFrameProperties.idl:113
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:215
com::sun::star::text::BaseFrameProperties::TopMargin
long TopMargin
contains the top margin of the object.
Definition: BaseFrameProperties.idl:146
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:328
com::sun::star::text::BaseFrameProperties::BackGraphicLocation
com::sun::star::style::GraphicLocation BackGraphicLocation
determines the position of the background graphic.
Definition: BaseFrameProperties.idl:81
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:219
com::sun::star::text::BaseFrameProperties::LeftBorder
com::sun::star::table::BorderLine LeftBorder
contains the left border of the object.
Definition: BaseFrameProperties.idl:87
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:77
com::sun::star::text::BaseFrameProperties::Title
string Title
contains short title for the object
Definition: BaseFrameProperties.idl:299
com::sun::star::awt::Gradient
Describes a gradient between two colors.
Definition: Gradient.idl:35
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:243
com::sun::star::text::BaseFrameProperties::VertOrientRelation
short VertOrientRelation
determines the environment of the object to which the orientation is related.
Definition: BaseFrameProperties.idl:211
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:290
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:223
com::sun::star::text::BaseFrameProperties::Opaque
boolean Opaque
determines if the object is opaque or transparent for text.
Definition: BaseFrameProperties.idl:227
Color.idl
com::sun::star::text::BaseFrameProperties::VertOrient
short VertOrient
determines the vertical orientation of the object.
Definition: BaseFrameProperties.idl:197
com::sun::star::text::BaseFrameProperties::BackGraphic
com::sun::star::graphic::XGraphic BackGraphic
contains the graphic for the background.
Definition: BaseFrameProperties.idl:369
com::sun::star::text::BaseFrameProperties::HoriOrient
short HoriOrient
determines the horizontal orientation of the object.
Definition: BaseFrameProperties.idl:180
com::sun::star::text::BaseFrameProperties::BackColor
com::sun::star::util::Color BackColor
contains the color of the background of the object.
Definition: BaseFrameProperties.idl:61
com::sun::star::text::BaseFrameProperties::PageToggle
boolean PageToggle
determines if the object is mirrored on even pages.
Definition: BaseFrameProperties.idl:231
com::sun::star::text::BaseFrameProperties::RelativeWidthRelation
short RelativeWidthRelation
contains the relation of the relative width of the object.
Definition: BaseFrameProperties.idl:363
com::sun::star::text::BaseFrameProperties::BottomBorderDistance
long BottomBorderDistance
contains the distance from the bottom border to the object.
Definition: BaseFrameProperties.idl:125
com::sun::star::text::BaseFrameProperties::Width
long Width
contains the width of the object (1/100 mm).
Definition: BaseFrameProperties.idl:160
com::sun::star::text::BaseFrameProperties::IsSyncHeightToWidth
boolean IsSyncHeightToWidth
determines whether the height follows the width.
Definition: BaseFrameProperties.idl:175
UserDefinedAttributesSupplier.idl
XGraphic.idl
com::sun::star::text::BaseFrameProperties::Height
long Height
contains the height of the object (1/100 mm).
Definition: BaseFrameProperties.idl:155