office-gobmx/offapi/com/sun/star/drawing/Shape.idl
Michael Meeks c73745117d re-base on ALv2 code. Includes:
linecap: Reintegrating finished LineCap feature
    Work contributed by Regina Henschel
    http://svn.apache.org/viewvc?view=revision&revision=1232507

    i118815 - Deprecate service due to removed implementation
    Patch contributed by Ariel Constenla-Haile
    http://svn.apache.org/viewvc?view=revision&revision=1233320

    i118814 - Allow set timeout in Mail API
    Patch contributed by Ariel Constenla-Haile
    http://svn.apache.org/viewvc?view=revision&revision=1235679

    included in the Apache baseline:
    dr80: #i117511# remove some assertions in xlsx/xlsb import filters
    Patch contributed by Daniel Rentz
2012-09-27 11:35:06 +01:00

163 lines
5.1 KiB
Text

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef __com_sun_star_drawing_Shape_idl__
#define __com_sun_star_drawing_Shape_idl__
#include <com/sun/star/document/LinkTarget.idl>
#include <com/sun/star/drawing/XShape.idl>
#include <com/sun/star/lang/XComponent.idl>
#include <com/sun/star/style/XStyle.idl>
#include <com/sun/star/drawing/HomogenMatrix3.idl>
#include <com/sun/star/drawing/XGluePointsSupplier.idl>
#include <com/sun/star/container/XNameContainer.idl>
#include <com/sun/star/beans/XTolerantMultiPropertySet.idl>
module com { module sun { module star { module drawing {
/** This abstract service specifies the general characteristics of all
<type>Shape</type>s.
@see XShape
@see com::sun::star::lang::XComponent
@see com::sun::star::text::XText
@see ShapeDescriptor
*/
published service Shape
{
/** handles all the properties of this instance.
*/
interface com::sun::star::beans::XPropertySet;
/** This gives you the size and position of this <type>Shape</type>
and lets you change it. You can use <member>getShapeType</member>
to determine what kind of shape this is.
*/
interface com::sun::star::drawing::XShape;
/** is used for lifetime control of this <type>Shape</type>.
*/
interface com::sun::star::lang::XComponent;
/** The <type>XShapeDescriptor</type> tells you what kind of
<type>Shape</type> this instance is.
*/
interface com::sun::star::drawing::XShapeDescriptor;
/** This interfaces gives access to an optional container of glue points.
To have unique ids you should query the returned interface for
<type scope="com::sun::star::container">XIdentifierContainer</type>.
*/
[optional] interface com::sun::star::drawing::XGluePointsSupplier;
[optional] interface com::sun::star::beans::XTolerantMultiPropertySet;
/** is used to query or change the ZOrder of this <type>Shape</type>. */
[optional, property] long ZOrder;
/** This is the ID of the <type>Layer</type> to which this
<type>Shape</type> is attached.
*/
[optional, property] short LayerID;
/** This is the name of the <type>Layer</type> to which this
<type>Shape</type> is attached.
*/
[optional, property] string LayerName;
/** If this is <FALSE/>, the <type>Shape</type> is not visible
on screen outputs. Please note that the <type>Shape</type> may still
be visible when printed, see <member>Printable</member>.
*/
[optional, property] boolean Visible;
/** If this is <FALSE/>, the <type>Shape</type> is not visible
on printer outputs.
*/
[optional, property] boolean Printable;
/** With this set to <TRUE/>, this <type>Shape</type>
cannot be moved interactively in the user interface.
*/
[optional, property] boolean MoveProtect;
/** This is the name of this <type>Shape</type>.
*/
[optional, property] string Name;
/** With this set to <TRUE/>, this <type>Shape</type> may not be
sized interactively in the user interface.
*/
[optional, property] boolean SizeProtect;
/** this property lets you get and set a style for this shape.
*/
[optional, property] com::sun::star::style::XStyle Style;
/** this property lets you get and set the transformation matrix
for this shape.
The transformation is a 3x3 homogeneous matrix and can contain
translation, rotation, shearing and scaling.
*/
[optional, property] com::sun::star::drawing::HomogenMatrix3 Transformation;
/** this property stores xml attributes.
They will be saved to and restored from automatic styles inside xml files.
@see com::sun::star::xml::AttributeContainer
*/
[optional, property] com::sun::star::container::XNameContainer ShapeUserDefinedAttributes;
/** this property stores the navigation order of this shape. If this value
is negative, the navigation order for this shapes page is equal to
the z-order.
*/
[optional, property] long NavigationOrder;
/** this property lets you get and set a hyperlink for this shape.
*/
[optional, property] string Hyperlink;
};
}; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */