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 24*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_accessibility_TextSegment_idl__ 25*b1cdbd2cSJim Jagielski#define __com_sun_star_accessibility_TextSegment_idl__ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module accessibility { 28*b1cdbd2cSJim Jagielski 29*b1cdbd2cSJim Jagielski/** This structure describes a text segment that is embedded in a larger 30*b1cdbd2cSJim Jagielski portion of text. It is used for example by the 31*b1cdbd2cSJim Jagielski <type>XAccessibleText</type> interface to describe a text portion that 32*b1cdbd2cSJim Jagielski was inserted into or deleted from an accessible text. 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski <p>The indices <member>TextSegment::SegmentStart</member> and 35*b1cdbd2cSJim Jagielski <member>TextSegment::SegmentEnd</member> refer to the enclosing text. 36*b1cdbd2cSJim Jagielski The <member>TextSegment::SegmentText</member> member contains the text 37*b1cdbd2cSJim Jagielski between these two indices including the start index but not the end 38*b1cdbd2cSJim Jagielski index. With it you can use this structure without having to 39*b1cdbd2cSJim Jagielski access the <type>XAccessibleText</type> interface that represents the 40*b1cdbd2cSJim Jagielski enclosing text.</p> 41*b1cdbd2cSJim Jagielski 42*b1cdbd2cSJim Jagielski <p>An empty text segment is expressed by 43*b1cdbd2cSJim Jagielski <member>TextSegment::SegmentStart</member> and 44*b1cdbd2cSJim Jagielski <member>TextSegment::SegmentEnd</member> set to the same value. While a 45*b1cdbd2cSJim Jagielski value of -1 signals an error (like the request for a word after the last 46*b1cdbd2cSJim Jagielski character of a text) all other values define the empty string at that 47*b1cdbd2cSJim Jagielski position.</p> 48*b1cdbd2cSJim Jagielski 49*b1cdbd2cSJim Jagielski <p>The <member>SegmentText</member> member is a copy of the 50*b1cdbd2cSJim Jagielski corresponding text segment of the enclosing text. Modifying this 51*b1cdbd2cSJim Jagielski structure does not alter the enclosing text.</p> 52*b1cdbd2cSJim Jagielski 53*b1cdbd2cSJim Jagielski @see XAccessibleText 54*b1cdbd2cSJim Jagielski 55*b1cdbd2cSJim Jagielski @since OpenOffice 1.1.2 56*b1cdbd2cSJim Jagielski*/ 57*b1cdbd2cSJim Jagielski 58*b1cdbd2cSJim Jagielskipublished struct TextSegment 59*b1cdbd2cSJim Jagielski{ 60*b1cdbd2cSJim Jagielski /** A copy of the text segment of the enclosing text delimited by the 61*b1cdbd2cSJim Jagielski text indices <member>TextSegment::SegmentStart</member> and 62*b1cdbd2cSJim Jagielski <member>TextSegment::SegmentEnd</member>. Modifying it does not 63*b1cdbd2cSJim Jagielski alter the enclosing text. 64*b1cdbd2cSJim Jagielski */ 65*b1cdbd2cSJim Jagielski string SegmentText; 66*b1cdbd2cSJim Jagielski 67*b1cdbd2cSJim Jagielski /** Index of the first character of the text segment represented by this 68*b1cdbd2cSJim Jagielski structure. The index refers to the enclosing text. 69*b1cdbd2cSJim Jagielski */ 70*b1cdbd2cSJim Jagielski long SegmentStart; 71*b1cdbd2cSJim Jagielski 72*b1cdbd2cSJim Jagielski /** Index of the character directly behind the last character of the 73*b1cdbd2cSJim Jagielski text segment represented by this structure. The index refers to the 74*b1cdbd2cSJim Jagielski enclosing text. 75*b1cdbd2cSJim Jagielski */ 76*b1cdbd2cSJim Jagielski long SegmentEnd; 77*b1cdbd2cSJim Jagielski}; 78*b1cdbd2cSJim Jagielski 79*b1cdbd2cSJim Jagielski}; }; }; }; 80*b1cdbd2cSJim Jagielski 81*b1cdbd2cSJim Jagielski#endif 82