1Glib::ParamSpec(3)    User Contributed Perl Documentation   Glib::ParamSpec(3)
2
3
4

NAME

6       Glib::ParamSpec
7

DESCRIPTION

9       Glib::ParamSpec encapsulates the metadata required to specify parame‐
10       ters.  You will see these most often when creating new Glib::Object
11       types; see "Glib::Type->register" and Glib::Object::Subclass.
12
13       Parameter specifications allow you to provide limits for validation as
14       well as nicknames and blurbs to document the parameters.  Blurbs show
15       up in reference documentation such as this page or the gtk+ C API ref‐
16       erence; i'm not really sure where the nicknames get used.  The Perl
17       bindings for the most part ignore the difference between dashes and
18       underscores in the paramspec names, which typically find use as the
19       actual keys for object parameters.
20
21       It's worth noting that Glib offers various sizes of integer and float‐
22       ing point values, while Perl really only deals with full integers and
23       double precision floating point values.  The size distinction is impor‐
24       tant for the underlying C libraries.
25

METHODS

27       paramspec = Glib::ParamSpec->IV ($name, $nick, $blurb, $minimum, $maxi‐
28       mum, $default_value, $flags)
29
30           * $name (string)
31           * $nick (string)
32           * $blurb (string)
33           * $minimum (integer)
34           * $maximum (integer)
35           * $default_value (integer)
36           * $flags (Glib::ParamFlags)
37
38       paramspec = Glib::ParamSpec->UV ($name, $nick, $blurb, $minimum, $maxi‐
39       mum, $default_value, $flags)
40
41           * $name (string)
42           * $nick (string)
43           * $blurb (string)
44           * $minimum (unsigned)
45           * $maximum (unsigned)
46           * $default_value (unsigned)
47           * $flags (Glib::ParamFlags)
48
49       string = $pspec->get_blurb
50
51       paramspec = Glib::ParamSpec->boolean ($name, $nick, $blurb,
52       $default_value, $flags)
53
54           * $name (string)
55           * $nick (string)
56           * $blurb (string)
57           * $default_value (boolean)
58           * $flags (Glib::ParamFlags)
59
60       paramspec = Glib::ParamSpec->boxed ($name, $nick, $blurb, $package,
61       $flags)
62
63           * $name (string)
64           * $nick (string)
65           * $blurb (string)
66           * $package (string) name of the class, derived from Glib::Boxed, of
67           the objects this property will hold.
68           * $flags (Glib::ParamFlags)
69
70       paramspec = Glib::ParamSpec->char ($name, $nick, $blurb, $minimum,
71       $maximum, $default_value, $flags)
72
73           * $name (string)
74           * $nick (string)
75           * $blurb (string)
76           * $minimum (integer)
77           * $maximum (integer)
78           * $default_value (integer)
79           * $flags (Glib::ParamFlags)
80
81       paramspec = Glib::ParamSpec->double ($name, $nick, $blurb, $minimum,
82       $maximum, $default_value, $flags)
83
84           * $name (string)
85           * $nick (string)
86           * $blurb (string)
87           * $minimum (double)
88           * $maximum (double)
89           * $default_value (double)
90           * $flags (Glib::ParamFlags)
91
92       paramspec = Glib::ParamSpec->enum ($name, $nick, $blurb, $enum_type,
93       $default_value, $flags)
94
95           * $name (string)
96           * $nick (string)
97           * $blurb (string)
98           * $enum_type (string)
99           * $default_value (scalar)
100           * $flags (Glib::ParamFlags)
101
102       paramspec = Glib::ParamSpec->flags ($name, $nick, $blurb, $flags_type,
103       $default_value, $flags)
104
105           * $name (string)
106           * $nick (string)
107           * $blurb (string)
108           * $flags_type (string)
109           * $default_value (scalar)
110           * $flags (Glib::ParamFlags)
111
112       paramflags = $pspec->get_flags
113
114       paramspec = Glib::ParamSpec->float ($name, $nick, $blurb, $minimum,
115       $maximum, $default_value, $flags)
116
117           * $name (string)
118           * $nick (string)
119           * $blurb (string)
120           * $minimum (double)
121           * $maximum (double)
122           * $default_value (double)
123           * $flags (Glib::ParamFlags)
124
125       paramspec = Glib::ParamSpec->int ($name, $nick, $blurb, $minimum, $max‐
126       imum, $default_value, $flags)
127
128           * $name (string)
129           * $nick (string)
130           * $blurb (string)
131           * $minimum (integer)
132           * $maximum (integer)
133           * $default_value (integer)
134           * $flags (Glib::ParamFlags)
135
136       paramspec = Glib::ParamSpec->int64 ($name, $nick, $blurb, $minimum,
137       $maximum, $default_value, $flags)
138
139           * $name (string)
140           * $nick (string)
141           * $blurb (string)
142           * $minimum (Glib::Int64)
143           * $maximum (Glib::Int64)
144           * $default_value (Glib::Int64)
145           * $flags (Glib::ParamFlags)
146
147       paramspec = Glib::ParamSpec->long ($name, $nick, $blurb, $minimum,
148       $maximum, $default_value, $flags)
149
150           * $name (string)
151           * $nick (string)
152           * $blurb (string)
153           * $minimum (integer)
154           * $maximum (integer)
155           * $default_value (integer)
156           * $flags (Glib::ParamFlags)
157
158       string = $paramspec->get_name
159
160           Dashes in the name are converted to underscores.
161
162       string = $pspec->get_nick
163
164       paramspec = Glib::ParamSpec->object ($name, $nick, $blurb, $package,
165       $flags)
166
167           * $name (string)
168           * $nick (string)
169           * $blurb (string)
170           * $package (string) name of the class, derived from Glib::Object,
171           of the objects this property will hold.
172           * $flags (Glib::ParamFlags)
173
174       string = $pspec->get_owner_type
175
176       paramspec = Glib::ParamSpec->param_spec ($name, $nick, $blurb, $pack‐
177       age, $flags)
178
179           * $name (string)
180           * $nick (string)
181           * $blurb (string)
182           * $package (string) name of the class, derived from Glib::Param‐
183           Spec, of the objects this property will hold.
184           * $flags (Glib::ParamFlags)
185
186       paramspec = Glib::ParamSpec->scalar ($name, $nick, $blurb, $flags)
187
188           * $name (string)
189           * $nick (string)
190           * $blurb (string)
191           * $flags (Glib::ParamFlags)
192
193           ParamSpec to be used for any generic perl scalar, including refer‐
194           ences to complex objects.
195
196       paramspec = Glib::ParamSpec->string ($name, $nick, $blurb,
197       $default_value, $flags)
198
199           * $name (string)
200           * $nick (string)
201           * $blurb (string)
202           * $default_value (string)
203           * $flags (Glib::ParamFlags)
204
205       paramspec = Glib::ParamSpec->uchar ($name, $nick, $blurb, $minimum,
206       $maximum, $default_value, $flags)
207
208           * $name (string)
209           * $nick (string)
210           * $blurb (string)
211           * $minimum (unsigned)
212           * $maximum (unsigned)
213           * $default_value (unsigned)
214           * $flags (Glib::ParamFlags)
215
216       paramspec = Glib::ParamSpec->uint ($name, $nick, $blurb, $minimum,
217       $maximum, $default_value, $flags)
218
219           * $name (string)
220           * $nick (string)
221           * $blurb (string)
222           * $minimum (unsigned)
223           * $maximum (unsigned)
224           * $default_value (unsigned)
225           * $flags (Glib::ParamFlags)
226
227       paramspec = Glib::ParamSpec->uint64 ($name, $nick, $blurb, $minimum,
228       $maximum, $default_value, $flags)
229
230           * $name (string)
231           * $nick (string)
232           * $blurb (string)
233           * $minimum (Glib::UInt64)
234           * $maximum (Glib::UInt64)
235           * $default_value (Glib::UInt64)
236           * $flags (Glib::ParamFlags)
237
238       paramspec = Glib::ParamSpec->ulong ($name, $nick, $blurb, $minimum,
239       $maximum, $default_value, $flags)
240
241           * $name (string)
242           * $nick (string)
243           * $blurb (string)
244           * $minimum (unsigned)
245           * $maximum (unsigned)
246           * $default_value (unsigned)
247           * $flags (Glib::ParamFlags)
248
249       paramspec = Glib::ParamSpec->unichar ($name, $nick, $blurb,
250       $default_value, $flags)
251
252           * $name (string)
253           * $nick (string)
254           * $blurb (string)
255           * $default_value (character)
256           * $flags (Glib::ParamFlags)
257
258       string = $pspec->get_value_type
259

ENUMS AND FLAGS

261       flags Glib::ParamFlags
262
263       * 'readable' / 'G_PARAM_READABLE'
264       * 'writable' / 'G_PARAM_WRITABLE'
265       * 'construct' / 'G_PARAM_CONSTRUCT'
266       * 'construct-only' / 'G_PARAM_CONSTRUCT_ONLY'
267       * 'lax-validation' / 'G_PARAM_LAX_VALIDATION'
268       * 'private' / 'G_PARAM_PRIVATE'
269

SEE ALSO

271       Glib
272

COPYRIGHT

274       Copyright (C) 2003-2007 by the gtk2-perl team.
275
276       This software is licensed under the LGPL.  See Glib for a full notice.
277
278
279
280perl v5.8.8                       2007-02-26                Glib::ParamSpec(3)