/************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * Copyright 2008 by Sun Microsystems, Inc. * * OpenOffice.org - a multi-platform office productivity suite * * $RCSfile: TextPortion.idl,v $ * $Revision: 1.11 $ * * This file is part of OpenOffice.org. * * OpenOffice.org is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License version 3 * only, as published by the Free Software Foundation. * * OpenOffice.org is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Lesser General Public License version 3 for more details * (a copy is included in the LICENSE file that accompanied this code). * * You should have received a copy of the GNU Lesser General Public License * version 3 along with OpenOffice.org. If not, see * * for a copy of the LGPLv3 License. * ************************************************************************/ #ifndef __com_sun_star_text_TextPortion_idl__ #define __com_sun_star_text_TextPortion_idl__ #ifndef __com_sun_star_beans_XTolerantMultiPropertySet_idl__ #include #endif #ifndef __com_sun_star_container_XContentEnumerationAccess_idl__ #include #endif #ifndef __com_sun_star_text_TextRange_idl__ #include #endif #ifndef __com_sun_star_text_XTextContent_idl__ #include #endif #ifndef __com_sun_star_text_XTextField_idl__ #include #endif #ifndef __com_sun_star_text_XFootnote_idl__ #include #endif //============================================================================= module com { module sun { module star { module text { //============================================================================= /** A TextPortion is a piece of text within a paragraph that does not contain changes of its attributes inside.

It is created by an enumeration implemented in a paragraph service. It may be used to export the content of the paragraph to an external document format.

@see com::sun::star::text::TextPortionEnumeration @see com::sun::star::text::XTextPortionEnumeration */ published service TextPortion { service ::com::sun::star::text::TextRange; //------------------------------------------------------------------------- /** contains text frames, graphic objects, embedded objects or shapes that are anchored at or as character. @see com.sun.star.text.TextFrame @see com.sun.star.text.TextGraphicObject */ [optional] interface ::com::sun::star::container::XContentEnumerationAccess; //------------------------------------------------------------------------- /** gives access to a sequence of properties. @since OOo 2.0.0 */ [optional] interface ::com::sun::star::beans::XTolerantMultiPropertySet; //------------------------------------------------------------------------- /** contains the type of the text portion.

Valid content type names are:

Text
string content
TextField
a text field
TextContent
text content - supplied via the interface XContentEnumerationAccess
ControlCharacter
a control character
Footnote
a footnote or an endnote
ReferenceMark
a reference mark
DocumentIndexMark
a document index mark
Bookmark
a bookmark
Redline
a redline portion which is a result of the change tracking feature
Ruby
a ruby attribute which is used in Asian text
Frame
a frame
SoftPageBreak
a soft page break
InContentMetadata
a text range with attached metadata

For Reference marks, document index marks, etc., 2 text portions will be generated, one for the start position and one for the end position.

*/ [readonly, property] string TextPortionType; //------------------------------------------------------------------------- /** contains the control character of a text portion of type ControlCharacter. @deprecated type ControlCharacter no longer implemented */ [readonly, property] short ControlCharacter; //------------------------------------------------------------------------- /** contains the bookmark of a text portion of type Bookmark. */ [optional, readonly, property] ::com::sun::star::text::XTextContent Bookmark; //------------------------------------------------------------------------- /** contains the document index mark of a text portion of type DocumentIndexMark. */ [optional, readonly, property] ::com::sun::star::text::XTextContent DocumentIndexMark; //------------------------------------------------------------------------- /** contains the bookmark of a text portion of type ReferenceMark. */ [optional, readonly, property] ::com::sun::star::text::XTextContent ReferenceMark; //------------------------------------------------------------------------- /** contains the footnote of a text portion of type Footnote. */ [optional, readonly, property] ::com::sun::star::text::XFootnote Footnote; //------------------------------------------------------------------------- /** contains the text field of a text portion of type TextField. */ [optional, readonly, property] ::com::sun::star::text::XTextField TextField; //------------------------------------------------------------------------- /** contains the text range of a text portion of type InContentMetadata. @since OOo 3.2 */ [optional, readonly, property] ::com::sun::star::text::XTextContent InContentMetadata; //------------------------------------------------------------------------- /** contains whether the portion is a point only. */ [optional, readonly, property] boolean IsCollapsed; //------------------------------------------------------------------------- /** contains whether the portion is the start of the portion.

This is used for portions which are represented by 2 TextPortion objects (e.g., DocmentIndexMark).

*/ [optional, readonly, property] boolean IsStart; }; //============================================================================= }; }; }; }; #endif