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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: Paragraph.idl,v $
  10  * $Revision: 1.16 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_text_Paragraph_idl__
  31 #define __com_sun_star_text_Paragraph_idl__
  32
  33 #ifndef __com_sun_star_style_ParagraphProperties_idl__
  34 #include <com/sun/star/style/ParagraphProperties.idl>
  35 #endif
  36 #ifndef __com_sun_star_style_ParagraphPropertiesAsian_idl__
  37 #include <com/sun/star/style/ParagraphPropertiesAsian.idl>
  38 #endif
  39 #ifndef __com_sun_star_style_ParagraphPropertiesComplex_idl__
  40 #include <com/sun/star/style/ParagraphPropertiesComplex.idl>
  41 #endif
  42
  43 #ifndef __com_sun_star_style_CharacterProperties_idl__
  44 #include <com/sun/star/style/CharacterProperties.idl>
  45 #endif
  46 #ifndef __com_sun_star_style_CharacterPropertiesAsian_idl__
  47 #include <com/sun/star/style/CharacterPropertiesAsian.idl>
  48 #endif
  49 #ifndef __com_sun_star_style_CharacterPropertiesComplex_idl__
  50 #include <com/sun/star/style/CharacterPropertiesComplex.idl>
  51 #endif
  52
  53 #ifndef __com_sun_star_text_TextContent_idl__
  54 #include <com/sun/star/text/TextContent.idl>
  55 #endif
  56
  57 #ifndef __com_sun_star_beans_XPropertySet_idl__
  58 #include <com/sun/star/beans/XPropertySet.idl>
  59 #endif
  60
  61 #ifndef __com_sun_star_beans_XTolerantMultiPropertySet_idl__
  62 #include <com/sun/star/beans/XTolerantMultiPropertySet.idl>
  63 #endif
  64
  65 #ifndef __com_sun_star_beans_XPropertyState_idl__
  66 #include <com/sun/star/beans/XPropertyState.idl>
  67 #endif
  68
  69 #ifndef __com_sun_star_container_XEnumerationAccess_idl__
  70 #include <com/sun/star/container/XEnumerationAccess.idl>
  71 #endif
  72
  73 #ifndef __com_sun_star_text_TextTable_idl__
  74 #include <com/sun/star/text/TextTable.idl>
  75 #endif
  76
  77
  78 //=============================================================================
  79
  80  module com {  module sun {  module star {  module text {
  81
  82 //=============================================================================
  83
  84 // DocMerge from xml: service com::sun::star::text::Paragraph
  85 /** is a piece of text which can take its own paragraph-specific
  86     attributes (technically, properties).
  87  */
  88 published service Paragraph
  89 {
  90     /** This service is present when the paragraph object refers
  91         to a text range */
  92     [optional] service com::sun::star::style::ParagraphProperties;
  93     /** This service is present when the paragraph object refers
  94         to a text range */
  95     [optional] service com::sun::star::style::ParagraphPropertiesAsian;
  96     /** This service is present when the paragraph object refers
  97         to a text range */
  98     [optional] service com::sun::star::style::ParagraphPropertiesComplex;
  99     /** This service is present when the paragraph object refers
 100         to a text range */
 101     [optional] service com::sun::star::style::CharacterProperties;
 102     /** This service is present when the paragraph object refers
 103         to a text range */
 104     [optional] service com::sun::star::style::CharacterPropertiesAsian;
 105     /** This service is present when the paragraph object refers
 106         to a text range */
 107     [optional] service com::sun::star::style::CharacterPropertiesComplex;
 108     /** This service is present when the paragraph object refers
 109         to a text table */
 110     [optional] service com::sun::star::text::TextTable;
 111
 112     // DocMerge: empty anyway
 113     service com::sun::star::text::TextContent;
 114
 115
 116     // DocMerge from xml: service com::sun::star::text::Paragraph: interface com::sun::star::beans::XPropertySet
 117     /** This interface gives access to the properties of the paragraph
 118                 itself (or its style sheet). So this interface may show
 119                 property values which are not valid for any of the
 120                 text portions of the paragraph, if the text itself has its
 121                 own style properties set.
 122      */
 123     interface com::sun::star::beans::XPropertySet;
 124
 125
 126     // DocMerge from xml: service com::sun::star::text::Paragraph: interface com::sun::star::beans::XPropertyState
 127     /** This interface gives access to the state of the property values
 128                 in these properties. So, it is possible to determine if a specific
 129                 properties value is defined in the paragraph or its style sheet.
 130      */
 131     interface com::sun::star::beans::XPropertyState;
 132
 133
 134     // DocMerge from xml: service com::sun::star::text::Paragraph: interface com::sun::star::container::XEnumerationAccess
 135     /** This interface enumerates the text portions of this paragraph.
 136
 137                 <p>A text portion is defined as the largest possible <type>TextRange</type>
 138                 within a paragraph with the same property values and the same bound objects.
 139
 140                 <p>In general this interface is used for exporting into file
 141                 formats.
 142
 143                 @see com::sun::star::text::TextRange@see com::sun::star::text::TextRange
 144      */
 145     interface com::sun::star::container::XEnumerationAccess;
 146
 147     /** gives access to a sequence of properties.
 148         @since OOo 2.0.0
 149      */
 150     [optional] interface ::com::sun::star::beans::XTolerantMultiPropertySet;
 151 };
 152
 153 //=============================================================================
 154
 155 }; }; }; };
 156
 157 #endif