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