Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: accessibility ::

struct TextSegment
Description
This structure describes a text segment that is embedded in a larger portion of text. It is used for example by the XAccessibleText interface to describe a text portion that was inserted into or deleted from an accessible text.

The indices SegmentStart and SegmentEnd refer to the enclosing text. The SegmentText 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 XAccessibleText interface that represents the enclosing text.

An empty text segment is expressed by SegmentStart and SegmentEnd 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.

The SegmentText member is a copy of the corresponding text segment of the enclosing text. Modifying this structure does not alter the enclosing text.

Since
OOo 1.1.2
See also
XAccessibleText

Elements' Summary
SegmentText A copy of the text segment of the enclosing text delimited by the text indices TextSegment::SegmentStart and TextSegment::SegmentEnd. Modifying it does not alter the enclosing text.  
SegmentStart Index of the first character of the text segment represented by this structure. The index refers to the enclosing text.  
SegmentEnd Index of the character directly behind the last character of the text segment represented by this structure. The index refers to the enclosing text.  
Elements' Details
SegmentText
string SegmentText;
Description
A copy of the text segment of the enclosing text delimited by the text indices TextSegment::SegmentStart and TextSegment::SegmentEnd. Modifying it does not alter the enclosing text.
SegmentStart
long SegmentStart;
Description
Index of the first character of the text segment represented by this structure. The index refers to the enclosing text.
SegmentEnd
long SegmentEnd;
Description
Index of the character directly behind the last character of the text segment represented by this structure. The index refers to the enclosing text.
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.