1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_text_TextPortion_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_text_TextPortion_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_beans_XTolerantMultiPropertySet_idl__ 28*b1cdbd2cSJim Jagielski#include <com/sun/star/beans/XTolerantMultiPropertySet.idl> 29*b1cdbd2cSJim Jagielski#endif 30*b1cdbd2cSJim Jagielski 31*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_container_XContentEnumerationAccess_idl__ 32*b1cdbd2cSJim Jagielski#include <com/sun/star/container/XContentEnumerationAccess.idl> 33*b1cdbd2cSJim Jagielski#endif 34*b1cdbd2cSJim Jagielski 35*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_text_TextRange_idl__ 36*b1cdbd2cSJim Jagielski#include <com/sun/star/text/TextRange.idl> 37*b1cdbd2cSJim Jagielski#endif 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_text_XTextContent_idl__ 40*b1cdbd2cSJim Jagielski#include <com/sun/star/text/XTextContent.idl> 41*b1cdbd2cSJim Jagielski#endif 42*b1cdbd2cSJim Jagielski 43*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_text_XTextField_idl__ 44*b1cdbd2cSJim Jagielski#include <com/sun/star/text/XTextField.idl> 45*b1cdbd2cSJim Jagielski#endif 46*b1cdbd2cSJim Jagielski 47*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_text_XFootnote_idl__ 48*b1cdbd2cSJim Jagielski#include <com/sun/star/text/XFootnote.idl> 49*b1cdbd2cSJim Jagielski#endif 50*b1cdbd2cSJim Jagielski 51*b1cdbd2cSJim Jagielski 52*b1cdbd2cSJim Jagielski//============================================================================= 53*b1cdbd2cSJim Jagielski 54*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module text { 55*b1cdbd2cSJim Jagielski 56*b1cdbd2cSJim Jagielski//============================================================================= 57*b1cdbd2cSJim Jagielski/** A TextPortion is a piece of text within a paragraph that does not 58*b1cdbd2cSJim Jagielski contain changes of its attributes inside. 59*b1cdbd2cSJim Jagielski 60*b1cdbd2cSJim Jagielski <p> 61*b1cdbd2cSJim Jagielski It is created by an enumeration implemented in a paragraph service. 62*b1cdbd2cSJim Jagielski It may be used to export the content of the paragraph to an external 63*b1cdbd2cSJim Jagielski document format. 64*b1cdbd2cSJim Jagielski </p> 65*b1cdbd2cSJim Jagielski 66*b1cdbd2cSJim Jagielski @see com::sun::star::text::TextPortionEnumeration 67*b1cdbd2cSJim Jagielski @see com::sun::star::text::XTextPortionEnumeration 68*b1cdbd2cSJim Jagielski*/ 69*b1cdbd2cSJim Jagielskipublished service TextPortion 70*b1cdbd2cSJim Jagielski{ 71*b1cdbd2cSJim Jagielski service ::com::sun::star::text::TextRange; 72*b1cdbd2cSJim Jagielski 73*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 74*b1cdbd2cSJim Jagielski /** contains text frames, graphic objects, embedded objects or 75*b1cdbd2cSJim Jagielski shapes that are anchored at or as character. 76*b1cdbd2cSJim Jagielski @see com.sun.star.text.TextFrame 77*b1cdbd2cSJim Jagielski @see com.sun.star.text.TextGraphicObject 78*b1cdbd2cSJim Jagielski */ 79*b1cdbd2cSJim Jagielski [optional] 80*b1cdbd2cSJim Jagielski interface ::com::sun::star::container::XContentEnumerationAccess; 81*b1cdbd2cSJim Jagielski 82*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 83*b1cdbd2cSJim Jagielski /** gives access to a sequence of properties. 84*b1cdbd2cSJim Jagielski @since OpenOffice 2.0 85*b1cdbd2cSJim Jagielski */ 86*b1cdbd2cSJim Jagielski [optional] 87*b1cdbd2cSJim Jagielski interface ::com::sun::star::beans::XTolerantMultiPropertySet; 88*b1cdbd2cSJim Jagielski 89*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 90*b1cdbd2cSJim Jagielski /** contains the type of the text portion. 91*b1cdbd2cSJim Jagielski 92*b1cdbd2cSJim Jagielski <p> Valid content type names are:</p> 93*b1cdbd2cSJim Jagielski <dl> 94*b1cdbd2cSJim Jagielski <dt>Text</dt><dd>string content</dd> 95*b1cdbd2cSJim Jagielski <dt>TextField</dt><dd>a text field</dd> 96*b1cdbd2cSJim Jagielski <dt>TextContent</dt><dd>text content - supplied via the 97*b1cdbd2cSJim Jagielski interface <type scope="com::sun::star::container"> 98*b1cdbd2cSJim Jagielski XContentEnumerationAccess</type></dd> 99*b1cdbd2cSJim Jagielski <dt>ControlCharacter</dt><dd>a control character</dd> 100*b1cdbd2cSJim Jagielski <dt>Footnote</dt><dd>a footnote or an endnote</dd> 101*b1cdbd2cSJim Jagielski <dt>ReferenceMark</dt><dd>a reference mark</dd> 102*b1cdbd2cSJim Jagielski <dt>DocumentIndexMark</dt><dd>a document index mark</dd> 103*b1cdbd2cSJim Jagielski <dt>Bookmark</dt><dd>a bookmark</dd> 104*b1cdbd2cSJim Jagielski <dt>Redline</dt><dd>a redline portion which is a result 105*b1cdbd2cSJim Jagielski of the change tracking feature</dd> 106*b1cdbd2cSJim Jagielski <dt>Ruby</dt><dd>a ruby attribute which is used in Asian text</dd> 107*b1cdbd2cSJim Jagielski <dt>Frame</dt><dd>a frame</dd> 108*b1cdbd2cSJim Jagielski <dt>SoftPageBreak</dt><dd>a soft page break</dd> 109*b1cdbd2cSJim Jagielski <dt>InContentMetadata</dt><dd>a text range with attached metadata</dd> 110*b1cdbd2cSJim Jagielski </dl> 111*b1cdbd2cSJim Jagielski <p>For Reference marks, document index marks, etc., 2 text portions 112*b1cdbd2cSJim Jagielski will be generated, one for the start position and one for the 113*b1cdbd2cSJim Jagielski end position.</p> 114*b1cdbd2cSJim Jagielski */ 115*b1cdbd2cSJim Jagielski [readonly, property] string TextPortionType; 116*b1cdbd2cSJim Jagielski 117*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 118*b1cdbd2cSJim Jagielski /** contains the control character of a text portion of type 119*b1cdbd2cSJim Jagielski ControlCharacter. 120*b1cdbd2cSJim Jagielski @deprecated type ControlCharacter no longer implemented 121*b1cdbd2cSJim Jagielski */ 122*b1cdbd2cSJim Jagielski [readonly, property] short ControlCharacter; 123*b1cdbd2cSJim Jagielski 124*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 125*b1cdbd2cSJim Jagielski /** contains the bookmark of a text portion of type Bookmark. */ 126*b1cdbd2cSJim Jagielski [optional, readonly, property] 127*b1cdbd2cSJim Jagielski ::com::sun::star::text::XTextContent Bookmark; 128*b1cdbd2cSJim Jagielski 129*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 130*b1cdbd2cSJim Jagielski /** contains the document index mark of a text portion of type 131*b1cdbd2cSJim Jagielski DocumentIndexMark. */ 132*b1cdbd2cSJim Jagielski [optional, readonly, property] 133*b1cdbd2cSJim Jagielski ::com::sun::star::text::XTextContent DocumentIndexMark; 134*b1cdbd2cSJim Jagielski 135*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 136*b1cdbd2cSJim Jagielski /** contains the bookmark of a text portion of type ReferenceMark. */ 137*b1cdbd2cSJim Jagielski [optional, readonly, property] 138*b1cdbd2cSJim Jagielski ::com::sun::star::text::XTextContent ReferenceMark; 139*b1cdbd2cSJim Jagielski 140*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 141*b1cdbd2cSJim Jagielski /** contains the footnote of a text portion of type Footnote. */ 142*b1cdbd2cSJim Jagielski [optional, readonly, property] 143*b1cdbd2cSJim Jagielski ::com::sun::star::text::XFootnote Footnote; 144*b1cdbd2cSJim Jagielski 145*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 146*b1cdbd2cSJim Jagielski /** contains the text field of a text portion of type TextField. */ 147*b1cdbd2cSJim Jagielski [optional, readonly, property] 148*b1cdbd2cSJim Jagielski ::com::sun::star::text::XTextField TextField; 149*b1cdbd2cSJim Jagielski 150*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 151*b1cdbd2cSJim Jagielski /** contains the text range of a text portion of type InContentMetadata. 152*b1cdbd2cSJim Jagielski @since OpenOffice 3.2 153*b1cdbd2cSJim Jagielski */ 154*b1cdbd2cSJim Jagielski [optional, readonly, property] 155*b1cdbd2cSJim Jagielski ::com::sun::star::text::XTextContent InContentMetadata; 156*b1cdbd2cSJim Jagielski 157*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 158*b1cdbd2cSJim Jagielski /** contains whether the portion is a point only. */ 159*b1cdbd2cSJim Jagielski [optional, readonly, property] boolean IsCollapsed; 160*b1cdbd2cSJim Jagielski 161*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 162*b1cdbd2cSJim Jagielski /** contains whether the portion is the start of the portion. 163*b1cdbd2cSJim Jagielski 164*b1cdbd2cSJim Jagielski <p>This is used for portions which are represented by 165*b1cdbd2cSJim Jagielski 2 TextPortion objects (e.g., DocmentIndexMark).</p> 166*b1cdbd2cSJim Jagielski */ 167*b1cdbd2cSJim Jagielski [optional, readonly, property] boolean IsStart; 168*b1cdbd2cSJim Jagielski 169*b1cdbd2cSJim Jagielski}; 170*b1cdbd2cSJim Jagielski 171*b1cdbd2cSJim Jagielski//============================================================================= 172*b1cdbd2cSJim Jagielski 173*b1cdbd2cSJim Jagielski}; }; }; }; 174*b1cdbd2cSJim Jagielski#endif 175