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