LibreOffice LibreOffice 6.0 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_drawing_Shape_idl__
20 #define __com_sun_star_drawing_Shape_idl__
21
22 #include <com/sun/star/document/LinkTarget.idl>
23 #include <com/sun/star/drawing/XShape.idl>
24 #include <com/sun/star/lang/XComponent.idl>
25 #include <com/sun/star/style/XStyle.idl>
26 #include <com/sun/star/drawing/HomogenMatrix3.idl>
27 #include <com/sun/star/drawing/XGluePointsSupplier.idl>
28 #include <com/sun/star/container/XNameContainer.idl>
29 #include <com/sun/star/beans/XTolerantMultiPropertySet.idl>
30 #include <com/sun/star/beans/PropertyValue.idl>
31
32 module com { module sun { module star { module drawing {
33
34
43 published service Shape
44 {
45
48 interface com::sun::star::beans::XPropertySet;
49
50
55 interface com::sun::star::drawing::XShape;
56
57
60 interface com::sun::star::lang::XComponent;
61
62
66 interface com::sun::star::drawing::XShapeDescriptor;
67
68
73 [optional] interface com::sun::star::drawing::XGluePointsSupplier;
74
75
76 [optional] interface com::sun::star::beans::XTolerantMultiPropertySet;
77
78
80 [optional, property] long ZOrder;
81
82
86 [optional, property] short LayerID;
87
88
92 [optional, property] string LayerName;
93
94
99 [optional, property] boolean Visible;
100
101
105 [optional, property] boolean Printable;
106
107
111 [optional, property] boolean MoveProtect;
112
113
116 [optional, property] string Name;
117
118
122 [optional, property] boolean SizeProtect;
123
124
127 [optional, property] com::sun::star::style::XStyle Style;
128
129
136 [optional, property] com::sun::star::drawing::HomogenMatrix3 Transformation;
137
138
144 [optional, property] com::sun::star::container::XNameContainer ShapeUserDefinedAttributes;
145
146
151 [optional, property] long NavigationOrder;
152
155 [optional, property] string Hyperlink;
156
166 [optional, property] sequence<com::sun::star::beans::PropertyValue> InteropGrabBag;
167
173 [optional, property] short RelativeHeight;
174
180 [optional, property] short RelativeWidth;
181
188 [optional, property] short RelativeHeightRelation;
189
196 [optional, property] short RelativeWidthRelation;
197 };
198
199
200 }; }; }; };
201
202 #endif
203
204 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::drawing::Shape::Style
com::sun::star::style::XStyle Style
this property lets you get and set a style for this shape.
Definition: Shape.idl:127
com::sun::star::style::XStyle
specifies a template for a style (aka style sheet).
Definition: XStyle.idl:33
com::sun::star::drawing::Shape::RelativeHeight
short RelativeHeight
contains the relative height of the object.
Definition: Shape.idl:173
com::sun::star::drawing::XShapeDescriptor
offers some settings which are allowed even for objects which are not yet inserted into a draw page...
Definition: XShapeDescriptor.idl:34
com::sun::star::lang::XComponent
allows to explicitly free resources and break cyclic references.
Definition: XComponent.idl:42
XTolerantMultiPropertySet.idl
com::sun::star::beans::XTolerantMultiPropertySet
provides access to multiple iformation of a set of properties with a single call. ...
Definition: XTolerantMultiPropertySet.idl:48
com
Definition: Ambiguous.idl:22
com::sun::star::drawing::Shape::LayerName
string LayerName
This is the name of the Layer to which this Shape is attached.
Definition: Shape.idl:92
XGluePointsSupplier.idl
com::sun::star::drawing::Shape::Printable
boolean Printable
If this is FALSE, the Shape is not visible on printer outputs.
Definition: Shape.idl:105
com::sun::star::drawing::XGluePointsSupplier
must be supported to provide access to a container of GluePoint2.
Definition: XGluePointsSupplier.idl:30
PropertyValue.idl
XNameContainer.idl
com::sun::star::drawing::Shape::Visible
boolean Visible
If this is FALSE, the Shape is not visible on screen outputs.
Definition: Shape.idl:99
com::sun::star::drawing::Shape
This abstract service specifies the general characteristics of all Shapes.
Definition: Shape.idl:43
com::sun::star::drawing::Shape::ShapeUserDefinedAttributes
com::sun::star::container::XNameContainer ShapeUserDefinedAttributes
this property stores xml attributes.
Definition: Shape.idl:144
XStyle.idl
com::sun::star::drawing::Shape::ZOrder
long ZOrder
is used to query or change the ZOrder of this Shape.
Definition: Shape.idl:76
com::sun::star::container::XNameContainer
This is the generic interface for supporting the insertion and removal of named elements.
Definition: XNameContainer.idl:40
XComponent.idl
com::sun::star::drawing::Shape::MoveProtect
boolean MoveProtect
With this set to TRUE, this Shape cannot be moved interactively in the user interface.
Definition: Shape.idl:111
com::sun::star::drawing::Shape::Transformation
com::sun::star::drawing::HomogenMatrix3 Transformation
this property lets you get and set the transformation matrix for this shape.
Definition: Shape.idl:136
com::sun::star::drawing::Shape::SizeProtect
boolean SizeProtect
With this set to TRUE, this Shape may not be sized interactively in the user interface.
Definition: Shape.idl:122
HomogenMatrix3.idl
com::sun::star::drawing::Shape::RelativeWidth
short RelativeWidth
contains the relative width of the object.
Definition: Shape.idl:180
com::sun::star::drawing::HomogenMatrix3
specifies a homogeneous matrix by three homogeneous lines
Definition: HomogenMatrix3.idl:30
XShape.idl
com::sun::star::drawing::Shape::Hyperlink
string Hyperlink
this property lets you get and set a hyperlink for this shape.
Definition: Shape.idl:155
com::sun::star::drawing::XShape
lets you do a basic transformation on a Shape and get its type.
Definition: XShape.idl:38
LinkTarget.idl
com::sun::star::beans::XPropertySet
provides information about and access to the properties from an implementation.
Definition: XPropertySet.idl:63
com::sun::star::drawing::Shape::LayerID
short LayerID
This is the ID of the Layer to which this Shape is attached.
Definition: Shape.idl:86
com::sun::star::drawing::Shape::NavigationOrder
long NavigationOrder
this property stores the navigation order of this shape.
Definition: Shape.idl:151
com::sun::star::drawing::Shape::RelativeHeightRelation
short RelativeHeightRelation
contains the relation of the relative height of the object.
Definition: Shape.idl:188
com::sun::star::drawing::Shape::Name
string Name
This is the name of this Shape.
Definition: Shape.idl:116
com::sun::star::drawing::Shape::RelativeWidthRelation
short RelativeWidthRelation
contains the relation of the relative width of the object.
Definition: Shape.idl:196
com::sun::star::drawing::Shape::InteropGrabBag
sequence< com::sun::star::beans::PropertyValue > InteropGrabBag
Grab bag of shape properties, used as a string-any map for interim interop purposes.
Definition: Shape.idl:166