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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 module com { module sun { module star { module accessibility {
  21
  22 /** This structure describes a text segment that is embedded in a larger
  23     portion of text.  It is used for example by the
  24     XAccessibleText interface to describe a text portion that
  25     was inserted into or deleted from an accessible text.
  26
  27     <p>The indices TextSegment::SegmentStart and
  28     TextSegment::SegmentEnd refer to the enclosing text.
  29     The TextSegment::SegmentText member contains the text
  30     between these two indices including the start index but not the end
  31     index.  With it you can use this structure without having to
  32     access the XAccessibleText interface that represents the
  33     enclosing text.</p>
  34
  35     <p>An empty text segment is expressed by
  36     TextSegment::SegmentStart and
  37     TextSegment::SegmentEnd set to the same value.  While a
  38     value of -1 signals an error (like the request for a word after the last
  39     character of a text) all other values define the empty string at that
  40     position.</p>
  41
  42     <p>The #SegmentText member is a copy of the
  43     corresponding text segment of the enclosing text.  Modifying this
  44     structure does not alter the enclosing text.</p>
  45
  46     @see XAccessibleText
  47
  48     @since OOo 1.1.2
  49 */
  50
  51 struct TextSegment
  52 {
  53     /** A copy of the text segment of the enclosing text delimited by the
  54         text indices TextSegment::SegmentStart and
  55         TextSegment::SegmentEnd.  Modifying it does not
  56         alter the enclosing text.
  57     */
  58     string SegmentText;
  59
  60     /** Index of the first character of the text segment represented by this
  61         structure.  The index refers to the enclosing text.
  62     */
  63     long SegmentStart;
  64
  65     /** Index of the character directly behind the last character of the
  66         text segment represented by this structure.  The index refers to the
  67         enclosing text.
  68     */
  69     long SegmentEnd;
  70 };
  71
  72 }; }; }; };
  73
  74 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */