LibreOffice
LibreOffice 6.2 SDK API Reference
Public Attributes | List of all members
TextSegment Struct Reference

This structure describes a text segment that is embedded in a larger portion of text. More...

import"TextSegment.idl";

Public Attributes

string SegmentText
 A copy of the text segment of the enclosing text delimited by the text indices TextSegment::SegmentStart and TextSegment::SegmentEnd. More...
 
long SegmentStart
 Index of the first character of the text segment represented by this structure. More...
 
long SegmentEnd
 Index of the character directly behind the last character of the text segment represented by this structure. More...
 

Detailed 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 TextSegment::SegmentStart and TextSegment::SegmentEnd refer to the enclosing text. The TextSegment::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 TextSegment::SegmentStart and TextSegment::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.

See also
XAccessibleText
Since
OOo 1.1.2

Member Data Documentation

long 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.

long SegmentStart

Index of the first character of the text segment represented by this structure.

The index refers to the enclosing text.

string 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.


The documentation for this struct was generated from the following file: