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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
|
<refentry id="gail-libgail-util-GailMisc">
<refmeta>
<refentrytitle>GailMisc</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GAIL-LIBGAIL-UTIL Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GailMisc</refname><refpurpose>GailMisc is a set of utility functions which may be useful to implementors of
Atk interfaces for custom widgets.</refpurpose>
</refnamediv>
<refsynopsisdiv><title>Synopsis</title>
<synopsis>
<link linkend="AtkAttributeSet">AtkAttributeSet</link>* <link linkend="gail-misc-add-attribute">gail_misc_add_attribute</link> (<link linkend="AtkAttributeSet">AtkAttributeSet</link> *attrib_set,
<link linkend="AtkTextAttribute">AtkTextAttribute</link> attr,
<link linkend="gchar">gchar</link> *value);
<link linkend="AtkAttributeSet">AtkAttributeSet</link>* <link linkend="gail-misc-layout-get-run-attributes">gail_misc_layout_get_run_attributes</link>
(<link linkend="AtkAttributeSet">AtkAttributeSet</link> *attrib_set,
<link linkend="PangoLayout">PangoLayout</link> *layout,
<link linkend="gchar">gchar</link> *text,
<link linkend="gint">gint</link> offset,
<link linkend="gint">gint</link> *start_offset,
<link linkend="gint">gint</link> *end_offset);
<link linkend="AtkAttributeSet">AtkAttributeSet</link>* <link linkend="gail-misc-get-default-attributes">gail_misc_get_default_attributes</link>
(<link linkend="AtkAttributeSet">AtkAttributeSet</link> *attrib_set,
<link linkend="PangoLayout">PangoLayout</link> *layout,
<link linkend="GtkWidget">GtkWidget</link> *widget);
void <link linkend="gail-misc-get-extents-from-pango-rectangle">gail_misc_get_extents_from_pango_rectangle</link>
(<link linkend="GtkWidget">GtkWidget</link> *widget,
<link linkend="PangoRectangle">PangoRectangle</link> *char_rect,
<link linkend="gint">gint</link> x_layout,
<link linkend="gint">gint</link> y_layout,
<link linkend="gint">gint</link> *x,
<link linkend="gint">gint</link> *y,
<link linkend="gint">gint</link> *width,
<link linkend="gint">gint</link> *height,
<link linkend="AtkCoordType">AtkCoordType</link> coords);
<link linkend="gint">gint</link> <link linkend="gail-misc-get-index-at-point-in-layout">gail_misc_get_index_at_point_in_layout</link>
(<link linkend="GtkWidget">GtkWidget</link> *widget,
<link linkend="PangoLayout">PangoLayout</link> *layout,
<link linkend="gint">gint</link> x_layout,
<link linkend="gint">gint</link> y_layout,
<link linkend="gint">gint</link> x,
<link linkend="gint">gint</link> y,
<link linkend="AtkCoordType">AtkCoordType</link> coords);
void <link linkend="gail-misc-get-origins">gail_misc_get_origins</link> (<link linkend="GtkWidget">GtkWidget</link> *widget,
<link linkend="gint">gint</link> *x_window,
<link linkend="gint">gint</link> *y_window,
<link linkend="gint">gint</link> *x_toplevel,
<link linkend="gint">gint</link> *y_toplevel);
<link linkend="AtkAttributeSet">AtkAttributeSet</link>* <link linkend="gail-misc-add-to-attr-set">gail_misc_add_to_attr_set</link> (<link linkend="AtkAttributeSet">AtkAttributeSet</link> *attrib_set,
<link linkend="GtkTextAttributes">GtkTextAttributes</link> *attrs,
<link linkend="AtkTextAttribute">AtkTextAttribute</link> attr);
<link linkend="AtkAttributeSet">AtkAttributeSet</link>* <link linkend="gail-misc-buffer-get-run-attributes">gail_misc_buffer_get_run_attributes</link>
(<link linkend="GtkTextBuffer">GtkTextBuffer</link> *buffer,
<link linkend="gint">gint</link> offset,
<link linkend="gint">gint</link> *start_offset,
<link linkend="gint">gint</link> *end_offset);
</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
GailMisc is a set of utility function which are used in the implemementation
of Atk interfaces for Gtk widgets. They may be useful to implementors of
Atk interfaces for custom widgets.
</para>
</refsect1>
<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="gail-misc-add-attribute"/>gail_misc_add_attribute ()</title>
<programlisting><link linkend="AtkAttributeSet">AtkAttributeSet</link>* gail_misc_add_attribute (<link linkend="AtkAttributeSet">AtkAttributeSet</link> *attrib_set,
<link linkend="AtkTextAttribute">AtkTextAttribute</link> attr,
<link linkend="gchar">gchar</link> *value);</programlisting>
<para>
Creates an <link linkend="AtkAttribute">AtkAttribute</link> from <parameter>attr</parameter> and <parameter>value</parameter>, and adds it
to <parameter>attrib_set</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>attrib_set</parameter> :</term>
<listitem><simpara> The <link linkend="AtkAttributeSet">AtkAttributeSet</link> to add the attribute to
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>attr</parameter> :</term>
<listitem><simpara> The AtkTextAttrribute which identifies the attribute to be added
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara> The attribute value
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the new <link linkend="AtkAttributeSet">AtkAttributeSet</link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gail-misc-layout-get-run-attributes"/>gail_misc_layout_get_run_attributes ()</title>
<programlisting><link linkend="AtkAttributeSet">AtkAttributeSet</link>* gail_misc_layout_get_run_attributes
(<link linkend="AtkAttributeSet">AtkAttributeSet</link> *attrib_set,
<link linkend="PangoLayout">PangoLayout</link> *layout,
<link linkend="gchar">gchar</link> *text,
<link linkend="gint">gint</link> offset,
<link linkend="gint">gint</link> *start_offset,
<link linkend="gint">gint</link> *end_offset);</programlisting>
<para>
Adds the attributes for the run starting at offset to the specified
attribute set.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>attrib_set</parameter> :</term>
<listitem><simpara> The <link linkend="AtkAttributeSet">AtkAttributeSet</link> to add the attribute to
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>layout</parameter> :</term>
<listitem><simpara> The PangoLayout from which the attributes will be obtained
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>text</parameter> :</term>
<listitem><simpara> The text
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>offset</parameter> :</term>
<listitem><simpara> The offset at which the attributes are required
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>start_offset</parameter> :</term>
<listitem><simpara> The start offset of the current run
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>end_offset</parameter> :</term>
<listitem><simpara> The end offset of the current run
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the <link linkend="AtkAttributeSet">AtkAttributeSet</link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gail-misc-get-default-attributes"/>gail_misc_get_default_attributes ()</title>
<programlisting><link linkend="AtkAttributeSet">AtkAttributeSet</link>* gail_misc_get_default_attributes
(<link linkend="AtkAttributeSet">AtkAttributeSet</link> *attrib_set,
<link linkend="PangoLayout">PangoLayout</link> *layout,
<link linkend="GtkWidget">GtkWidget</link> *widget);</programlisting>
<para>
Adds the default attributes to the specified attribute set.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>attrib_set</parameter> :</term>
<listitem><simpara> The <link linkend="AtkAttributeSet">AtkAttributeSet</link> to add the attribute to
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>layout</parameter> :</term>
<listitem><simpara> The PangoLayout from which the attributes will be obtained
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>widget</parameter> :</term>
<listitem><simpara> The GtkWidget for which the default attributes are required.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the <link linkend="AtkAttributeSet">AtkAttributeSet</link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gail-misc-get-extents-from-pango-rectangle"/>gail_misc_get_extents_from_pango_rectangle ()</title>
<programlisting>void gail_misc_get_extents_from_pango_rectangle
(<link linkend="GtkWidget">GtkWidget</link> *widget,
<link linkend="PangoRectangle">PangoRectangle</link> *char_rect,
<link linkend="gint">gint</link> x_layout,
<link linkend="gint">gint</link> y_layout,
<link linkend="gint">gint</link> *x,
<link linkend="gint">gint</link> *y,
<link linkend="gint">gint</link> *width,
<link linkend="gint">gint</link> *height,
<link linkend="AtkCoordType">AtkCoordType</link> coords);</programlisting>
<para>
Gets the extents of <parameter>char_rect</parameter> in device coordinates,
relative to either top-level window or screen coordinates as
specified by <parameter>coords</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>widget</parameter> :</term>
<listitem><simpara> The widget that contains the PangoLayout, that contains
the PangoRectangle
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>char_rect</parameter> :</term>
<listitem><simpara> The <link linkend="PangoRectangle">PangoRectangle</link> from which to calculate extents
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x_layout</parameter> :</term>
<listitem><simpara> The x-offset at which the widget displays the
PangoLayout that contains the PangoRectangle, relative to <parameter>widget</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y_layout</parameter> :</term>
<listitem><simpara> The y-offset at which the widget displays the
PangoLayout that contains the PangoRectangle, relative to <parameter>widget</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter> :</term>
<listitem><simpara> The x-position of the <link linkend="PangoRectangle">PangoRectangle</link> relative to <parameter>coords</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter> :</term>
<listitem><simpara> The y-position of the <link linkend="PangoRectangle">PangoRectangle</link> relative to <parameter>coords</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter> :</term>
<listitem><simpara> The width of the <link linkend="PangoRectangle">PangoRectangle</link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter> :</term>
<listitem><simpara> The height of the <link linkend="PangoRectangle">PangoRectangle</link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>coords</parameter> :</term>
<listitem><simpara> An <link linkend="AtkCoordType">AtkCoordType</link> enumeration
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gail-misc-get-index-at-point-in-layout"/>gail_misc_get_index_at_point_in_layout ()</title>
<programlisting><link linkend="gint">gint</link> gail_misc_get_index_at_point_in_layout
(<link linkend="GtkWidget">GtkWidget</link> *widget,
<link linkend="PangoLayout">PangoLayout</link> *layout,
<link linkend="gint">gint</link> x_layout,
<link linkend="gint">gint</link> y_layout,
<link linkend="gint">gint</link> x,
<link linkend="gint">gint</link> y,
<link linkend="AtkCoordType">AtkCoordType</link> coords);</programlisting>
<para>
Gets the byte offset at the specified <parameter>x</parameter> and <parameter>y</parameter> in a <link linkend="PangoLayout">PangoLayout</link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>widget</parameter> :</term>
<listitem><simpara> A <link linkend="GtkWidget">GtkWidget</link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>layout</parameter> :</term>
<listitem><simpara> The <link linkend="PangoLayout">PangoLayout</link> from which to get the index at the
specified point.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x_layout</parameter> :</term>
<listitem><simpara> The x-offset at which the widget displays the
<link linkend="PangoLayout">PangoLayout</link>, relative to <parameter>widget</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y_layout</parameter> :</term>
<listitem><simpara> The y-offset at which the widget displays the
<link linkend="PangoLayout">PangoLayout</link>, relative to <parameter>widget</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter> :</term>
<listitem><simpara> The x-coordinate relative to <parameter>coords</parameter> at which to
calculate the index
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter> :</term>
<listitem><simpara> The y-coordinate relative to <parameter>coords</parameter> at which to
calculate the index
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>coords</parameter> :</term>
<listitem><simpara> An <link linkend="AtkCoordType">AtkCoordType</link> enumeration
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the byte offset at the specified <parameter>x</parameter> and <parameter>y</parameter> in a
<link linkend="PangoLayout">PangoLayout</link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gail-misc-get-origins"/>gail_misc_get_origins ()</title>
<programlisting>void gail_misc_get_origins (<link linkend="GtkWidget">GtkWidget</link> *widget,
<link linkend="gint">gint</link> *x_window,
<link linkend="gint">gint</link> *y_window,
<link linkend="gint">gint</link> *x_toplevel,
<link linkend="gint">gint</link> *y_toplevel);</programlisting>
<para>
Gets the origin of the widget window, and the origin of the
widgets top-level window.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>widget</parameter> :</term>
<listitem><simpara> a <link linkend="GtkWidget">GtkWidget</link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x_window</parameter> :</term>
<listitem><simpara> the x-origin of the widget->window
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y_window</parameter> :</term>
<listitem><simpara> the y-origin of the widget->window
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x_toplevel</parameter> :</term>
<listitem><simpara> the x-origin of the toplevel window for widget->window
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y_toplevel</parameter> :</term>
<listitem><simpara> the y-origin of the toplevel window for widget->window
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gail-misc-add-to-attr-set"/>gail_misc_add_to_attr_set ()</title>
<programlisting><link linkend="AtkAttributeSet">AtkAttributeSet</link>* gail_misc_add_to_attr_set (<link linkend="AtkAttributeSet">AtkAttributeSet</link> *attrib_set,
<link linkend="GtkTextAttributes">GtkTextAttributes</link> *attrs,
<link linkend="AtkTextAttribute">AtkTextAttribute</link> attr);</programlisting>
<para>
Gets the value for the AtkTextAttribute from the GtkTextAttributes
and adds it to the AttributeSet.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>attrib_set</parameter> :</term>
<listitem><simpara> An <link linkend="AtkAttributeSet">AtkAttributeSet</link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>attrs</parameter> :</term>
<listitem><simpara> The <link linkend="GtkTextAttributes">GtkTextAttributes</link> containing the attribute value
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>attr</parameter> :</term>
<listitem><simpara> The <link linkend="AtkTextAttribute">AtkTextAttribute</link> to be added
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the updated <link linkend="AtkAttributeSet">AtkAttributeSet</link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gail-misc-buffer-get-run-attributes"/>gail_misc_buffer_get_run_attributes ()</title>
<programlisting><link linkend="AtkAttributeSet">AtkAttributeSet</link>* gail_misc_buffer_get_run_attributes
(<link linkend="GtkTextBuffer">GtkTextBuffer</link> *buffer,
<link linkend="gint">gint</link> offset,
<link linkend="gint">gint</link> *start_offset,
<link linkend="gint">gint</link> *end_offset);</programlisting>
<para>
Creates an AtkAttributeSet which contains the attributes for the
run starting at offset.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>buffer</parameter> :</term>
<listitem><simpara> The <link linkend="GtkTextBuffer">GtkTextBuffer</link> for which the attributes will be obtained
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>offset</parameter> :</term>
<listitem><simpara> The offset at which the attributes are required
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>start_offset</parameter> :</term>
<listitem><simpara> The start offset of the current run
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>end_offset</parameter> :</term>
<listitem><simpara> The end offset of the current run
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the <link linkend="AtkAttributeSet">AtkAttributeSet</link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
