NAME


NAME

Glib::ParamSpec


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 the Glib::Object::Subclass manpage.

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)

paramspec = Glib::ParamSpec->UV ($name, $nick, $blurb, $minimum, $maximum, $default_value, $flags)

string = $pspec->get_blurb

paramspec = Glib::ParamSpec->boolean ($name, $nick, $blurb, $default_value, $flags)

paramspec = Glib::ParamSpec->boxed ($name, $nick, $blurb, $package, $flags)

paramspec = Glib::ParamSpec->char ($name, $nick, $blurb, $minimum, $maximum, $default_value, $flags)

paramspec = Glib::ParamSpec->double ($name, $nick, $blurb, $minimum, $maximum, $default_value, $flags)

paramspec = Glib::ParamSpec->enum ($name, $nick, $blurb, $enum_type, $default_value, $flags)

paramspec = Glib::ParamSpec->flags ($name, $nick, $blurb, $flags_type, $default_value, $flags)

paramflags = $pspec->get_flags

paramspec = Glib::ParamSpec->float ($name, $nick, $blurb, $minimum, $maximum, $default_value, $flags)

paramspec = Glib::ParamSpec->int ($name, $nick, $blurb, $minimum, $maximum, $default_value, $flags)

paramspec = Glib::ParamSpec->int64 ($name, $nick, $blurb, $minimum, $maximum, $default_value, $flags)

paramspec = Glib::ParamSpec->long ($name, $nick, $blurb, $minimum, $maximum, $default_value, $flags)

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)

string = $pspec->get_owner_type

paramspec = Glib::ParamSpec->param_spec ($name, $nick, $blurb, $package, $flags)

paramspec = Glib::ParamSpec->scalar ($name, $nick, $blurb, $flags)

paramspec = Glib::ParamSpec->string ($name, $nick, $blurb, $default_value, $flags)

paramspec = Glib::ParamSpec->uchar ($name, $nick, $blurb, $minimum, $maximum, $default_value, $flags)

paramspec = Glib::ParamSpec->uint ($name, $nick, $blurb, $minimum, $maximum, $default_value, $flags)

paramspec = Glib::ParamSpec->uint64 ($name, $nick, $blurb, $minimum, $maximum, $default_value, $flags)

paramspec = Glib::ParamSpec->ulong ($name, $nick, $blurb, $minimum, $maximum, $default_value, $flags)

paramspec = Glib::ParamSpec->unichar ($name, $nick, $blurb, $default_value, $flags)

string = $pspec->get_value_type


ENUMS AND FLAGS

flags Glib::ParamFlags


SEE ALSO

the Glib manpage


COPYRIGHT

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

This software is licensed under the LGPL. See the Glib manpage for a full notice.

 NAME