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