offapi/com/sun/star/text/TextRange.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_TextRange_idl__
  20 #define __com_sun_star_text_TextRange_idl__
  21
  22 #include <com/sun/star/text/XTextRange.idl>
  23 #include <com/sun/star/beans/XPropertySet.idl>
  24 #include <com/sun/star/beans/XPropertyState.idl>
  25 #include <com/sun/star/style/CharacterProperties.idl>
  26 #include <com/sun/star/style/ParagraphProperties.idl>
  27 #include <com/sun/star/style/ParagraphPropertiesAsian.idl>
  28 #include <com/sun/star/style/ParagraphPropertiesComplex.idl>
  29 #include <com/sun/star/style/CharacterPropertiesAsian.idl>
  30 #include <com/sun/star/style/CharacterPropertiesComplex.idl>
  31 #include <com/sun/star/container/XContentEnumerationAccess.idl>
  32
  33
  34 module com {  module sun {  module star {  module text {
  35
  36
  37 /** points to a sequence of characters within a Text.
  38
  39     <p>The service provides access to the string content and the properties
  40     of this range of text and the TextContent instances which
  41     are bound to this text range.  </p>
  42
  43     <p>A TextRange is also used for a <i>text portion</i> which is
  44     returned by the com::sun::star::container::XEnumeration
  45     for a single paragraph. Because this is the mechanism to use to export
  46     data, all formatting attributes and contents bound to this range have
  47     to be available from implementations of this service. </p>
  48
  49     @see Text
  50  */
  51 published service TextRange
  52 {
  53     interface com::sun::star::text::XTextRange;
  54
  55     interface com::sun::star::beans::XPropertySet;
  56
  57     interface com::sun::star::beans::XPropertyState;
  58
  59     [optional] interface com::sun::star::container::XContentEnumerationAccess;
  60
  61     service com::sun::star::style::CharacterProperties;
  62
  63     [optional] service com::sun::star::style::CharacterPropertiesAsian;
  64
  65     [optional] service com::sun::star::style::CharacterPropertiesComplex;
  66
  67     service com::sun::star::style::ParagraphProperties;
  68
  69     [optional] service com::sun::star::style::ParagraphPropertiesAsian;
  70
  71     [optional] service com::sun::star::style::ParagraphPropertiesComplex;
  72 };
  73
  74
  75 }; }; }; };
  76
  77 #endif
  78
  79 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */