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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: Shape.idl,v $
  10  * $Revision: 1.14.122.1 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_text_Shape_idl__
  31 #define __com_sun_star_text_Shape_idl__
  32
  33 #ifndef __com_sun_star_text_TextContent_idl__
  34 #include <com/sun/star/text/TextContent.idl>
  35 #endif
  36 #ifndef __com_sun_star_text_XTextFrame_idl__
  37 #include <com/sun/star/text/XTextFrame.idl>
  38 #endif
  39 #ifndef __com_sun_star_text_XTextRange_idl__
  40 #include <com/sun/star/text/XTextRange.idl>
  41 #endif
  42 #ifndef __com_sun_star_drawing_Shape_idl__
  43 #include <com/sun/star/drawing/Shape.idl>
  44 #endif
  45 #ifndef __com_sun_star_text_TextContentAnchorType_idl__
  46 #include <com/sun/star/text/TextContentAnchorType.idl>
  47 #endif
  48 #ifndef __com_sun_star_text_WrapTextMode_idl__
  49 #include <com/sun/star/text/WrapTextMode.idl>
  50 #endif
  51
  52 //=============================================================================
  53
  54  module com {  module sun {  module star {  module text {
  55
  56 //=============================================================================
  57
  58 /** specifies the service of shapes in a text document
  59  */
  60 published service Shape
  61 {
  62     service com::sun::star::drawing::Shape;
  63     //-------------------------------------------------------------------------
  64     /** contains the number of the page where the objects are anchored.
  65         <p> The value is valid only if the
  66         AnchorType is
  67         <const>TextContentAnchorType::AT_PAGE</const>.</p>
  68      */
  69     [property] short AnchorPageNo;
  70     //-------------------------------------------------------------------------
  71     /** contains the text frame the current frame is anchored to.
  72         <p> The value is valid only if the
  73         AnchorType is <const>TextContentAnchorType::AT_FRAME</const>.</p>
  74      */
  75     [property] com::sun::star::text::XTextFrame AnchorFrame;
  76     //-------------------------------------------------------------------------
  77     /** specifies how the text content is attached to its surrounding
  78         <type>Text</type>.
  79     */
  80     [optional, property] com::sun::star::text::TextContentAnchorType AnchorType;
  81     //-------------------------------------------------------------------------
  82     /** determines the horizontal orientation of the object.
  83
  84         @see BaseFrame::HoriOrientation
  85      */
  86     [property] short HoriOrient;
  87     //-------------------------------------------------------------------------
  88     /** contains the horizontal position of the object (1/100 mm).
  89         <p> It is only valid if "HoriOrient" is HoriOrientation_NONE.</p>
  90      */
  91     [property] long HoriOrientPosition;
  92
  93     //-------------------------------------------------------------------------
  94     /** determines the environment of the object to which the orientation
  95         is related.
  96
  97         @see BaseFrame::RelOrientation
  98      */
  99     [property] short HoriOrientRelation;
 100
 101     //-------------------------------------------------------------------------
 102     /** determines the vertical orientation of the object.
 103
 104         @see BaseFrame::VertOrientation
 105      */
 106     [property] short VertOrient;
 107
 108     //-------------------------------------------------------------------------
 109     /** contains the vertical position of the object (1/100 mm).
 110
 111         It is only valid if <member>TextEmbeddedObject::VertOrient</member> is
 112         <const>VertOrientation::NONE</const>.
 113      */
 114     [property] long VertOrientPosition;
 115
 116     //-------------------------------------------------------------------------
 117
 118     /** determines the environment of the object to which the orientation is related.
 119
 120         @see BaseFrame::RelOrientation
 121      */
 122     [property] short VertOrientRelation;
 123     //-------------------------------------------------------------------------
 124     /** contains the left margin of the object.
 125      */
 126     [property] long LeftMargin;
 127
 128     //-------------------------------------------------------------------------
 129     /** contains the right margin of the object.
 130      */
 131     [property] long RightMargin;
 132     //-------------------------------------------------------------------------
 133
 134     /** contains the top margin of the object.
 135      */
 136     [property] long TopMargin;
 137
 138     //-------------------------------------------------------------------------
 139     /** contains the bottom margin of the object.
 140      */
 141     [property] long BottomMargin;
 142     //-------------------------------------------------------------------------
 143     /** determines the type of the surrounding text.
 144
 145         @deprecated
 146      */
 147     [property] com::sun::star::text::WrapTextMode Surround;
 148     //-------------------------------------------------------------------------
 149     /** determines if the text of the paragraph in which the object
 150         is anchored, wraps around the object.
 151      */
 152     [property] boolean SurroundAnchorOnly;
 153     //-------------------------------------------------------------------------
 154
 155     /** determines if the text wraps around the contour of the object.
 156      */
 157     [property] boolean SurroundContour;
 158     //-------------------------------------------------------------------------
 159
 160     /** the text flows only around the contour of the object.
 161      */
 162     [property] boolean ContourOutside;
 163     //-------------------------------------------------------------------------
 164     /** determines if the object is opaque or transparent for text.
 165      */
 166     [property] boolean Opaque;
 167     //-------------------------------------------------------------------------
 168     /** contains a text range where the shape should be anchored to.
 169      <p>There are two different ways to get newly created shapes into the
 170      text document. One of them is to use the insertTextContent() method of
 171      the <type scope="com::sun::star::text">XSimpleText</type>. The other is to call the add()
 172      method of the <type scope="com::sun::star::drawing">XShapes</type> interface.
 173      To be able to determine an anchor position for shape that are anchored at a certain
 174      text position the property TextRange is used.</p>
 175
 176      <p>This property is used when the shape gets inserted/added
 177      and becomes invalid after that.</p>
 178
 179      */
 180     [property] com::sun::star::text::XTextRange TextRange;
 181
 182     //-------------------------------------------------------------------------
 183         /** determines the influence of the text wrap on the positioning of the
 184             shape
 185
 186             <p>The value of this property is only evaluated for the positioning
 187             of the shape, if the text document setting ConsiderTextWrapOnObjPos
 188             is <TRUE/>. Valid values are given by <member>WrapInfluenceOnPosition</member></p>
 189
 190             @since OOo 2.0.0
 191          */
 192         [optional, property] short WrapInfluenceOnPosition;
 193
 194     //-------------------------------------------------------------------------
 195     /** determines the transformation of the shape in horizontal left-to-right
 196         layout
 197
 198         <p>This property is needed for the export of the OASIS Open Office
 199         file format to the OpenOffice.org file format. It provides the
 200         transformation property of the included service com::sun::star::drawing::Shape
 201         converted to the horizontal left-to-right layout.</p>
 202
 203         @since OOo 2.0.0
 204     */
 205     [optional, readonly, property] com::sun::star::drawing::HomogenMatrix3 TransformationInHoriL2R;
 206     //-------------------------------------------------------------------------
 207     /** determines layout direction the position attributes of the shape
 208         is given
 209
 210         <p>Valid values are given by <member>PositionLayoutDir</member></p>
 211
 212         @since OOo 2.0.0
 213      */
 214     [optional, property] short PositionLayoutDir;
 215     //-------------------------------------------------------------------------
 216     /** determines the start position of the shape in horizontal left-to-right
 217         layout
 218
 219         <p>This property is needed for the export of the OASIS Open Office
 220         file format to the OpenOffice.org file format. It provides the
 221         start position property of the included service com::sun::star::drawing::Shape
 222         converted to the horizontal left-to-right layout.</p>
 223
 224         @since OOo 2.0.0
 225     */
 226     [optional, readonly, property] com::sun::star::awt::Point StartPositionInHoriL2R;
 227     //-------------------------------------------------------------------------
 228     /** determines the end position of the shape in horizontal left-to-right
 229         layout
 230
 231         <p>This property is needed for the export of the OASIS Open Office
 232         file format to the OpenOffice.org file format. It provides the
 233         end position property of the included service com::sun::star::drawing::Shape
 234         converted to the horizontal left-to-right layout.</p>
 235
 236         @since OOo 2.0.0
 237     */
 238     [optional, readonly, property] com::sun::star::awt::Point EndPositionInHoriL2R;
 239 };
 240
 241 //=============================================================================
 242
 243 }; }; }; };
 244
 245 #endif