LibreOffice LibreOffice 24.2 SDK API Reference

Loading...
Searching...
No Matches
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
20module com { module sun { module star { module text {
21
25published service BaseFrameProperties
26{
30 [optional] service com::sun::star::xml::UserDefinedAttributesSupplier;
31
37 [property] short AnchorPageNo;
42 [property] com::sun::star::text::XTextFrame AnchorFrame;
43
46 [property] com::sun::star::util::Color BackColor;
47
58 [property] string BackGraphicURL;
59
62 [property] string BackGraphicFilter;
63
66 [property] com::sun::star::style::GraphicLocation BackGraphicLocation;
67
72 [property] com::sun::star::table::BorderLine LeftBorder;
73
78 [property] com::sun::star::table::BorderLine RightBorder;
79
84 [property] com::sun::star::table::BorderLine TopBorder;
85
90 [property] com::sun::star::table::BorderLine BottomBorder;
91
94 [property] long BorderDistance;
95
98 [property] long LeftBorderDistance;
99
102 [property] long RightBorderDistance;
103
106 [property] long TopBorderDistance;
107
110 [property] long BottomBorderDistance;
111
114 [property] boolean BackTransparent;
115
116
119 [property] boolean ContentProtected;
122 [property] long LeftMargin;
123
126 [property] long RightMargin;
127
128
131 [property] long TopMargin;
132
135 [property] long BottomMargin;
136
140 [property] long Height;
141
145 [property] long Width;
149 [property] short RelativeHeight;
150
154 [property] short RelativeWidth;
157 [property] boolean IsSyncWidthToHeight;
160 [property] boolean IsSyncHeightToWidth;
165 [property] short HoriOrient;
169 [property] long HoriOrientPosition;
170
176 [property] short HoriOrientRelation;
177
182 [property] short VertOrient;
183
189 [property] long VertOrientPosition;
190
191
196 [property] short VertOrientRelation;
197
200 [property] string HyperLinkURL;
201
204 [property] string HyperLinkTarget;
205
208 [property] string HyperLinkName;
209
212 [property] boolean Opaque;
213
216 [property] boolean PageToggle;
217
220 [property] boolean PositionProtected;
221
224 [property] boolean Print;
225
228 [property] com::sun::star::table::ShadowFormat ShadowFormat;
229
232 [property] boolean ServerMap;
233
239 [property] com::sun::star::awt::Size Size;
240
243 [property] boolean SizeProtected;
248 [property] com::sun::star::text::WrapTextMode Surround;
249
253 [property] boolean SurroundAnchorOnly;
254
264 [optional, property] short WrapInfluenceOnPosition;
265
275 [optional, property, maybevoid] com::sun::star::awt::Size LayoutSize;
276
284 [optional, property] string Title;
285
294 [optional, property] string Description;
301 [optional, property] com::sun::star::drawing::FillStyle FillStyle;
307 [optional, property] com::sun::star::awt::Gradient FillGradient;
313 [optional, property] string FillGradientName;
314
322 [optional, property] short ShadowTransparence;
323
332 [optional, property] sequence<com::sun::star::beans::PropertyValue> FrameInteropGrabBag;
333
340 [optional, property] short RelativeHeightRelation;
341
348 [optional, property] short RelativeWidthRelation;
349
354 [optional, property] com::sun::star::graphic::XGraphic BackGraphic;
355
359 [optional, property] boolean AllowOverlap;
360
365 [optional, property] string Tooltip;
366
374 [optional, property] boolean Decorative;
375
380 [optional, property] boolean IsSplitAllowed;
381
386 [optional, property] boolean WrapTextAtFlyStart;
387
388};
389
390
391}; }; }; };
392
393/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::graphic::XGraphic
This interface acts as a container for the loaded graphic.
Definition XGraphic.idl:38
com::sun::star::text::XTextFrame
provides access to the Text of a TextFrame.
Definition XTextFrame.idl:28
com::sun::star::drawing::FillStyle
FillStyle
specifies how an area will be filled.
Definition FillStyle.idl:27
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:28
com::sun::star::text::WrapTextMode
WrapTextMode
enumeration values specify the text wrap around objects in a text.
Definition WrapTextMode.idl:27
com::sun::star::util::Color
long Color
describes an RGB color value with an optional alpha channel.
Definition Color.idl:34
com
Definition Ambiguous.idl:20
com::sun::star::text::BaseFrameProperties
specifies the properties that are provided by all text frames, graphic objects, embedded objects and ...
Definition BaseFrameProperties.idl:26
com::sun::star::text::BaseFrameProperties::VertOrient
short VertOrient
determines the vertical orientation of the object.
Definition BaseFrameProperties.idl:182
com::sun::star::text::BaseFrameProperties::RelativeWidth
short RelativeWidth
contains the relative width of the object.
Definition BaseFrameProperties.idl:154
com::sun::star::text::BaseFrameProperties::Size
com::sun::star::awt::Size Size
contains the size of the object.
Definition BaseFrameProperties.idl:239
com::sun::star::text::BaseFrameProperties::RightMargin
long RightMargin
contains the right margin of the object.
Definition BaseFrameProperties.idl:126
com::sun::star::text::BaseFrameProperties::TopBorder
com::sun::star::table::BorderLine TopBorder
contains the top border of the object.
Definition BaseFrameProperties.idl:84
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:313
com::sun::star::text::BaseFrameProperties::Width
long Width
contains the width of the object (1/100 mm).
Definition BaseFrameProperties.idl:145
com::sun::star::text::BaseFrameProperties::BackGraphicLocation
com::sun::star::style::GraphicLocation BackGraphicLocation
determines the position of the background graphic.
Definition BaseFrameProperties.idl:66
com::sun::star::text::BaseFrameProperties::Print
boolean Print
determines if the object is included in printing.
Definition BaseFrameProperties.idl:224
com::sun::star::text::BaseFrameProperties::TopBorderDistance
long TopBorderDistance
contains the distance from the top border to the object.
Definition BaseFrameProperties.idl:106
com::sun::star::text::BaseFrameProperties::PositionProtected
boolean PositionProtected
determines if the position is protected.
Definition BaseFrameProperties.idl:220
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:332
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:204
com::sun::star::text::BaseFrameProperties::Description
string Description
contains description for the object
Definition BaseFrameProperties.idl:294
com::sun::star::text::BaseFrameProperties::ServerMap
boolean ServerMap
determines if the object gets an image map from a server.
Definition BaseFrameProperties.idl:232
com::sun::star::text::BaseFrameProperties::ShadowTransparence
short ShadowTransparence
This defines the degree of transparence of the shadow in percent.
Definition BaseFrameProperties.idl:322
com::sun::star::text::BaseFrameProperties::ShadowFormat
com::sun::star::table::ShadowFormat ShadowFormat
contains the type of the shadow of the object.
Definition BaseFrameProperties.idl:228
com::sun::star::text::BaseFrameProperties::Decorative
boolean Decorative
Determines if the frame is purely decorative.
Definition BaseFrameProperties.idl:374
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:307
com::sun::star::text::BaseFrameProperties::HoriOrientRelation
short HoriOrientRelation
determines the environment of the object to which the orientation is related.
Definition BaseFrameProperties.idl:176
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:42
com::sun::star::text::BaseFrameProperties::RightBorder
com::sun::star::table::BorderLine RightBorder
contains the right border of the object.
Definition BaseFrameProperties.idl:78
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:301
com::sun::star::text::BaseFrameProperties::BackColor
com::sun::star::util::Color BackColor
contains the color of the background of the object.
Definition BaseFrameProperties.idl:46
com::sun::star::text::BaseFrameProperties::WrapInfluenceOnPosition
short WrapInfluenceOnPosition
determines the influence of the text wrap on the positioning of the shape
Definition BaseFrameProperties.idl:264
com::sun::star::text::BaseFrameProperties::BackGraphic
com::sun::star::graphic::XGraphic BackGraphic
contains the graphic for the background.
Definition BaseFrameProperties.idl:354
com::sun::star::text::BaseFrameProperties::HyperLinkName
string HyperLinkName
contains the name of the hyperlink that is set at the object.
Definition BaseFrameProperties.idl:208
com::sun::star::text::BaseFrameProperties::BackGraphicURL
string BackGraphicURL
contains the URL for the background graphic.
Definition BaseFrameProperties.idl:58
com::sun::star::text::BaseFrameProperties::HoriOrientPosition
long HoriOrientPosition
contains the horizontal position of the object (1/100 mm).
Definition BaseFrameProperties.idl:169
com::sun::star::text::BaseFrameProperties::TopMargin
long TopMargin
contains the top margin of the object.
Definition BaseFrameProperties.idl:131
com::sun::star::text::BaseFrameProperties::BottomBorder
com::sun::star::table::BorderLine BottomBorder
contains the bottom border of the object.
Definition BaseFrameProperties.idl:90
com::sun::star::text::BaseFrameProperties::BottomMargin
long BottomMargin
contains the bottom margin of the object.
Definition BaseFrameProperties.idl:135
com::sun::star::text::BaseFrameProperties::VertOrientPosition
long VertOrientPosition
contains the vertical position of the object (1/100 mm).
Definition BaseFrameProperties.idl:189
com::sun::star::text::BaseFrameProperties::Opaque
boolean Opaque
determines if the object is opaque or transparent for text.
Definition BaseFrameProperties.idl:212
com::sun::star::text::BaseFrameProperties::RelativeHeight
short RelativeHeight
contains the relative height of the object.
Definition BaseFrameProperties.idl:149
com::sun::star::text::BaseFrameProperties::AnchorPageNo
short AnchorPageNo
contains the number of the page where the objects are anchored.
Definition BaseFrameProperties.idl:37
com::sun::star::text::BaseFrameProperties::BorderDistance
long BorderDistance
contains the distance from the border to the object.
Definition BaseFrameProperties.idl:94
com::sun::star::text::BaseFrameProperties::LeftBorderDistance
long LeftBorderDistance
contains the distance from the left border to the object.
Definition BaseFrameProperties.idl:98
com::sun::star::text::BaseFrameProperties::Title
string Title
contains short title for the object
Definition BaseFrameProperties.idl:284
com::sun::star::text::BaseFrameProperties::WrapTextAtFlyStart
boolean WrapTextAtFlyStart
If TRUE, text wraps around a split fly on all pages.
Definition BaseFrameProperties.idl:386
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:253
com::sun::star::text::BaseFrameProperties::LeftMargin
long LeftMargin
contains the left margin of the object.
Definition BaseFrameProperties.idl:122
com::sun::star::text::BaseFrameProperties::PageToggle
boolean PageToggle
determines if the object is mirrored on even pages.
Definition BaseFrameProperties.idl:216
com::sun::star::text::BaseFrameProperties::LayoutSize
com::sun::star::awt::Size LayoutSize
returns the actual size of the object.
Definition BaseFrameProperties.idl:275
com::sun::star::text::BaseFrameProperties::Surround
com::sun::star::text::WrapTextMode Surround
determines the type of the surrounding text.
Definition BaseFrameProperties.idl:248
com::sun::star::text::BaseFrameProperties::AllowOverlap
boolean AllowOverlap
This defines if the frame is allowed to overlap with other anchored objects.
Definition BaseFrameProperties.idl:359
com::sun::star::text::BaseFrameProperties::VertOrientRelation
short VertOrientRelation
determines the environment of the object to which the orientation is related.
Definition BaseFrameProperties.idl:196
com::sun::star::text::BaseFrameProperties::BackGraphicFilter
string BackGraphicFilter
contains the name of the file filter for the background graphic.
Definition BaseFrameProperties.idl:62
com::sun::star::text::BaseFrameProperties::IsSplitAllowed
boolean IsSplitAllowed
If TRUE, the frame is allowed to be split at page breaks.
Definition BaseFrameProperties.idl:380
com::sun::star::text::BaseFrameProperties::RelativeWidthRelation
short RelativeWidthRelation
contains the relation of the relative width of the object.
Definition BaseFrameProperties.idl:348
com::sun::star::text::BaseFrameProperties::Tooltip
string Tooltip
Contains popup text for the frame, used to for tooltip purposes if it's non-empty.
Definition BaseFrameProperties.idl:365
com::sun::star::text::BaseFrameProperties::Height
long Height
contains the height of the object (1/100 mm).
Definition BaseFrameProperties.idl:140
com::sun::star::text::BaseFrameProperties::IsSyncHeightToWidth
boolean IsSyncHeightToWidth
determines whether the height follows the width.
Definition BaseFrameProperties.idl:160
com::sun::star::text::BaseFrameProperties::HoriOrient
short HoriOrient
determines the horizontal orientation of the object.
Definition BaseFrameProperties.idl:165
com::sun::star::text::BaseFrameProperties::BackTransparent
boolean BackTransparent
If TRUE, the "BackColor" is ignored.
Definition BaseFrameProperties.idl:114
com::sun::star::text::BaseFrameProperties::HyperLinkURL
string HyperLinkURL
contains the URL of a hyperlink that is set at the object.
Definition BaseFrameProperties.idl:200
com::sun::star::text::BaseFrameProperties::SizeProtected
boolean SizeProtected
determines if the size is protected.
Definition BaseFrameProperties.idl:243
com::sun::star::text::BaseFrameProperties::RightBorderDistance
long RightBorderDistance
contains the distance from the right border to the object.
Definition BaseFrameProperties.idl:102
com::sun::star::text::BaseFrameProperties::RelativeHeightRelation
short RelativeHeightRelation
contains the relation of the relative height of the object.
Definition BaseFrameProperties.idl:340
com::sun::star::text::BaseFrameProperties::IsSyncWidthToHeight
boolean IsSyncWidthToHeight
determines whether the width follows the height.
Definition BaseFrameProperties.idl:157
com::sun::star::text::BaseFrameProperties::ContentProtected
boolean ContentProtected
determines if the content is protected.
Definition BaseFrameProperties.idl:119
com::sun::star::text::BaseFrameProperties::LeftBorder
com::sun::star::table::BorderLine LeftBorder
contains the left border of the object.
Definition BaseFrameProperties.idl:72
com::sun::star::text::BaseFrameProperties::BottomBorderDistance
long BottomBorderDistance
contains the distance from the bottom border to the object.
Definition BaseFrameProperties.idl:110
com::sun::star::xml::UserDefinedAttributesSupplier
A component that supports this service preserves XML attributes, unknown by its parser,...
Definition UserDefinedAttributesSupplier.idl:29
com::sun::star::awt::Gradient
Describes a gradient between two colors.
Definition Gradient.idl:30
com::sun::star::awt::Size
specifies the 2-dimensional size of an area using width and height.
Definition Size.idl:28
com::sun::star::table::BorderLine
describes the line type for a single cell edge.
Definition BorderLine.idl:27
com::sun::star::table::ShadowFormat
describes the settings of a cell shadow.
Definition ShadowFormat.idl:27