~ubuntu-branches/debian/squeeze/glib2.0/squeeze

« back to all changes in this revision

Viewing changes to docs/reference/gobject/tmpl/gobject-unused.sgml

  • Committer: Bazaar Package Importer
  • Author(s): Gustavo Noronha Silva
  • Date: 2009-02-15 13:00:43 UTC
  • mfrom: (1.3.1 upstream) (69.1.10 intrepid)
  • Revision ID: james.westby@ubuntu.com-20090215130043-q47fbt3owmt42m2f
Tags: 2.18.4-2
* Release to unstable
* debian/rules:
- bump SHVER, since we are already forcing a 2.18.0 dependecy on the
  symbols introduced in the development versions
* debian/control.in:
- added Homepage and Vcs-* control fields

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<!-- ##### SECTION ./tmpl/param_specs.sgml:Long_Description ##### -->
2
 
<para>
3
 
 
4
 
</para>
5
 
 
6
 
 
7
 
<!-- ##### SECTION ./tmpl/param_specs.sgml:See_Also ##### -->
8
 
<para>
9
 
 
10
 
</para>
11
 
 
12
 
 
13
 
<!-- ##### SECTION ./tmpl/param_specs.sgml:Short_Description ##### -->
14
 
 
15
 
 
16
 
 
17
 
<!-- ##### SECTION ./tmpl/param_specs.sgml:Title ##### -->
18
 
Parameter Specifications
19
 
 
20
 
 
21
 
<!-- ##### STRUCT GBoxed ##### -->
22
 
<para>
23
 
 
24
 
</para>
25
 
 
26
 
 
27
 
<!-- ##### USER_FUNCTION GBoxedInitFunc ##### -->
28
 
<para>
29
 
 
30
 
</para>
31
 
 
32
 
@Returns: 
33
 
 
34
 
<!-- ##### STRUCT GParamSpecClosure ##### -->
35
 
<para>
36
 
 
37
 
</para>
38
 
 
39
 
@parent_instance: 
40
 
 
41
1
<!-- ##### ENUM GTypeFundamentals ##### -->
42
2
<para>
43
3
The predefined identifiers of the reserved fundamental types.
94
54
@G_TYPE_PARAM_CLOSURE: 
95
55
@G_TYPE_PARAM_OBJECT: 
96
56
 
97
 
<!-- ##### MACRO G_INITIALLY_UNOWNED ##### -->
98
 
<para>
99
 
Casts a #GInitiallyUnowned or derived pointer into a (GInitiallyUnowned*) 
100
 
pointer. Depending on the current debugging level, this function may invoke
101
 
certain runtime checks to identify invalid casts.
102
 
</para>
103
 
 
104
 
@object: Object which is subject to casting
105
 
 
106
 
<!-- ##### MACRO G_INITIALLY_UNOWNED_CLASS ##### -->
107
 
<para>
108
 
Casts a derived #GInitiallyUnownedClass structure into a 
109
 
#GInitiallyUnownedClass structure.
110
 
</para>
111
 
 
112
 
@class: a valid #GInitiallyUnownedClass
113
 
 
114
 
<!-- ##### MACRO G_INITIALLY_UNOWNED_GET_CLASS ##### -->
115
 
<para>
116
 
Returns the class structure associated to a #GInitiallyUnowned instance.
117
 
</para>
118
 
 
119
 
@object: a #GInitiallyUnowned instance
120
 
 
121
 
<!-- ##### MACRO G_IS_INITIALLY_UNOWNED ##### -->
122
 
<para>
123
 
Checks whether a valid #GTypeInstance pointer is of type 
124
 
%G_TYPE_INITIALLY_UNOWNED.
125
 
</para>
126
 
 
127
 
@object: Instance to check for being a %G_TYPE_INITIALLY_UNOWNED.
128
 
 
129
 
<!-- ##### MACRO G_IS_INITIALLY_UNOWNED_CLASS ##### -->
130
 
<para>
131
 
Checks whether @class "is a" valid #GInitiallyUnownedClass structure of type
132
 
%G_TYPE_INITIALLY_UNOWNED or derived.
133
 
</para>
134
 
 
135
 
@class: a #GInitiallyUnownedClass
136
 
 
137
 
<!-- ##### MACRO G_IS_PARAM_SPEC_CLOSURE ##### -->
138
 
<para>
139
 
 
140
 
</para>
141
 
 
142
 
@pspec: 
143
 
 
144
 
<!-- ##### MACRO G_PARAM_SPEC_CLOSURE ##### -->
145
 
<para>
146
 
 
147
 
</para>
148
 
 
149
 
@pspec: 
150
 
 
151
 
<!-- ##### MACRO G_TYPE_FUNDAMENTAL_LAST ##### -->
152
 
<para>
153
 
 
154
 
</para>
155
 
 
156
 
 
157
 
<!-- ##### MACRO G_TYPE_FUNDAMENTAL_SHIFT ##### -->
158
 
<para>
159
 
Shift value used in converting numbers to type IDs.
160
 
</para>
161
 
 
162
 
 
163
 
<!-- ##### FUNCTION g_closure_add_fnotify ##### -->
164
 
<para>
165
 
 
166
 
</para>
167
 
 
168
 
@closure: 
169
 
@notify_data: 
170
 
@notify_func: 
171
 
 
172
 
<!-- ##### FUNCTION g_closure_add_inotify ##### -->
173
 
<para>
174
 
 
175
 
</para>
176
 
 
177
 
@closure: 
178
 
@notify_data: 
179
 
@notify_func: 
180
 
 
181
 
<!-- ##### FUNCTION g_closure_remove_fnotify ##### -->
182
 
<para>
183
 
 
184
 
</para>
185
 
 
186
 
@closure: 
187
 
@notify_data: 
188
 
@notify_func: 
189
 
 
190
 
<!-- ##### FUNCTION g_closure_remove_inotify ##### -->
191
 
<para>
192
 
 
193
 
</para>
194
 
 
195
 
@closure: 
196
 
@notify_data: 
197
 
@notify_func: 
198
 
 
199
 
<!-- ##### FUNCTION g_param_spec_closure ##### -->
200
 
<para>
201
 
 
202
 
</para>
203
 
 
204
 
@name: 
205
 
@nick: 
206
 
@blurb: 
207
 
@flags: 
208
 
@Returns: 
209
 
 
210
 
<!-- ##### FUNCTION g_param_spec_string_c ##### -->
211
 
<para>
212
 
 
213
 
</para>
214
 
 
215
 
@name: 
216
 
@nick: 
217
 
@blurb: 
218
 
@default_value: 
219
 
@flags: 
220
 
@Returns: 
221
 
 
222
 
<!-- ##### FUNCTION g_signal_add_emission_hook_full ##### -->
223
 
<para>
224
 
 
225
 
</para>
226
 
 
227
 
@signal_id: 
228
 
@closure: 
229
 
@Returns: 
230
 
 
231
 
<!-- ##### FUNCTION g_signal_handlers_destroy ##### -->
232
 
<para>
233
 
 
234
 
</para>
235
 
 
236
 
@instance: 
237
 
 
238
 
<!-- ##### MACRO g_signal_newc ##### -->
239
 
<para>
240
 
 
241
 
</para>
242
 
 
243
 
@Returns: 
244
 
@signal_name: 
245
 
@itype: 
246
 
@signal_flags: 
247
 
@class_offset: 
248
 
@accumulator: 
249
 
@accu_data: 
250
 
@c_marshaller: 
251
 
@return_type: 
252
 
@n_params: 
253
 
@Varargs: 
254
 
 
255
 
<!-- ##### FUNCTION g_type_check_class_cast ##### -->
256
 
<para>
257
 
</para>
258
 
 
259
 
@g_class: 
260
 
@is_a_type: 
261
 
@Returns: 
262
 
 
263
57
<!-- ##### FUNCTION g_type_check_flags ##### -->
264
58
<para>
265
59
Determines whether a given set of #GTypeFlags and #GTypeFundamentalFlags
270
64
@flags:   Bitwise combination of #GTypeFlags and #GTypeFundamentalFlags.
271
65
@Returns: #TRUE if all @flags are set for @type, #FALSE otherwise.
272
66
 
273
 
<!-- ##### FUNCTION g_type_check_instance ##### -->
274
 
<para>
275
 
Private helper function to aid implementation of the G_TYPE_CHECK_INSTANCE()
276
 
macro.
277
 
</para>
278
 
 
279
 
@instance: A valid #GTypeInstance structure.
280
 
@Returns:  #TRUE if @instance is valid, #FALSE otherwise.
281
 
 
282
 
<!-- ##### FUNCTION g_type_check_instance_cast ##### -->
283
 
<para>
284
 
</para>
285
 
 
286
 
@instance: 
287
 
@iface_type: 
288
 
@Returns: 
289
 
 
290
 
<!-- ##### FUNCTION g_type_check_value ##### -->
291
 
<para>
292
 
</para>
293
 
 
294
 
@value: 
295
 
@Returns: 
296
 
 
297
 
<!-- ##### FUNCTION g_type_class_is_a ##### -->
298
 
<para>
299
 
</para>
300
 
 
301
 
@g_class: 
302
 
@is_a_type: 
303
 
@Returns: 
304
 
 
305
 
<!-- ##### FUNCTION g_type_fundamental_last ##### -->
306
 
<para>
307
 
 
308
 
</para>
309
 
 
310
 
@Returns: 
311
 
 
312
67
<!-- ##### FUNCTION g_type_instance_is_a ##### -->
313
68
<para>
314
69
Determines if @instance adheres to the interface exported
321
76
@iface_type:    A #GType value.
322
77
@Returns:       #TRUE if @instance conforms to @iface_type, #FALSE otherwise.
323
78
 
324
 
<!-- ##### FUNCTION g_type_test_flags ##### -->
325
 
<para>
326
 
 
327
 
</para>
328
 
 
329
 
@type: 
330
 
@flags: 
331
 
@Returns: 
332
 
 
333
79
<!-- ##### FUNCTION g_type_value_is_a ##### -->
334
80
<para>
335
81
Determines if @value is a #GValue whose type conforms to @type.
339
85
@type:    A #GType value.
340
86
@Returns: #TRUE if @value is a #GValue of @type or #FALSE if not.
341
87
 
342
 
<!-- ##### FUNCTION g_value_convert ##### -->
343
 
<para>
344
 
 
345
 
</para>
346
 
 
347
 
@src_value: 
348
 
@dest_value: 
349
 
@Returns: 
350
 
 
351
 
<!-- ##### FUNCTION g_value_register_exchange_func ##### -->
352
 
<para>
353
 
 
354
 
</para>
355
 
 
356
 
@value_type1: 
357
 
@value_type2: 
358
 
@func: 
359
 
 
360
 
<!-- ##### FUNCTION g_value_types_exchangable ##### -->
361
 
<para>
362
 
 
363
 
</para>
364
 
 
365
 
@value_type1: 
366
 
@value_type2: 
367
 
@Returns: 
368
 
 
369
 
<!-- ##### FUNCTION g_values_exchange ##### -->
370
 
<para>
371
 
 
372
 
</para>
373
 
 
374
 
@value1: 
375
 
@value2: 
376
 
@Returns: 
377