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