On Apache
Under GNU General Public License
2012-05-24 08:23 @38.107.179.240 Crawled by CCBot/1.0 (+http://www.commoncrawl.org/bot.html)
Glib::ParamSpec(3pm) User Contributed Perl Documentation Glib::ParamSpec(3pm)
NAME
Glib::ParamSpec - Wrapper to encapsulate metadate needed to specify parameters
void DESTROY (GParamSpec * pspec)
CODE: g_param_spec_unref (pspec);
DESCRIPTION
Glib::ParamSpec encapsulates the metadata required to specify parameters. You will see
these most often when creating new Glib::Object types; see "Glib::Type->register" and
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.
METHODS
paramspec = Glib::ParamSpec->IV ($name, $nick, $blurb, $minimum, $maximum, $default_value,
$flags)
o $name (string)
o $nick (string)
o $blurb (string)
o $minimum (integer)
o $maximum (integer)
o $default_value (integer)
o $flags (Glib::ParamFlags)
paramspec = Glib::ParamSpec->UV ($name, $nick, $blurb, $minimum, $maximum, $default_value,
$flags)
o $name (string)
o $nick (string)
o $blurb (string)
o $minimum (unsigned)
o $maximum (unsigned)
o $default_value (unsigned)
o $flags (Glib::ParamFlags)
string = $pspec->get_blurb
paramspec = Glib::ParamSpec->boolean ($name, $nick, $blurb, $default_value, $flags)
o $name (string)
o $nick (string)
o $blurb (string)
o $default_value (boolean)
o $flags (Glib::ParamFlags)
paramspec = Glib::ParamSpec->boxed ($name, $nick, $blurb, $package, $flags)
o $name (string)
o $nick (string)
o $blurb (string)
o $package (string) name of the class, derived from Glib::Boxed, of the objects this
property will hold.
o $flags (Glib::ParamFlags)
paramspec = Glib::ParamSpec->char ($name, $nick, $blurb, $minimum, $maximum,
$default_value, $flags)
o $name (string)
o $nick (string)
o $blurb (string)
o $minimum (integer)
o $maximum (integer)
o $default_value (integer)
o $flags (Glib::ParamFlags)
paramspec = Glib::ParamSpec->double ($name, $nick, $blurb, $minimum, $maximum,
$default_value, $flags)
o $name (string)
o $nick (string)
o $blurb (string)
o $minimum (double)
o $maximum (double)
o $default_value (double)
o $flags (Glib::ParamFlags)
paramspec = Glib::ParamSpec->enum ($name, $nick, $blurb, $enum_type, $default_value,
$flags)
o $name (string)
o $nick (string)
o $blurb (string)
o $enum_type (string)
o $default_value (scalar)
o $flags (Glib::ParamFlags)
paramspec = Glib::ParamSpec->flags ($name, $nick, $blurb, $flags_type, $default_value,
$flags)
o $name (string)
o $nick (string)
o $blurb (string)
o $flags_type (string)
o $default_value (scalar)
o $flags (Glib::ParamFlags)
paramflags = $pspec->get_flags
paramspec = Glib::ParamSpec->float ($name, $nick, $blurb, $minimum, $maximum,
$default_value, $flags)
o $name (string)
o $nick (string)
o $blurb (string)
o $minimum (double)
o $maximum (double)
o $default_value (double)
o $flags (Glib::ParamFlags)
paramspec = Glib::ParamSpec->int ($name, $nick, $blurb, $minimum, $maximum,
$default_value, $flags)
o $name (string)
o $nick (string)
o $blurb (string)
o $minimum (integer)
o $maximum (integer)
o $default_value (integer)
o $flags (Glib::ParamFlags)
paramspec = Glib::ParamSpec->int64 ($name, $nick, $blurb, $minimum, $maximum,
$default_value, $flags)
o $name (string)
o $nick (string)
o $blurb (string)
o $minimum (Glib::Int64)
o $maximum (Glib::Int64)
o $default_value (Glib::Int64)
o $flags (Glib::ParamFlags)
paramspec = Glib::ParamSpec->long ($name, $nick, $blurb, $minimum, $maximum,
$default_value, $flags)
o $name (string)
o $nick (string)
o $blurb (string)
o $minimum (integer)
o $maximum (integer)
o $default_value (integer)
o $flags (Glib::ParamFlags)
string = $paramspec->get_name
Dashes in the name are converted to underscores.
string = $pspec->get_nick
paramspec = Glib::ParamSpec->object ($name, $nick, $blurb, $package, $flags)
o $name (string)
o $nick (string)
o $blurb (string)
o $package (string) name of the class, derived from Glib::Object, of the objects
this property will hold.
o $flags (Glib::ParamFlags)
string = $pspec->get_owner_type
paramspec = Glib::ParamSpec->param_spec ($name, $nick, $blurb, $package, $flags)
o $name (string)
o $nick (string)
o $blurb (string)
o $package (string) name of the class, derived from Glib::ParamSpec, of the objects
this property will hold.
o $flags (Glib::ParamFlags)
paramspec = Glib::ParamSpec->scalar ($name, $nick, $blurb, $flags)
o $name (string)
o $nick (string)
o $blurb (string)
o $flags (Glib::ParamFlags)
ParamSpec to be used for any generic perl scalar, including references to complex
objects.
paramspec = Glib::ParamSpec->string ($name, $nick, $blurb, $default_value, $flags)
o $name (string)
o $nick (string)
o $blurb (string)
o $default_value (string)
o $flags (Glib::ParamFlags)
paramspec = Glib::ParamSpec->uchar ($name, $nick, $blurb, $minimum, $maximum,
$default_value, $flags)
o $name (string)
o $nick (string)
o $blurb (string)
o $minimum (unsigned)
o $maximum (unsigned)
o $default_value (unsigned)
o $flags (Glib::ParamFlags)
paramspec = Glib::ParamSpec->uint ($name, $nick, $blurb, $minimum, $maximum,
$default_value, $flags)
o $name (string)
o $nick (string)
o $blurb (string)
o $minimum (unsigned)
o $maximum (unsigned)
o $default_value (unsigned)
o $flags (Glib::ParamFlags)
paramspec = Glib::ParamSpec->uint64 ($name, $nick, $blurb, $minimum, $maximum,
$default_value, $flags)
o $name (string)
o $nick (string)
o $blurb (string)
o $minimum (Glib::UInt64)
o $maximum (Glib::UInt64)
o $default_value (Glib::UInt64)
o $flags (Glib::ParamFlags)
paramspec = Glib::ParamSpec->ulong ($name, $nick, $blurb, $minimum, $maximum,
$default_value, $flags)
o $name (string)
o $nick (string)
o $blurb (string)
o $minimum (unsigned)
o $maximum (unsigned)
o $default_value (unsigned)
o $flags (Glib::ParamFlags)
paramspec = Glib::ParamSpec->unichar ($name, $nick, $blurb, $default_value, $flags)
o $name (string)
o $nick (string)
o $blurb (string)
o $default_value (character)
o $flags (Glib::ParamFlags)
string = $pspec->get_value_type
ENUMS AND FLAGS
flags Glib::ParamFlags
o 'readable' / 'G_PARAM_READABLE'
o 'writable' / 'G_PARAM_WRITABLE'
o 'construct' / 'G_PARAM_CONSTRUCT'
o 'construct-only' / 'G_PARAM_CONSTRUCT_ONLY'
o 'lax-validation' / 'G_PARAM_LAX_VALIDATION'
o 'private' / 'G_PARAM_PRIVATE'
SEE ALSO
Glib
COPYRIGHT
Copyright (C) 2003-2008 by the gtk2-perl team.
This software is licensed under the LGPL. See Glib for a full notice.
perl v5.10.0 2008-07-24 Glib::ParamSpec(3pm)
Generated by $Id: phpMan.php,v 4.49 2006/02/26 13:18:18 chedong Exp $ Author: Che Dong
On Apache
Under GNU General Public License
2012-05-24 08:23 @38.107.179.240 Crawled by CCBot/1.0 (+http://www.commoncrawl.org/bot.html)