Debian Codegraph @

contrib/perl/lib/Text/Gr2/Slot.pm

raw
1 # SPDX-License-Identifier: Artistic-1.0-Perl
2 # Copyright (C) 2011 Simon Cozens
3 =head1 NAME
4
5 Text::Gr2::Slot - Represents a slot within a segment
6
7 =head1 METHODS
8
9 =head2 advance_X
10
11 Returns the advance (width) of this slot.
12
13 =head2 advance_Y
14
15 Returns the Y advance (height) of this slot.
16
17 =head2 origin_X
18
19 Returns the X co-ordinate of the start of this slot.
20
21 =head2 origin_Y
22
23 Returns the Y co-ordinate of the start of this slot.
24
25 =head2 original
26
27 Returns the CharInfo which represents this slot, to be retrieved with
28 C<< $seg->cinfo($slot->original()) >>.
29
30 =head2 after
31
32 Returns the CharInfo after us, to be retrieved with
33 C<< $seg->cinfo($slot->after()) >>.
34
35 =head2 before
36
37 Returns the CharInfo before us, to be retrieved with
38 C<< $seg->cinfo($slot->before()) >>.
39
40 =head2 next_in_segment
41
42 Returns the next slot in this segment.
43
44 =head2 prev_in_segment
45
46 Returns the previous slot in this segment.
47
48 =head2 attached_to
49
50 Returns the parent slot of this slot, if this slot is attached to
51 another. (If I am the first accent on a main character with two accents,
52 this will return the main character.)
53
54 =head2 next_sibling_attachment
55
56 If we are attached to another slot, return the next slot along which is
57 also attached to the same slot. (If I am the first accent on a main
58 character with two accents, this will return the second accent.)
59
60 =head2 first_attachment
61
62 Returns the first slot attached to this one. (If I am the main character
63 and I have two accents, this will return the first accent.)
64
65 =head2 gid
66
67 Returns the glyph ID of the glyph in this slot.
68
69 =head1 INTERNAL METHODS
70
71 =head2 attr
72
73 Returns a slot attribute value.
74
75 =head2 can_insert_before
76
77 Returns whether text may be inserted before this glyph [check this isn't
78 inverted]
79
80 =cut
81
82 1;