offapi/com/sun/star/text/Paragraph.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_Paragraph_idl__
  20 #define __com_sun_star_text_Paragraph_idl__
  21
  22 #include <com/sun/star/style/ParagraphProperties.idl>
  23 #include <com/sun/star/style/ParagraphPropertiesAsian.idl>
  24 #include <com/sun/star/style/ParagraphPropertiesComplex.idl>
  25 #include <com/sun/star/style/CharacterProperties.idl>
  26 #include <com/sun/star/style/CharacterPropertiesAsian.idl>
  27 #include <com/sun/star/style/CharacterPropertiesComplex.idl>
  28 #include <com/sun/star/text/TextContent.idl>
  29 #include <com/sun/star/beans/XPropertySet.idl>
  30 #include <com/sun/star/beans/XTolerantMultiPropertySet.idl>
  31 #include <com/sun/star/beans/XPropertyState.idl>
  32 #include <com/sun/star/container/XEnumerationAccess.idl>
  33 #include <com/sun/star/text/TextTable.idl>
  34
  35
  36
  37  module com {  module sun {  module star {  module text {
  38
  39 /** is a piece of text which can take its own paragraph-specific
  40     attributes (technically, properties).
  41  */
  42 published service Paragraph
  43 {
  44     /** This service is present when the paragraph object refers
  45         to a text range */
  46     [optional] service com::sun::star::style::ParagraphProperties;
  47     /** This service is present when the paragraph object refers
  48         to a text range */
  49     [optional] service com::sun::star::style::ParagraphPropertiesAsian;
  50     /** This service is present when the paragraph object refers
  51         to a text range */
  52     [optional] service com::sun::star::style::ParagraphPropertiesComplex;
  53     /** This service is present when the paragraph object refers
  54         to a text range */
  55     [optional] service com::sun::star::style::CharacterProperties;
  56     /** This service is present when the paragraph object refers
  57         to a text range */
  58     [optional] service com::sun::star::style::CharacterPropertiesAsian;
  59     /** This service is present when the paragraph object refers
  60         to a text range */
  61     [optional] service com::sun::star::style::CharacterPropertiesComplex;
  62     /** This service is present when the paragraph object refers
  63         to a text table */
  64     [optional] service com::sun::star::text::TextTable;
  65     service com::sun::star::text::TextContent;
  66
  67     /** This interface gives access to the properties of the paragraph
  68                 itself (or its style sheet). So this interface may show
  69                 property values which are not valid for any of the
  70                 text portions of the paragraph, if the text itself has its
  71                 own style properties set.
  72      */
  73     interface com::sun::star::beans::XPropertySet;
  74
  75     /** This interface gives access to the state of the property values
  76                 in these properties. So, it is possible to determine if a specific
  77                 properties value is defined in the paragraph or its style sheet.
  78      */
  79     interface com::sun::star::beans::XPropertyState;
  80
  81     /** This interface enumerates the text portions of this paragraph.
  82
  83                 <p>A text portion is defined as the largest possible TextRange
  84                 within a paragraph with the same property values and the same bound objects.
  85
  86                 <p>In general this interface is used for exporting into file
  87                 formats.
  88
  89                 @see com::sun::star::text::TextRange@see com::sun::star::text::TextRange
  90      */
  91     interface com::sun::star::container::XEnumerationAccess;
  92
  93     /** gives access to a sequence of properties.
  94         @since OOo 2.0
  95      */
  96     [optional] interface ::com::sun::star::beans::XTolerantMultiPropertySet;
  97 };
  98
  99
 100 }; }; }; };
 101
 102 #endif
 103
 104 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */