LibreOffice LibreOffice 25.8 SDK API Reference

Loading...
Searching...
No Matches
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
20 module com { module sun { module star { module drawing {
21
22
31published service Shape
32{
33
36 interface com::sun::star::beans::XPropertySet;
37
38
43 interface com::sun::star::drawing::XShape;
44
45
48 interface com::sun::star::lang::XComponent;
49
50
54 interface com::sun::star::drawing::XShapeDescriptor;
55
56
61 [optional] interface com::sun::star::drawing::XGluePointsSupplier;
62
63
64 [optional] interface com::sun::star::beans::XTolerantMultiPropertySet;
65
66
68 [optional, property] long ZOrder;
69
70
74 [optional, property] short LayerID;
75
76
80 [optional, property] string LayerName;
81
82
87 [optional, property] boolean Visible;
88
89
93 [optional, property] boolean Printable;
94
95
99 [optional, property] boolean MoveProtect;
100
101
104 [optional, property] string Name;
105
106
110 [optional, property] boolean SizeProtect;
111
112
115 [optional, property] com::sun::star::style::XStyle Style;
116
117
124 [optional, property] com::sun::star::drawing::HomogenMatrix3 Transformation;
125
126
132 [optional, property] com::sun::star::container::XNameContainer ShapeUserDefinedAttributes;
133
134
139 [optional, property] long NavigationOrder;
140
143 [optional, property] string Hyperlink;
144
154 [optional, property] sequence<com::sun::star::beans::PropertyValue> InteropGrabBag;
155
161 [optional, property] short RelativeHeight;
162
168 [optional, property] short RelativeWidth;
169
176 [optional, property] short RelativeHeightRelation;
177
184 [optional, property] short RelativeWidthRelation;
185
193 [optional, property] string Title;
194
203 [optional, property] string Description;
204
212 [optional, property] boolean Decorative;
213
214};
215
216
217}; }; }; };
218
219/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::beans::XPropertySet
provides information about and access to the properties from an implementation.
Definition XPropertySet.idl:46
com::sun::star::beans::XTolerantMultiPropertySet
provides access to multiple iformation of a set of properties with a single call.
Definition XTolerantMultiPropertySet.idl:41
com::sun::star::container::XNameContainer
This is the generic interface for supporting the insertion and removal of named elements.
Definition XNameContainer.idl:29
com::sun::star::drawing::XGluePointsSupplier
must be supported to provide access to a container of GluePoint2.
Definition XGluePointsSupplier.idl:27
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:31
com::sun::star::drawing::XShape
lets you do a basic transformation on a Shape and get its type.
Definition XShape.idl:29
com::sun::star::lang::XComponent
allows to explicitly free resources and break cyclic references.
Definition XComponent.idl:39
com::sun::star::style::XStyle
specifies a template for a style (aka style sheet).
Definition XStyle.idl:28
com
Definition Ambiguous.idl:20
com::sun::star::drawing::Shape
This abstract service specifies the general characteristics of all Shapes.
Definition Shape.idl:32
com::sun::star::drawing::Shape::Hyperlink
string Hyperlink
this property lets you get and set a hyperlink for this shape.
Definition Shape.idl:143
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:154
com::sun::star::drawing::Shape::RelativeWidth
short RelativeWidth
contains the relative width of the object.
Definition Shape.idl:168
com::sun::star::drawing::Shape::Visible
boolean Visible
If this is FALSE, the Shape is not visible on screen outputs.
Definition Shape.idl:87
com::sun::star::drawing::Shape::Description
string Description
contains description for the object
Definition Shape.idl:203
com::sun::star::drawing::Shape::Decorative
boolean Decorative
Determines if the shape is purely decorative.
Definition Shape.idl:212
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:110
com::sun::star::drawing::Shape::Name
string Name
This is the name of this Shape.
Definition Shape.idl:104
com::sun::star::drawing::Shape::RelativeHeight
short RelativeHeight
contains the relative height of the object.
Definition Shape.idl:161
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:115
com::sun::star::drawing::Shape::Title
string Title
contains short title for the object
Definition Shape.idl:193
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:99
com::sun::star::drawing::Shape::ZOrder
long ZOrder
is used to query or change the ZOrder of this Shape.
Definition Shape.idl:68
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:124
com::sun::star::drawing::Shape::Printable
boolean Printable
If this is FALSE, the Shape is not visible on printer outputs.
Definition Shape.idl:93
com::sun::star::drawing::Shape::RelativeWidthRelation
short RelativeWidthRelation
contains the relation of the relative width of the object.
Definition Shape.idl:184
com::sun::star::drawing::Shape::LayerName
string LayerName
This is the name of the Layer to which this Shape is attached.
Definition Shape.idl:80
com::sun::star::drawing::Shape::NavigationOrder
long NavigationOrder
this property stores the navigation order of this shape.
Definition Shape.idl:139
com::sun::star::drawing::Shape::RelativeHeightRelation
short RelativeHeightRelation
contains the relation of the relative height of the object.
Definition Shape.idl:176
com::sun::star::drawing::Shape::LayerID
short LayerID
This is the ID of the Layer to which this Shape is attached.
Definition Shape.idl:74
com::sun::star::drawing::Shape::ShapeUserDefinedAttributes
com::sun::star::container::XNameContainer ShapeUserDefinedAttributes
this property stores xml attributes.
Definition Shape.idl:132
com::sun::star::drawing::HomogenMatrix3
specifies a homogeneous matrix by three homogeneous lines
Definition HomogenMatrix3.idl:27