offapi/com/sun/star/text/TextPortion.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: TextPortion.idl,v $
  10  * $Revision: 1.11 $
  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_TextPortion_idl__
  31 #define __com_sun_star_text_TextPortion_idl__
  32
  33
  34 #ifndef __com_sun_star_beans_XTolerantMultiPropertySet_idl__
  35 #include <com/sun/star/beans/XTolerantMultiPropertySet.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_container_XContentEnumerationAccess_idl__
  39 #include <com/sun/star/container/XContentEnumerationAccess.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_text_TextRange_idl__
  43 #include <com/sun/star/text/TextRange.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_text_XTextContent_idl__
  47 #include <com/sun/star/text/XTextContent.idl>
  48 #endif
  49
  50 #ifndef __com_sun_star_text_XTextField_idl__
  51 #include <com/sun/star/text/XTextField.idl>
  52 #endif
  53
  54 #ifndef __com_sun_star_text_XFootnote_idl__
  55 #include <com/sun/star/text/XFootnote.idl>
  56 #endif
  57
  58
  59 //=============================================================================
  60
  61 module com { module sun { module star { module text {
  62
  63 //=============================================================================
  64 /** A TextPortion is a piece of text within a paragraph that does not
  65     contain changes of its attributes inside.
  66
  67     <p>
  68     It is created by an enumeration implemented in a paragraph service.
  69     It may be used to export the content of the paragraph to an external
  70     document format.
  71     </p>
  72
  73     @see com::sun::star::text::TextPortionEnumeration
  74     @see com::sun::star::text::XTextPortionEnumeration
  75 */
  76 published service TextPortion
  77 {
  78     service ::com::sun::star::text::TextRange;
  79
  80     //-------------------------------------------------------------------------
  81     /** contains text frames, graphic objects, embedded objects or
  82         shapes that are anchored at or as character.
  83         @see com.sun.star.text.TextFrame
  84         @see com.sun.star.text.TextGraphicObject
  85      */
  86     [optional]
  87     interface ::com::sun::star::container::XContentEnumerationAccess;
  88
  89     //-------------------------------------------------------------------------
  90     /** gives access to a sequence of properties.
  91         @since OOo 2.0.0
  92      */
  93     [optional]
  94     interface ::com::sun::star::beans::XTolerantMultiPropertySet;
  95
  96     //-------------------------------------------------------------------------
  97     /** contains the type of the text portion.
  98
  99     <p> Valid content type names are:</p>
 100     <dl>
 101         <dt>Text</dt><dd>string content</dd>
 102         <dt>TextField</dt><dd>a text field</dd>
 103         <dt>TextContent</dt><dd>text content - supplied via the
 104             interface <type scope="com::sun::star::container">
 105             XContentEnumerationAccess</type></dd>
 106         <dt>ControlCharacter</dt><dd>a control character</dd>
 107         <dt>Footnote</dt><dd>a footnote or an endnote</dd>
 108         <dt>ReferenceMark</dt><dd>a reference mark</dd>
 109         <dt>DocumentIndexMark</dt><dd>a document index mark</dd>
 110         <dt>Bookmark</dt><dd>a bookmark</dd>
 111         <dt>Redline</dt><dd>a redline portion which is a result
 112             of the change tracking feature</dd>
 113         <dt>Ruby</dt><dd>a ruby attribute which is used in Asian text</dd>
 114         <dt>Frame</dt><dd>a frame</dd>
 115         <dt>SoftPageBreak</dt><dd>a soft page break</dd>
 116     </dl>
 117     <p>For Reference marks, document index marks, etc., 2 text portions
 118        will be generated, one for the start position and one for the
 119        end position.</p>
 120      */
 121     [readonly, property] string TextPortionType;
 122
 123     //-------------------------------------------------------------------------
 124     /** contains the control character of a text portion of type
 125         ControlCharacter.
 126      */
 127     [readonly, property] short ControlCharacter;
 128
 129     //-------------------------------------------------------------------------
 130     /** contains the bookmark of a text portion of type Bookmark. */
 131     [optional, readonly, property]
 132     ::com::sun::star::text::XTextContent Bookmark;
 133
 134     //-------------------------------------------------------------------------
 135     /** contains the document index mark of a text portion of type
 136         DocumentIndexMark. */
 137     [optional, readonly, property]
 138     ::com::sun::star::text::XTextContent DocumentIndexMark;
 139
 140     //-------------------------------------------------------------------------
 141     /** contains the bookmark of a text portion of type ReferenceMark. */
 142     [optional, readonly, property]
 143     ::com::sun::star::text::XTextContent ReferenceMark;
 144
 145     //-------------------------------------------------------------------------
 146     /** contains the footnote of a text portion of type Footnote. */
 147     [optional, readonly, property]
 148     ::com::sun::star::text::XFootnote Footnote;
 149
 150     //-------------------------------------------------------------------------
 151     /** contains the text field of a text portion of type TextField. */
 152     [optional, readonly, property]
 153     ::com::sun::star::text::XTextField TextField;
 154
 155     //-------------------------------------------------------------------------
 156     /** contains whether the portion is a point only. */
 157     [optional, readonly, property] boolean IsCollapsed;
 158
 159     //-------------------------------------------------------------------------
 160     /** contains whether the portion is the start of the portion.
 161
 162         <p>This is used for portions which are represented by
 163         2 TextPortion objects (e.g., DocmentIndexMark).</p>
 164      */
 165     [optional, readonly, property] boolean IsStart;
 166
 167 };
 168
 169 //=============================================================================
 170
 171 }; }; }; };
 172 #endif