summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/text/TextPortion.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/text/TextPortion.idl')
-rw-r--r--offapi/com/sun/star/text/TextPortion.idl125
1 files changed, 125 insertions, 0 deletions
diff --git a/offapi/com/sun/star/text/TextPortion.idl b/offapi/com/sun/star/text/TextPortion.idl
new file mode 100644
index 000000000000..0337530a1a41
--- /dev/null
+++ b/offapi/com/sun/star/text/TextPortion.idl
@@ -0,0 +1,125 @@
+/*************************************************************************
+ *
+ * $RCSfile: TextPortion.idl,v $
+ *
+ * $Revision: 1.1 $
+ *
+ * last change: $Author: mi $ $Date: 2000-11-06 09:22:20 $
+ *
+ * The Contents of this file are made available subject to the terms of
+ * either of the following licenses
+ *
+ * - GNU Lesser General Public License Version 2.1
+ * - Sun Industry Standards Source License Version 1.1
+ *
+ * Sun Microsystems Inc., October, 2000
+ *
+ * GNU Lesser General Public License Version 2.1
+ * =============================================
+ * Copyright 2000 by Sun Microsystems, Inc.
+ * 901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License version 2.1, as published by the Free Software Foundation.
+ *
+ * This library 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 for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ * MA 02111-1307 USA
+ *
+ *
+ * Sun Industry Standards Source License Version 1.1
+ * =================================================
+ * The contents of this file are subject to the Sun Industry Standards
+ * Source License Version 1.1 (the "License"); You may not use this file
+ * except in compliance with the License. You may obtain a copy of the
+ * License at http://www.openoffice.org/license.html.
+ *
+ * Software provided under this License is provided on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ * See the License for the specific provisions governing your rights and
+ * obligations concerning the Software.
+ *
+ * The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ * Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ * All Rights Reserved.
+ *
+ * Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+#ifndef __com_sun_star_text_XTextPortion_idl__
+#define __com_sun_star_text_XTextPortion_idl__
+
+
+#ifndef __com_sun_star_style_ParagraphProperties_idl__
+#include <com/sun/star/style/ParagraphProperties.idl>
+#endif
+
+#ifndef __com_sun_star_style_CharacterProperties_idl__
+#include <com/sun/star/style/CharacterProperties.idl>
+#endif
+
+#ifndef __com_sun_star_container_XContentEnumerationAccess_idl__
+#include <com/sun/star/container/XContentEnumerationAccess.idl>
+#endif
+
+#ifndef __com_sun_star_text_TextRange_idl__
+#include <com/sun/star/text/TextRange.idl>
+#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.
+ <p>It is created by an enumaration implemented in a paragraph service.
+ It is used to export the content of the paragraph to an external document format.</p>
+
+*/
+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
+ */
+ interface ::com::sun::star::container::XContentEnumerationAccess;
+
+ /** contains the type of the text portion.
+ <p> Valid content type names are:</p>
+ <UL>
+ <LI><P>Text - string content</P>
+ <LI><P>TextField - TextField content</P>
+ <LI><P>TextContent - text content - supplied via the interface XContentEnumerationAccess</P>
+ <LI><P>Footnote - a footnote or an endnote</P>
+ <LI><P>ControlCharacter - a control character</P>
+ <LI><P>ReferenceMark - a reference mark </P>
+ <LI><P>DocumentIndexMark - a document index mark</P>
+ </UL>
+ <p>The text portions for reference marks and document index marks are generated twice for
+ each mark since they may include string content.</p>
+ */
+ [readonly, property] string TextPortionType;
+ /** returns the control character if the text portion contains a ControlCharacter*/
+ [readonly, property] short ControlCharacter;
+};
+
+//=============================================================================
+
+}; }; }; };
+#endif