This file is indexed.

/usr/lib/perl5/Glib/ParamSpec.pod is in libglib-perl 3:1.304-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  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
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
=head1 NAME

Glib::ParamSpec -  Wrapper to encapsulate metadate needed to specify parameters

=cut

=head1 HIERARCHY

  Glib::ParamSpec



=cut

=for object Glib::ParamSpec Wrapper to encapsulate metadate needed to specify parameters

void
DESTROY (GParamSpec * pspec)
    CODE:
	g_param_spec_unref (pspec);

=for position DESCRIPTION

=head1 DESCRIPTION

Glib::ParamSpec encapsulates the metadata required to specify parameters.
You will see these most often when creating new Glib::Object types; see
C<< Glib::Type->register >> and L<Glib::Object::Subclass>.

Parameter specifications allow you to provide limits for validation as
well as nicknames and blurbs to document the parameters.  Blurbs show up
in reference documentation such as this page or the gtk+ C API reference;
i'm not really sure where the nicknames get used.  The Perl bindings for
the most part ignore the difference between dashes and underscores in
the paramspec names, which typically find use as the actual keys for
object parameters.

It's worth noting that Glib offers various sizes of integer and floating
point values, while Perl really only deals with full integers and double
precision floating point values.  The size distinction is important for
the underlying C libraries.

=cut




=head1 METHODS

=head2 paramspec = Glib::ParamSpec-E<gt>B<IV> ($name, $nick, $blurb, $minimum, $maximum, $default_value, $flags)

=over

=item * $name (string) 

=item * $nick (string) 

=item * $blurb (string) 

=item * $minimum (integer) 

=item * $maximum (integer) 

=item * $default_value (integer) 

=item * $flags (Glib::ParamFlags) 

=back

=head2 paramspec = Glib::ParamSpec-E<gt>B<UV> ($name, $nick, $blurb, $minimum, $maximum, $default_value, $flags)

=over

=item * $name (string) 

=item * $nick (string) 

=item * $blurb (string) 

=item * $minimum (unsigned) 

=item * $maximum (unsigned) 

=item * $default_value (unsigned) 

=item * $flags (Glib::ParamFlags) 

=back

=head2 string = $pspec-E<gt>B<get_blurb> 

=head2 paramspec = Glib::ParamSpec-E<gt>B<boolean> ($name, $nick, $blurb, $default_value, $flags)

=over

=item * $name (string) 

=item * $nick (string) 

=item * $blurb (string) 

=item * $default_value (boolean) 

=item * $flags (Glib::ParamFlags) 

=back

=head2 paramspec = Glib::ParamSpec-E<gt>B<boxed> ($name, $nick, $blurb, $package, $flags)

=over

=item * $name (string) 

=item * $nick (string) 

=item * $blurb (string) 

=item * $package (string) name of the class, derived from Glib::Boxed, of the objects this property will hold.

=item * $flags (Glib::ParamFlags) 

=back



=head2 paramspec = Glib::ParamSpec-E<gt>B<char> ($name, $nick, $blurb, $minimum, $maximum, $default_value, $flags)

=over

=item * $name (string) 

=item * $nick (string) 

=item * $blurb (string) 

=item * $minimum (integer) 

=item * $maximum (integer) 

=item * $default_value (integer) 

=item * $flags (Glib::ParamFlags) 

=back

=head2 scalar = $pspec-E<gt>B<get_default_value> 

(This is the C level C<g_param_value_set_default> function.)

Note that on a C<Glib::Param::Unichar> the return is a single-char
string.  This is the same as the constructor
C<< Glib::ParamSpec->unichar >>, but it's not the same as
C<Glib::Object> C<< get_property >> / C<< set_property >>, so an
C<ord()> conversion is needed if passing the default value to a
unichar C<set_property>.

=head2 paramspec = Glib::ParamSpec-E<gt>B<double> ($name, $nick, $blurb, $minimum, $maximum, $default_value, $flags)

=over

=item * $name (string) 

=item * $nick (string) 

=item * $blurb (string) 

=item * $minimum (double) 

=item * $maximum (double) 

=item * $default_value (double) 

=item * $flags (Glib::ParamFlags) 

=back

=head2 paramspec = Glib::ParamSpec-E<gt>B<enum> ($name, $nick, $blurb, $enum_type, $default_value, $flags)

=over

=item * $name (string) 

=item * $nick (string) 

=item * $blurb (string) 

=item * $enum_type (string) 

=item * $default_value (scalar) 

=item * $flags (Glib::ParamFlags) 

=back

=head2 paramspec = Glib::ParamSpec-E<gt>B<flags> ($name, $nick, $blurb, $flags_type, $default_value, $flags)

=over

=item * $name (string) 

=item * $nick (string) 

=item * $blurb (string) 

=item * $flags_type (string) 

=item * $default_value (scalar) 

=item * $flags (Glib::ParamFlags) 

=back

=head2 paramflags = $pspec-E<gt>B<get_flags> 

=head2 paramspec = Glib::ParamSpec-E<gt>B<float> ($name, $nick, $blurb, $minimum, $maximum, $default_value, $flags)

=over

=item * $name (string) 

=item * $nick (string) 

=item * $blurb (string) 

=item * $minimum (double) 

=item * $maximum (double) 

=item * $default_value (double) 

=item * $flags (Glib::ParamFlags) 

=back

=head2 paramspec = Glib::ParamSpec-E<gt>B<gtype> ($name, $nick, $blurb, $is_a_type, $flags)

=over

=item * $name (string) 

=item * $nick (string) 

=item * $blurb (string) 

=item * $is_a_type (string or undef) The name of a class whose subtypes are allowed as values of the property.  Use C<undef> to allow any type.

=item * $flags (Glib::ParamFlags) 

=back



Since: glib 2.10

=head2 paramspec = Glib::ParamSpec-E<gt>B<int> ($name, $nick, $blurb, $minimum, $maximum, $default_value, $flags)

=over

=item * $name (string) 

=item * $nick (string) 

=item * $blurb (string) 

=item * $minimum (integer) 

=item * $maximum (integer) 

=item * $default_value (integer) 

=item * $flags (Glib::ParamFlags) 

=back

=head2 paramspec = Glib::ParamSpec-E<gt>B<int64> ($name, $nick, $blurb, $minimum, $maximum, $default_value, $flags)

=over

=item * $name (string) 

=item * $nick (string) 

=item * $blurb (string) 

=item * $minimum (64 bit integer) 

=item * $maximum (64 bit integer) 

=item * $default_value (64 bit integer) 

=item * $flags (Glib::ParamFlags) 

=back

=head2 paramspec = Glib::ParamSpec-E<gt>B<long> ($name, $nick, $blurb, $minimum, $maximum, $default_value, $flags)

=over

=item * $name (string) 

=item * $nick (string) 

=item * $blurb (string) 

=item * $minimum (integer) 

=item * $maximum (integer) 

=item * $default_value (integer) 

=item * $flags (Glib::ParamFlags) 

=back

=head2 string = $paramspec->B<get_name>



Dashes in the name are converted to underscores.


=head2 string = $pspec-E<gt>B<get_nick> 

=head2 paramspec = Glib::ParamSpec-E<gt>B<object> ($name, $nick, $blurb, $package, $flags)

=over

=item * $name (string) 

=item * $nick (string) 

=item * $blurb (string) 

=item * $package (string) name of the class, derived from Glib::Object, of the objects this property will hold.

=item * $flags (Glib::ParamFlags) 

=back



=head2 paramspec = Glib::ParamSpec-E<gt>B<override> ($name, $overridden)

=over

=item * $name (string) 

=item * $overridden (Glib::ParamSpec) 

=back

Since: glib 2.4

=head2 string = $pspec-E<gt>B<get_owner_type> 

=head2 paramspec = Glib::ParamSpec-E<gt>B<param_spec> ($name, $nick, $blurb, $package, $flags)

=over

=item * $name (string) 

=item * $nick (string) 

=item * $blurb (string) 

=item * $package (string) name of the class, derived from Glib::ParamSpec, of the objects this property will hold.

=item * $flags (Glib::ParamFlags) 

=back



=head2 paramspec or undef = $pspec-E<gt>B<get_redirect_target> 

Since: glib 2.4

=head2 paramspec = Glib::ParamSpec-E<gt>B<scalar> ($name, $nick, $blurb, $flags)

=over

=item * $name (string) 

=item * $nick (string) 

=item * $blurb (string) 

=item * $flags (Glib::ParamFlags) 

=back

ParamSpec to be used for any generic perl scalar, including references to
complex objects.

Currently C<Gtk2::Builder> cannot set object properties of this type
(there's no hooks for property value parsing, as of Gtk 2.20), so
prefer the builtin types if buildable support for an object matters.
A C<boxed> of C<Glib::Strv> can give an array of strings.  A signal
handler callback can do most of what a coderef might.

=head2 paramspec = Glib::ParamSpec-E<gt>B<string> ($name, $nick, $blurb, $default_value, $flags)

=over

=item * $name (string) 

=item * $nick (string) 

=item * $blurb (string) 

=item * $default_value (string or undef) 

=item * $flags (Glib::ParamFlags) 

=back

=head2 paramspec = Glib::ParamSpec-E<gt>B<uchar> ($name, $nick, $blurb, $minimum, $maximum, $default_value, $flags)

=over

=item * $name (string) 

=item * $nick (string) 

=item * $blurb (string) 

=item * $minimum (unsigned) 

=item * $maximum (unsigned) 

=item * $default_value (unsigned) 

=item * $flags (Glib::ParamFlags) 

=back

=head2 paramspec = Glib::ParamSpec-E<gt>B<uint> ($name, $nick, $blurb, $minimum, $maximum, $default_value, $flags)

=over

=item * $name (string) 

=item * $nick (string) 

=item * $blurb (string) 

=item * $minimum (unsigned) 

=item * $maximum (unsigned) 

=item * $default_value (unsigned) 

=item * $flags (Glib::ParamFlags) 

=back

=head2 paramspec = Glib::ParamSpec-E<gt>B<uint64> ($name, $nick, $blurb, $minimum, $maximum, $default_value, $flags)

=over

=item * $name (string) 

=item * $nick (string) 

=item * $blurb (string) 

=item * $minimum (64 bit unsigned) 

=item * $maximum (64 bit unsigned) 

=item * $default_value (64 bit unsigned) 

=item * $flags (Glib::ParamFlags) 

=back

=head2 paramspec = Glib::ParamSpec-E<gt>B<ulong> ($name, $nick, $blurb, $minimum, $maximum, $default_value, $flags)

=over

=item * $name (string) 

=item * $nick (string) 

=item * $blurb (string) 

=item * $minimum (unsigned) 

=item * $maximum (unsigned) 

=item * $default_value (unsigned) 

=item * $flags (Glib::ParamFlags) 

=back

=head2 paramspec = Glib::ParamSpec-E<gt>B<unichar> ($name, $nick, $blurb, $default_value, $flags)

=over

=item * $name (string) 

=item * $nick (string) 

=item * $blurb (string) 

=item * $default_value (character) 

=item * $flags (Glib::ParamFlags) 

=back

=head2 string = $pspec-E<gt>B<get_value_type> 

=head2 bool = $paramspec->B<value_validate> ($value)

=head2 (bool, newval) = $paramspec->B<value_validate> ($value)

=over

=item * $value (scalar) 

=back

In scalar context return true if $value must be modified to be valid
for $paramspec, or false if it's valid already.  In array context
return also a new value which is $value made valid.

$value must be the right type for $paramspec (with usual stringizing,
numizing, etc).  C<value_validate> checks the further restrictions
such as minimum and maximum for a numeric type or allowed characters
in a string.  The "made valid" return is then for instance clamped to
the min/max, or offending chars replaced by a substitutor.

=head2 integer = $pspec-E<gt>B<values_cmp> ($value1, $value2)

=over

=item * $value1 (scalar) 

=item * $value2 (scalar) 

=back

Compares I<value1> with I<value2> according to I<pspec>, and returns -1, 0 or
+1, if value1 is found to be less than, equal to or greater than value2,
respectively.



=cut


=head1 ENUMS AND FLAGS

=head2 flags Glib::ParamFlags



=over

=item * 'readable' / 'G_PARAM_READABLE'

=item * 'writable' / 'G_PARAM_WRITABLE'

=item * 'construct' / 'G_PARAM_CONSTRUCT'

=item * 'construct-only' / 'G_PARAM_CONSTRUCT_ONLY'

=item * 'lax-validation' / 'G_PARAM_LAX_VALIDATION'

=item * 'private' / 'G_PARAM_PRIVATE'

=back




=cut


=head1 SEE ALSO

L<Glib>


=cut


=head1 COPYRIGHT

Copyright (C) 2003-2011 by the gtk2-perl team.

This software is licensed under the LGPL.  See L<Glib> for a full notice.



=cut