LibreOffice
LibreOffice 24.2 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 
20 module com { module sun { module star { module text {
21 
25 published service BaseFrameProperties
26 {
31 
37  [property] short AnchorPageNo;
43 
47 
58  [property] string BackGraphicURL;
59 
62  [property] string BackGraphicFilter;
63 
67 
73 
79 
85 
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 
229 
232  [property] boolean ServerMap;
233 
240 
243  [property] boolean SizeProtected;
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;
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 
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: */
long BottomMargin
contains the bottom margin of the object.
Definition: BaseFrameProperties.idl:135
boolean WrapTextAtFlyStart
If TRUE, text wraps around a split fly on all pages.
Definition: BaseFrameProperties.idl:386
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
long VertOrientPosition
contains the vertical position of the object (1/100 mm).
Definition: BaseFrameProperties.idl:189
long BorderDistance
contains the distance from the border to the object.
Definition: BaseFrameProperties.idl:94
short RelativeHeightRelation
contains the relation of the relative height of the object.
Definition: BaseFrameProperties.idl:340
com::sun::star::awt::Size Size
contains the size of the object.
Definition: BaseFrameProperties.idl:239
com::sun::star::table::BorderLine BottomBorder
contains the bottom border of the object.
Definition: BaseFrameProperties.idl:90
short HoriOrientRelation
determines the environment of the object to which the orientation is related.
Definition: BaseFrameProperties.idl:176
provides access to the Text of a TextFrame.
Definition: XTextFrame.idl:27
short WrapInfluenceOnPosition
determines the influence of the text wrap on the positioning of the shape
Definition: BaseFrameProperties.idl:264
long HoriOrientPosition
contains the horizontal position of the object (1/100 mm).
Definition: BaseFrameProperties.idl:169
long RightBorderDistance
contains the distance from the right border to the object.
Definition: BaseFrameProperties.idl:102
short ShadowTransparence
This defines the degree of transparence of the shadow in percent.
Definition: BaseFrameProperties.idl:322
string BackGraphicURL
contains the URL for the background graphic.
Definition: BaseFrameProperties.idl:58
com::sun::star::awt::Gradient FillGradient
If the property FillStyle is set to FillStyle::GRADIENT, this describes the gradient used...
Definition: BaseFrameProperties.idl:307
boolean PositionProtected
determines if the position is protected.
Definition: BaseFrameProperties.idl:220
long TopBorderDistance
contains the distance from the top border to the object.
Definition: BaseFrameProperties.idl:106
com::sun::star::table::BorderLine RightBorder
contains the right border of the object.
Definition: BaseFrameProperties.idl:78
com::sun::star::drawing::FillStyle FillStyle
This enumeration selects the style the area will be filled with.
Definition: BaseFrameProperties.idl:301
boolean AllowOverlap
This defines if the frame is allowed to overlap with other anchored objects.
Definition: BaseFrameProperties.idl:359
com::sun::star::table::BorderLine TopBorder
contains the top border of the object.
Definition: BaseFrameProperties.idl:84
Definition: Ambiguous.idl:20
FillStyle
specifies how an area will be filled.
Definition: FillStyle.idl:26
short RelativeWidth
contains the relative width of the object.
Definition: BaseFrameProperties.idl:154
boolean IsSplitAllowed
If TRUE, the frame is allowed to be split at page breaks.
Definition: BaseFrameProperties.idl:380
boolean IsSyncWidthToHeight
determines whether the width follows the height.
Definition: BaseFrameProperties.idl:157
long LeftMargin
contains the left margin of the object.
Definition: BaseFrameProperties.idl:122
string Tooltip
Contains popup text for the frame, used to for tooltip purposes if it&#39;s non-empty.
Definition: BaseFrameProperties.idl:365
This interface acts as a container for the loaded graphic.
Definition: XGraphic.idl:37
string Description
contains description for the object
Definition: BaseFrameProperties.idl:294
boolean Decorative
Determines if the frame is purely decorative.
Definition: BaseFrameProperties.idl:374
boolean Print
determines if the object is included in printing.
Definition: BaseFrameProperties.idl:224
long RightMargin
contains the right margin of the object.
Definition: BaseFrameProperties.idl:126
boolean ContentProtected
determines if the content is protected.
Definition: BaseFrameProperties.idl:119
GraphicLocation
These enumeration values are used to specify the location of a graphic object within its surroundings...
Definition: GraphicLocation.idl:27
short RelativeHeight
contains the relative height of the object.
Definition: BaseFrameProperties.idl:149
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:28
boolean SizeProtected
determines if the size is protected.
Definition: BaseFrameProperties.idl:243
com::sun::star::text::XTextFrame AnchorFrame
contains the text frame the current frame is anchored to.
Definition: BaseFrameProperties.idl:42
boolean ServerMap
determines if the object gets an image map from a server.
Definition: BaseFrameProperties.idl:232
specifies the properties that are provided by all text frames, graphic objects, embedded objects and ...
Definition: BaseFrameProperties.idl:25
boolean BackTransparent
If TRUE, the "BackColor" is ignored.
Definition: BaseFrameProperties.idl:114
com::sun::star::text::WrapTextMode Surround
determines the type of the surrounding text.
Definition: BaseFrameProperties.idl:248
boolean SurroundAnchorOnly
determines if the text of the paragraph in which the object is anchored, wraps around the object...
Definition: BaseFrameProperties.idl:253
long LeftBorderDistance
contains the distance from the left border to the object.
Definition: BaseFrameProperties.idl:98
describes the settings of a cell shadow.
Definition: ShadowFormat.idl:26
string HyperLinkURL
contains the URL of a hyperlink that is set at the object.
Definition: BaseFrameProperties.idl:200
long TopMargin
contains the top margin of the object.
Definition: BaseFrameProperties.idl:131
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::style::GraphicLocation BackGraphicLocation
determines the position of the background graphic.
Definition: BaseFrameProperties.idl:66
string HyperLinkTarget
contains the name of the target for a hyperlink that is set at the object.
Definition: BaseFrameProperties.idl:204
com::sun::star::table::BorderLine LeftBorder
contains the left border of the object.
Definition: BaseFrameProperties.idl:72
specifies the 2-dimensional size of an area using width and height.
Definition: Size.idl:27
string BackGraphicFilter
contains the name of the file filter for the background graphic.
Definition: BaseFrameProperties.idl:62
string Title
contains short title for the object
Definition: BaseFrameProperties.idl:284
Describes a gradient between two colors.
Definition: Gradient.idl:29
WrapTextMode
enumeration values specify the text wrap around objects in a text.
Definition: WrapTextMode.idl:26
com::sun::star::table::ShadowFormat ShadowFormat
contains the type of the shadow of the object.
Definition: BaseFrameProperties.idl:228
short VertOrientRelation
determines the environment of the object to which the orientation is related.
Definition: BaseFrameProperties.idl:196
long Color
describes an RGB color value with an optional alpha channel.
Definition: Color.idl:34
com::sun::star::awt::Size LayoutSize
returns the actual size of the object.
Definition: BaseFrameProperties.idl:275
describes the line type for a single cell edge.
Definition: BorderLine.idl:26
string HyperLinkName
contains the name of the hyperlink that is set at the object.
Definition: BaseFrameProperties.idl:208
boolean Opaque
determines if the object is opaque or transparent for text.
Definition: BaseFrameProperties.idl:212
short VertOrient
determines the vertical orientation of the object.
Definition: BaseFrameProperties.idl:182
com::sun::star::graphic::XGraphic BackGraphic
contains the graphic for the background.
Definition: BaseFrameProperties.idl:354
short HoriOrient
determines the horizontal orientation of the object.
Definition: BaseFrameProperties.idl:165
com::sun::star::util::Color BackColor
contains the color of the background of the object.
Definition: BaseFrameProperties.idl:46
boolean PageToggle
determines if the object is mirrored on even pages.
Definition: BaseFrameProperties.idl:216
short RelativeWidthRelation
contains the relation of the relative width of the object.
Definition: BaseFrameProperties.idl:348
long BottomBorderDistance
contains the distance from the bottom border to the object.
Definition: BaseFrameProperties.idl:110
long Width
contains the width of the object (1/100 mm).
Definition: BaseFrameProperties.idl:145
boolean IsSyncHeightToWidth
determines whether the height follows the width.
Definition: BaseFrameProperties.idl:160
long Height
contains the height of the object (1/100 mm).
Definition: BaseFrameProperties.idl:140