offapi/com/sun/star/drawing/Shape.idl

   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
  35 /** This abstract service specifies the general characteristics of all
  36     Shapes.
  37
  38     @see XShape
  39     @see com::sun::star::lang::XComponent
  40     @see com::sun::star::text::XText
  41     @see ShapeDescriptor
  42  */
  43 published service Shape
  44 {
  45
  46     /** handles all the properties of this instance.
  47      */
  48     interface com::sun::star::beans::XPropertySet;
  49
  50
  51     /** This gives you the size and position of this Shape
  52                 and lets you change it. You can use getShapeType()
  53                 to determine what kind of shape this is.
  54      */
  55     interface com::sun::star::drawing::XShape;
  56
  57
  58     /** is used for lifetime control of this Shape.
  59      */
  60     interface com::sun::star::lang::XComponent;
  61
  62
  63     /** The XShapeDescriptor tells you what kind of
  64                 Shape this instance is.
  65      */
  66     interface com::sun::star::drawing::XShapeDescriptor;
  67
  68
  69     /** This interfaces gives access to an optional container of glue points.
  70         To have unique ids you should query the returned interface for
  71         com::sun::star::container::XIdentifierContainer.
  72     */
  73     [optional] interface com::sun::star::drawing::XGluePointsSupplier;
  74
  75
  76         [optional] interface com::sun::star::beans::XTolerantMultiPropertySet;
  77
  78
  79     /** is used to query or change the ZOrder of this Shape. */
  80     [optional, property] long ZOrder;
  81
  82
  83     /** This is the ID of the Layer to which this
  84         Shape is attached.
  85      */
  86     [optional, property] short LayerID;
  87
  88
  89     /** This is the name of the Layer to which this
  90         Shape is attached.
  91      */
  92     [optional, property] string LayerName;
  93
  94
  95     /** If this is `FALSE`, the Shape is not visible
  96         on screen outputs. Please note that the Shape may still
  97         be visible when printed, see #Printable.
  98      */
  99     [optional, property] boolean Visible;
 100
 101
 102     /** If this is `FALSE`, the Shape is not visible
 103         on printer outputs.
 104      */
 105     [optional, property] boolean Printable;
 106
 107
 108     /** With this set to `TRUE`, this Shape
 109         cannot be moved interactively in the user interface.
 110      */
 111     [optional, property] boolean MoveProtect;
 112
 113
 114     /** This is the name of this Shape.
 115      */
 116     [optional, property] string Name;
 117
 118
 119     /** With this set to `TRUE`, this Shape may not be
 120         sized interactively in the user interface.
 121      */
 122     [optional, property] boolean SizeProtect;
 123
 124
 125     /** this property lets you get and set a style for this shape.
 126      */
 127     [optional, property] com::sun::star::style::XStyle Style;
 128
 129
 130     /** this property lets you get and set the transformation matrix
 131         for this shape.
 132
 133         The transformation is a 3x3 homogeneous matrix and can contain
 134         translation, rotation, shearing and scaling.
 135      */
 136     [optional, property] com::sun::star::drawing::HomogenMatrix3 Transformation;
 137
 138
 139     /** this property stores xml attributes.
 140         They will be saved to and restored from automatic styles inside xml files.
 141
 142         @see com::sun::star::xml::AttributeContainer
 143     */
 144     [optional, property] com::sun::star::container::XNameContainer ShapeUserDefinedAttributes;
 145
 146
 147     /** this property stores the navigation order of this shape. If this value
 148         is negative, the navigation order for this shapes page is equal to
 149         the z-order.
 150     */
 151     [optional, property] long NavigationOrder;
 152
 153     /** this property lets you get and set a hyperlink for this shape.
 154      */
 155     [optional, property] string Hyperlink;
 156
 157     /** Grab bag of shape properties, used as a string-any map for
 158         interim interop purposes.
 159
 160         @since LibreOffice 4.2
 161
 162         <p>This property is intentionally not handled by the ODF
 163         filter. Any member that should be handled there should be
 164         first moved out from this grab bag to a separate property.</p>
 165     */
 166     [optional, property] sequence<com::sun::star::beans::PropertyValue> InteropGrabBag;
 167
 168     /** contains the relative height of the object.
 169         <p> It is only valid if it is greater than zero.</p>
 170
 171         @since LibreOffice 4.3
 172      */
 173     [optional, property] short RelativeHeight;
 174
 175     /** contains the relative width of the object.
 176         <p> It is only valid if it is greater than zero. </p>
 177
 178         @since LibreOffice 4.3
 179      */
 180     [optional, property] short RelativeWidth;
 181
 182     /** contains the relation of the relative height of the object.
 183         <p> It is only valid if RelativeHeight is greater than zero.</p>
 184
 185         @see com::sun::star::text::RelOrientation
 186         @since LibreOffice 4.3
 187      */
 188     [optional, property] short RelativeHeightRelation;
 189
 190     /** contains the relation of the relative width of the object.
 191         <p> It is only valid if RelativeWidth is greater than zero.</p>
 192
 193         @see com::sun::star::text::RelOrientation
 194         @since LibreOffice 4.3
 195      */
 196     [optional, property] short RelativeWidthRelation;
 197 };
 198
 199
 200 }; }; }; };
 201
 202 #endif
 203
 204 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */