1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
|
/* Pango
* pango-glyph-item.h: Pair of PangoItem and a glyph string
*
* Copyright (C) 2002 Red Hat Software
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
#ifndef __PANGO_GLYPH_ITEM_H__
#define __PANGO_GLYPH_ITEM_H__
#include <pango/pango-attributes.h>
#include <pango/pango-break.h>
#include <pango/pango-item.h>
#include <pango/pango-glyph.h>
G_BEGIN_DECLS
/**
* PangoGlyphItem:
* @item: corresponding `PangoItem`
* @glyphs: corresponding `PangoGlyphString`
* @y_offset: shift of the baseline, relative to the baseline
* of the containing line. Positive values shift upwards
* @start_x_offset: horizontal displacement to apply before the
* glyph item. Positive values shift right
* @end_x_offset: horizontal displacement to apply after th
* glyph item. Positive values shift right
*
* A `PangoGlyphItem` is a pair of a `PangoItem` and the glyphs
* resulting from shaping the items text.
*
* As an example of the usage of `PangoGlyphItem`, the results
* of shaping text with `PangoLayout` is a list of `PangoLayoutLine`,
* each of which contains a list of `PangoGlyphItem`.
*/
typedef struct _PangoGlyphItem PangoGlyphItem;
struct _PangoGlyphItem
{
PangoItem *item;
PangoGlyphString *glyphs;
int y_offset;
int start_x_offset;
int end_x_offset;
};
#define PANGO_TYPE_GLYPH_ITEM (pango_glyph_item_get_type ())
PANGO_AVAILABLE_IN_ALL
GType pango_glyph_item_get_type (void) G_GNUC_CONST;
PANGO_AVAILABLE_IN_1_2
PangoGlyphItem *pango_glyph_item_split (PangoGlyphItem *orig,
const char *text,
int split_index);
PANGO_AVAILABLE_IN_1_20
PangoGlyphItem *pango_glyph_item_copy (PangoGlyphItem *orig);
PANGO_AVAILABLE_IN_1_6
void pango_glyph_item_free (PangoGlyphItem *glyph_item);
PANGO_AVAILABLE_IN_1_2
GSList * pango_glyph_item_apply_attrs (PangoGlyphItem *glyph_item,
const char *text,
PangoAttrList *list);
PANGO_AVAILABLE_IN_1_6
void pango_glyph_item_letter_space (PangoGlyphItem *glyph_item,
const char *text,
PangoLogAttr *log_attrs,
int letter_spacing);
PANGO_AVAILABLE_IN_1_26
void pango_glyph_item_get_logical_widths (PangoGlyphItem *glyph_item,
const char *text,
int *logical_widths);
/**
* PangoGlyphItemIter:
*
* A `PangoGlyphItemIter` is an iterator over the clusters in a
* `PangoGlyphItem`.
*
* The *forward direction* of the iterator is the logical direction of text.
* That is, with increasing @start_index and @start_char values. If @glyph_item
* is right-to-left (that is, if `glyph_item->item->analysis.level` is odd),
* then @start_glyph decreases as the iterator moves forward. Moreover,
* in right-to-left cases, @start_glyph is greater than @end_glyph.
*
* An iterator should be initialized using either
* pango_glyph_item_iter_init_start() or
* pango_glyph_item_iter_init_end(), for forward and backward iteration
* respectively, and walked over using any desired mixture of
* pango_glyph_item_iter_next_cluster() and
* pango_glyph_item_iter_prev_cluster().
*
* A common idiom for doing a forward iteration over the clusters is:
*
* ```
* PangoGlyphItemIter cluster_iter;
* gboolean have_cluster;
*
* for (have_cluster = pango_glyph_item_iter_init_start (&cluster_iter,
* glyph_item, text);
* have_cluster;
* have_cluster = pango_glyph_item_iter_next_cluster (&cluster_iter))
* {
* ...
* }
* ```
*
* Note that @text is the start of the text for layout, which is then
* indexed by `glyph_item->item->offset` to get to the text of @glyph_item.
* The @start_index and @end_index values can directly index into @text. The
* @start_glyph, @end_glyph, @start_char, and @end_char values however are
* zero-based for the @glyph_item. For each cluster, the item pointed at by
* the start variables is included in the cluster while the one pointed at by
* end variables is not.
*
* None of the members of a `PangoGlyphItemIter` should be modified manually.
*
* Since: 1.22
*/
typedef struct _PangoGlyphItemIter PangoGlyphItemIter;
struct _PangoGlyphItemIter
{
PangoGlyphItem *glyph_item;
const gchar *text;
int start_glyph;
int start_index;
int start_char;
int end_glyph;
int end_index;
int end_char;
};
#define PANGO_TYPE_GLYPH_ITEM_ITER (pango_glyph_item_iter_get_type ())
PANGO_AVAILABLE_IN_1_22
GType pango_glyph_item_iter_get_type (void) G_GNUC_CONST;
PANGO_AVAILABLE_IN_1_22
PangoGlyphItemIter *pango_glyph_item_iter_copy (PangoGlyphItemIter *orig);
PANGO_AVAILABLE_IN_1_22
void pango_glyph_item_iter_free (PangoGlyphItemIter *iter);
PANGO_AVAILABLE_IN_1_22
gboolean pango_glyph_item_iter_init_start (PangoGlyphItemIter *iter,
PangoGlyphItem *glyph_item,
const char *text);
PANGO_AVAILABLE_IN_1_22
gboolean pango_glyph_item_iter_init_end (PangoGlyphItemIter *iter,
PangoGlyphItem *glyph_item,
const char *text);
PANGO_AVAILABLE_IN_1_22
gboolean pango_glyph_item_iter_next_cluster (PangoGlyphItemIter *iter);
PANGO_AVAILABLE_IN_1_22
gboolean pango_glyph_item_iter_prev_cluster (PangoGlyphItemIter *iter);
G_END_DECLS
#endif /* __PANGO_GLYPH_ITEM_H__ */
|
