1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_rendering_TextHit_idl__
24#define __com_sun_star_rendering_TextHit_idl__
25
26module com { module sun { module star { module rendering {
27
28/** This structure contains hit information for <type>XTextLayout</type>.<p>
29
30    This structure is used from the <type>XTextLayout</type> interface
31    to transport information regarding hit tests.<p>
32
33    @since OpenOffice 2.0
34 */
35published struct TextHit
36{
37    /** This contains the entry index.<p>
38
39        The entry index is the index of the insertion point in the
40        character sequence. The insertion point denotes positions
41        <em>between</em> the actual characters in the string, and can
42        thus have values ranging from 0 up to the number of characters
43        in the string. Hereby, an index of 0 denotes an insertion
44        position <em>before</em> the first character, and an index
45        containing the number of characters denotes an insertion
46        <em>behind</em> the last character.<p>
47     */
48    long        EntryIndex;
49
50    /** This member denotes whether the hit was on the leading
51        edge.<p>
52
53        Each character is divided in two halves, the leading and the
54        trailing part. The leading edge is the part of the glyph on
55        encounteres first when reading text of the corresponding
56        language (i.e. the leading edge of an Arabic glyph is the
57        right half of it, whereas it is the left half of a Latin
58        character). If the hit was on the leading edge, this member is
59        set to <TRUE/>.
60     */
61    boolean		IsLeadingEdge;
62};
63
64}; }; }; };
65
66#endif
67