LibreOffice
LibreOffice 6.2 SDK API Reference
Shape.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_Shape_idl__
20 #define __com_sun_star_text_Shape_idl__
21 
28 
29 
30  module com { module sun { module star { module text {
31 
32 
35 published service Shape
36 {
43  [property] short AnchorPageNo;
57  [property] short HoriOrient;
61  [property] long HoriOrientPosition;
62 
68  [property] short HoriOrientRelation;
69 
74  [property] short VertOrient;
75 
81  [property] long VertOrientPosition;
82 
83 
88  [property] short VertOrientRelation;
91  [property] long LeftMargin;
92 
95  [property] long RightMargin;
96 
99  [property] long TopMargin;
100 
103  [property] long BottomMargin;
112  [property] boolean SurroundAnchorOnly;
113 
116  [property] boolean SurroundContour;
117 
120  [property] boolean ContourOutside;
123  [property] boolean Opaque;
137 
147  [optional, property] short WrapInfluenceOnPosition;
148 
167  [optional, property] short PositionLayoutDir;
178  [optional, readonly, property] com::sun::star::awt::Point StartPositionInHoriL2R;
189  [optional, readonly, property] com::sun::star::awt::Point EndPositionInHoriL2R;
190 };
191 
192 
193 }; }; }; };
194 
195 #endif
196 
197 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
long TopMargin
contains the top margin of the object.
Definition: Shape.idl:99
provides access to the Text of a TextFrame.
Definition: XTextFrame.idl:32
long BottomMargin
contains the bottom margin of the object.
Definition: Shape.idl:103
short PositionLayoutDir
determines layout direction the position attributes of the shape is given
Definition: Shape.idl:167
long VertOrientPosition
contains the vertical position of the object (1/100 mm).
Definition: Shape.idl:81
specifies a 2-dimensional point using the Cartesian coordinate system.
Definition: Point.idl:29
TextContentAnchorType
specify how the text content is attached to its surrounding text.
Definition: TextContentAnchorType.idl:29
com::sun::star::drawing::HomogenMatrix3 TransformationInHoriL2R
determines the transformation of the shape in horizontal left-to-right layout
Definition: Shape.idl:159
long LeftMargin
contains the left margin of the object.
Definition: Shape.idl:91
Definition: Ambiguous.idl:22
long RightMargin
contains the right margin of the object.
Definition: Shape.idl:95
boolean Opaque
determines if the object is opaque or transparent for text.
Definition: Shape.idl:123
This abstract service specifies the general characteristics of all Shapes.
Definition: Shape.idl:43
boolean SurroundAnchorOnly
determines if the text of the paragraph in which the object is anchored, wraps around the object...
Definition: Shape.idl:112
short HoriOrient
determines the horizontal orientation of the object.
Definition: Shape.idl:57
describes the object's position in a text.
Definition: XTextRange.idl:37
short WrapInfluenceOnPosition
determines the influence of the text wrap on the positioning of the shape
Definition: Shape.idl:147
specifies the service of shapes in a text document
Definition: Shape.idl:35
com::sun::star::text::WrapTextMode Surround
determines the type of the surrounding text.
Definition: Shape.idl:108
long HoriOrientPosition
contains the horizontal position of the object (1/100 mm).
Definition: Shape.idl:61
com::sun::star::text::XTextRange TextRange
contains a text range where the shape should be anchored to.
Definition: Shape.idl:136
specifies a homogeneous matrix by three homogeneous lines
Definition: HomogenMatrix3.idl:30
boolean ContourOutside
the text flows only around the contour of the object.
Definition: Shape.idl:120
boolean SurroundContour
determines if the text wraps around the contour of the object.
Definition: Shape.idl:116
WrapTextMode
enumeration values specify the text wrap around objects in a text.
Definition: WrapTextMode.idl:28
com::sun::star::awt::Point StartPositionInHoriL2R
determines the start position of the shape in horizontal left-to-right layout
Definition: Shape.idl:178
com::sun::star::text::XTextFrame AnchorFrame
contains the text frame the current frame is anchored to.
Definition: Shape.idl:48
com::sun::star::awt::Point EndPositionInHoriL2R
determines the end position of the shape in horizontal left-to-right layout
Definition: Shape.idl:189
short VertOrientRelation
determines the environment of the object to which the orientation is related.
Definition: Shape.idl:88
short VertOrient
determines the vertical orientation of the object.
Definition: Shape.idl:74
com::sun::star::text::TextContentAnchorType AnchorType
specifies how the text content is attached to its surrounding Text.
Definition: Shape.idl:52
short HoriOrientRelation
determines the environment of the object to which the orientation is related.
Definition: Shape.idl:68