INTEGRATION: CWS uaa03 (1.1.2); FILE ADDED

2003/05/21 15:18:18 mt 1.1.2.1: i14510 getText methods return TextSegment

offapi/com/sun/star/accessibility/TextSegment.idl

+/*************************************************************************
+ *
+ *  $RCSfile: TextSegment.idl,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: vg $ $Date: 2003-05-22 13:05:18 $
+ *
+ *  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_accessibility_TextSegment_idl__
+#define __com_sun_star_accessibility_TextSegment_idl__
+
+module com { module sun { module star { module accessibility {
+
+/** This structure describes a text segment that is embedded in a larger
+    portion of text.  It is used for example by the
+    <type>XAccessibleText</type> interface to describe a text portion that
+    was inserted into or deleted from an accessible text.
+
+    <p>The indices <member>TextSegment::SegmentStart</member> and
+    <member>TextSegment::SegmentEnd</member> refer to the enclosing text.
+    The <member>TextSegment::SegmentText</member> member contains the text
+    between these two indices including the start index but not the end
+    index.  With it you can use this structure without having to
+    access the <type>XAccessibleText</type> interface that represents the
+    enclosing text.</p>
+
+    <p>An empty text segment is expressed by
+    <member>TextSegment::SegmentStart</member> and
+    <member>TextSegment::SegmentEnd</member> set to the same value.  While a
+    value of -1 signals an error (like the request for a word after the last
+    character of a text) all other values define the empty string at that
+    position.</p>
+
+    <p>The <member>SegmentText</member> member is a copy of the
+    corresponding text segment of the enclosing text.  Modifying this
+    structure does not alter the enclosing text.</p>
+
+    @see XAccessibleText
+*/
+
+struct TextSegment
+{
+    /** A copy of the text segment of the enclosing text delimited by the
+        text indices <member>TextSegment::SegmentStart</member> and
+        <member>TextSegment::SegmentEnd</member>.  Modifying it does not
+        alter the enclosing text.
+    */
+    string SegmentText;
+
+    /** Index of the first character of the text segment represented by this
+        structure.  The index refers to the enclosing text.
+    */
+    long SegmentStart;
+
+    /** Index of the character directly behind the last character of the
+        text segment represented by this structure.  The index refers to the
+        enclosing text.
+    */
+    long SegmentEnd;
+};
+
+}; }; }; };
+
+#endif