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