Glib::ParamSpec

Section: User Contributed Perl Documentation (3)
Updated: 2008-03-14
Index Return to Main Contents
 

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 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)

* $name (string)
* $nick (string)
* $blurb (string)
* $minimum (integer)
* $maximum (integer)
* $default_value (integer)
* $flags (Glib::ParamFlags)
 

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

* $name (string)
* $nick (string)
* $blurb (string)
* $minimum (unsigned)
* $maximum (unsigned)
* $default_value (unsigned)
* $flags (Glib::ParamFlags)
 

string = $pspec->get_blurb

 

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

* $name (string)
* $nick (string)
* $blurb (string)
* $default_value (boolean)
* $flags (Glib::ParamFlags)
 

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

* $name (string)
* $nick (string)
* $blurb (string)
* $package (string) name of the class, derived from Glib::Boxed, of the objects this property will hold.
* $flags (Glib::ParamFlags)
 

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

* $name (string)
* $nick (string)
* $blurb (string)
* $minimum (integer)
* $maximum (integer)
* $default_value (integer)
* $flags (Glib::ParamFlags)
 

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

* $name (string)
* $nick (string)
* $blurb (string)
* $minimum (double)
* $maximum (double)
* $default_value (double)
* $flags (Glib::ParamFlags)
 

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

* $name (string)
* $nick (string)
* $blurb (string)
* $enum_type (string)
* $default_value (scalar)
* $flags (Glib::ParamFlags)
 

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

* $name (string)
* $nick (string)
* $blurb (string)
* $flags_type (string)
* $default_value (scalar)
* $flags (Glib::ParamFlags)
 

paramflags = $pspec->get_flags

 

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

* $name (string)
* $nick (string)
* $blurb (string)
* $minimum (double)
* $maximum (double)
* $default_value (double)
* $flags (Glib::ParamFlags)
 

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

* $name (string)
* $nick (string)
* $blurb (string)
* $minimum (integer)
* $maximum (integer)
* $default_value (integer)
* $flags (Glib::ParamFlags)
 

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

* $name (string)
* $nick (string)
* $blurb (string)
* $minimum (Glib::Int64)
* $maximum (Glib::Int64)
* $default_value (Glib::Int64)
* $flags (Glib::ParamFlags)
 

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

* $name (string)
* $nick (string)
* $blurb (string)
* $minimum (integer)
* $maximum (integer)
* $default_value (integer)
* $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)

* $name (string)
* $nick (string)
* $blurb (string)
* $package (string) name of the class, derived from Glib::Object, of the objects this property will hold.
* $flags (Glib::ParamFlags)
 

string = $pspec->get_owner_type

 

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

* $name (string)
* $nick (string)
* $blurb (string)
* $package (string) name of the class, derived from Glib::ParamSpec, of the objects this property will hold.
* $flags (Glib::ParamFlags)
 

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

* $name (string)
* $nick (string)
* $blurb (string)
* $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)

* $name (string)
* $nick (string)
* $blurb (string)
* $default_value (string)
* $flags (Glib::ParamFlags)
 

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

* $name (string)
* $nick (string)
* $blurb (string)
* $minimum (unsigned)
* $maximum (unsigned)
* $default_value (unsigned)
* $flags (Glib::ParamFlags)
 

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

* $name (string)
* $nick (string)
* $blurb (string)
* $minimum (unsigned)
* $maximum (unsigned)
* $default_value (unsigned)
* $flags (Glib::ParamFlags)
 

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

* $name (string)
* $nick (string)
* $blurb (string)
* $minimum (Glib::UInt64)
* $maximum (Glib::UInt64)
* $default_value (Glib::UInt64)
* $flags (Glib::ParamFlags)
 

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

* $name (string)
* $nick (string)
* $blurb (string)
* $minimum (unsigned)
* $maximum (unsigned)
* $default_value (unsigned)
* $flags (Glib::ParamFlags)
 

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

* $name (string)
* $nick (string)
* $blurb (string)
* $default_value (character)
* $flags (Glib::ParamFlags)
 

string = $pspec->get_value_type

 

ENUMS AND FLAGS

 

flags Glib::ParamFlags

* 'readable' / 'G_PARAM_READABLE'
* 'writable' / 'G_PARAM_WRITABLE'
* 'construct' / 'G_PARAM_CONSTRUCT'
* 'construct-only' / 'G_PARAM_CONSTRUCT_ONLY'
* 'lax-validation' / 'G_PARAM_LAX_VALIDATION'
* 'private' / 'G_PARAM_PRIVATE'
 

SEE ALSO

Glib  

COPYRIGHT

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

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


 

Index

NAME
DESCRIPTION
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
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
COPYRIGHT

linux.jgfs.net manual pages