offapi/com/sun/star/text/TextContent.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: TextContent.idl,v $
  10  * $Revision: 1.10.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_TextContent_idl__
  31 #define __com_sun_star_text_TextContent_idl__
  32
  33 #ifndef __com_sun_star_text_XTextContent_idl__
  34 #include <com/sun/star/text/XTextContent.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_text_TextContentAnchorType_idl__
  38 #include <com/sun/star/text/TextContentAnchorType.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_text_WrapTextMode_idl__
  42 #include <com/sun/star/text/WrapTextMode.idl>
  43 #endif
  44
  45
  46 //=============================================================================
  47
  48 module com { module sun { module star { module text {
  49
  50 //=============================================================================
  51 /** is an object which can be anchored in a text, like instances of
  52     <type>TextFrame</type> or <type>TextField</type>.
  53
  54     <p>If the concrete <type>TextContent</type> has a textual
  55     representation which fades into the surrounding text, then
  56     <type>XTextField</type> is used.
  57
  58     <p>If the concrete <type>TextContent</type> has a "floating" object,
  59     like a graphic, <type scope="com::sun::star::drawing">XShape</type>
  60     is used.
  61
  62     @see TextField
  63     @see TextTable
  64     @see TextFrame
  65     @see TextSection
  66     @see TextGraphicObject
  67     @see TextEmbeddedObject
  68 */
  69 published service TextContent
  70 {
  71
  72     /** This interface is used for the attachment of this text content
  73         to the surrounding text.
  74     */
  75     interface com::sun::star::text::XTextContent;
  76
  77     //-------------------------------------------------------------------------
  78     /** specifies how the text content is attached to its surrounding
  79         <type>Text</type>.
  80     */
  81     [optional, property] com::sun::star::text::TextContentAnchorType AnchorType;
  82
  83     //-------------------------------------------------------------------------
  84     /** contains the anchor type of the text content.
  85      @see com::sun::star::text::TextContentAnchorType
  86      */
  87     [optional, readonly, property] sequence<com::sun::star::text::TextContentAnchorType> AnchorTypes;
  88
  89     //-------------------------------------------------------------------------
  90     /** specifies if the text content is a shape
  91         and how the text is wrapped around the shape.
  92     */
  93     [optional, property] com::sun::star::text::WrapTextMode TextWrap;
  94
  95 };
  96
  97 //=============================================================================
  98
  99 }; }; }; };
 100
 101 #endif