offapi/com/sun/star/text/TextContent.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 #ifndef __com_sun_star_text_TextContent_idl__
  20 #define __com_sun_star_text_TextContent_idl__
  21
  22 #include <com/sun/star/text/XTextContent.idl>
  23 #include <com/sun/star/text/TextContentAnchorType.idl>
  24 #include <com/sun/star/text/WrapTextMode.idl>
  25
  26
  27
  28 module com { module sun { module star { module text {
  29
  30 /** is an object which can be anchored in a text, like instances of
  31     TextFrame or TextField.
  32
  33     <p>If the concrete TextContent has a textual
  34     representation which fades into the surrounding text, then
  35     XTextField is used.
  36
  37     <p>If the concrete TextContent has a "floating" object,
  38     like a graphic, com::sun::star::drawing::XShape
  39     is used.
  40
  41     @see TextField
  42     @see TextTable
  43     @see TextFrame
  44     @see TextSection
  45     @see TextGraphicObject
  46     @see TextEmbeddedObject
  47 */
  48 published service TextContent
  49 {
  50
  51     /** This interface is used for the attachment of this text content
  52         to the surrounding text.
  53     */
  54     interface com::sun::star::text::XTextContent;
  55
  56     /** specifies how the text content is attached to its surrounding
  57         Text.
  58     */
  59     [optional, property] com::sun::star::text::TextContentAnchorType AnchorType;
  60
  61     /** contains the anchor type of the text content.
  62      @see com::sun::star::text::TextContentAnchorType
  63      */
  64     [optional, readonly, property] sequence<com::sun::star::text::TextContentAnchorType> AnchorTypes;
  65
  66     /** specifies if the text content is a shape
  67         and how the text is wrapped around the shape.
  68     */
  69     [optional, property] com::sun::star::text::WrapTextMode TextWrap;
  70
  71 };
  72
  73
  74 }; }; }; };
  75
  76 #endif
  77
  78 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */