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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_text_TextContent_idl__
  28 #define __com_sun_star_text_TextContent_idl__
  29
  30 #ifndef __com_sun_star_text_XTextContent_idl__
  31 #include <com/sun/star/text/XTextContent.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_text_TextContentAnchorType_idl__
  35 #include <com/sun/star/text/TextContentAnchorType.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_text_WrapTextMode_idl__
  39 #include <com/sun/star/text/WrapTextMode.idl>
  40 #endif
  41
  42
  43 //=============================================================================
  44
  45 module com { module sun { module star { module text {
  46
  47 //=============================================================================
  48 /** is an object which can be anchored in a text, like instances of
  49     <type>TextFrame</type> or <type>TextField</type>.
  50
  51     <p>If the concrete <type>TextContent</type> has a textual
  52     representation which fades into the surrounding text, then
  53     <type>XTextField</type> is used.
  54
  55     <p>If the concrete <type>TextContent</type> has a "floating" object,
  56     like a graphic, <type scope="com::sun::star::drawing">XShape</type>
  57     is used.
  58
  59     @see TextField
  60     @see TextTable
  61     @see TextFrame
  62     @see TextSection
  63     @see TextGraphicObject
  64     @see TextEmbeddedObject
  65 */
  66 published service TextContent
  67 {
  68
  69     /** This interface is used for the attachment of this text content
  70         to the surrounding text.
  71     */
  72     interface com::sun::star::text::XTextContent;
  73
  74     //-------------------------------------------------------------------------
  75     /** specifies how the text content is attached to its surrounding
  76         <type>Text</type>.
  77     */
  78     [optional, property] com::sun::star::text::TextContentAnchorType AnchorType;
  79
  80     //-------------------------------------------------------------------------
  81     /** contains the anchor type of the text content.
  82      @see com::sun::star::text::TextContentAnchorType
  83      */
  84     [optional, readonly, property] sequence<com::sun::star::text::TextContentAnchorType> AnchorTypes;
  85
  86     //-------------------------------------------------------------------------
  87     /** specifies if the text content is a shape
  88         and how the text is wrapped around the shape.
  89     */
  90     [optional, property] com::sun::star::text::WrapTextMode TextWrap;
  91
  92 };
  93
  94 //=============================================================================
  95
  96 }; }; }; };
  97
  98 #endif