offapi/com/sun/star/rendering/TextHit.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: TextHit.idl,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_rendering_TextHit_idl__
  31 #define __com_sun_star_rendering_TextHit_idl__
  32
  33 module com { module sun { module star { module rendering {
  34
  35 /** This structure contains hit information for <type>XTextLayout</type>.<p>
  36
  37     This structure is used from the <type>XTextLayout</type> interface
  38     to transport information regarding hit tests.<p>
  39
  40     @since OOo 2.0.0
  41  */
  42 struct TextHit
  43 {
  44     /** This contains the entry index.<p>
  45
  46         The entry index is the index of the insertion point in the
  47         character sequence. The insertion point denotes positions
  48         <em>between</em> the actual characters in the string, and can
  49         thus have values ranging from 0 up to the number of characters
  50         in the string. Hereby, an index of 0 denotes an insertion
  51         position <em>before</em> the first character, and an index
  52         containing the number of characters denotes an insertion
  53         <em>behind</em> the last character.<p>
  54      */
  55     long                EntryIndex;
  56
  57     /** This member denotes whether the hit was on the leading
  58         edge.<p>
  59
  60         Each character is divided in two halves, the leading and the
  61         trailing part. The leading edge is the part of the glyph on
  62         encounteres first when reading text of the corresponding
  63         language (i.e. the leading edge of an Arabic glyph is the
  64         right half of it, whereas it is the left half of a Latin
  65         character). If the hit was on the leading edge, this member is
  66         set to <TRUE/>.
  67      */
  68     boolean             IsLeadingEdge;
  69 };
  70
  71 }; }; }; };
  72
  73 #endif