offapi/com/sun/star/rendering/TextHit.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 #ifndef __com_sun_star_rendering_TextHit_idl__
  20 #define __com_sun_star_rendering_TextHit_idl__
  21
  22 module com { module sun { module star { module rendering {
  23
  24 /** This structure contains hit information for XTextLayout.<p>
  25
  26     This structure is used from the XTextLayout interface
  27     to transport information regarding hit tests.<p>
  28
  29     @since OOo 2.0
  30  */
  31 struct TextHit
  32 {
  33     /** This contains the entry index.<p>
  34
  35         The entry index is the index of the insertion point in the
  36         character sequence. The insertion point denotes positions
  37         <em>between</em> the actual characters in the string, and can
  38         thus have values ranging from 0 up to the number of characters
  39         in the string. Hereby, an index of 0 denotes an insertion
  40         position <em>before</em> the first character, and an index
  41         containing the number of characters denotes an insertion
  42         <em>behind</em> the last character.<p>
  43      */
  44     long        EntryIndex;
  45
  46     /** This member denotes whether the hit was on the leading
  47         edge.<p>
  48
  49         Each character is divided in two halves, the leading and the
  50         trailing part. The leading edge is the part of the glyph
  51         encountered first when reading text of the corresponding
  52         language (i.e. the leading edge of an Arabic glyph is the
  53         right half of it, whereas it is the left half of a Latin
  54         character). If the hit was on the leading edge, this member is
  55         set to `TRUE`.
  56      */
  57     boolean     IsLeadingEdge;
  58 };
  59
  60 }; }; }; };
  61
  62 #endif
  63
  64 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */