Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Glib::ParamSpec(3)    User Contributed Perl Documentation   Glib::ParamSpec(3)

NAME
       Glib::ParamSpec -  encapsulates metadate	needed to specify parameters

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.

HIERARCHY
	 Glib::ParamSpec

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)

   scalar = $pspec->get_default_value
       (This is	the C level "g_param_value_set_default"	function.)

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

   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->gtype ($name, $nick, $blurb, $is_a_type,
       $flags)
       o   $name (string)

       o   $nick (string)

       o   $blurb (string)

       o   $is_a_type (string or undef)	The name of a class whose subtypes are
	   allowed as values of	the property.  Use "undef" to allow any	type.

       o   $flags (Glib::ParamFlags)

       Since: glib 2.10

   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 (64	bit integer)

       o   $maximum (64	bit integer)

       o   $default_value (64 bit integer)

       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)

   paramspec = Glib::ParamSpec->override ($name, $overridden)
       o   $name (string)

       o   $overridden (Glib::ParamSpec)

       Since: glib 2.4

   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 or	undef =	$pspec->get_redirect_target
       Since: glib 2.4

   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.

       Currently "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
       "boxed" of "Glib::Strv" can give	an array of strings.  A	signal handler
       callback	can do most of what a coderef might.

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

       o   $nick (string)

       o   $blurb (string)

       o   $default_value (string or undef)

       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 (64	bit unsigned)

       o   $maximum (64	bit unsigned)

       o   $default_value (64 bit unsigned)

       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
   bool	= $paramspec->value_validate ($value)
   (bool, newval) = $paramspec->value_validate ($value)
       o   $value (scalar)

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

   integer = $pspec->values_cmp	($value1, $value2)
       o   $value1 (scalar)

       o   $value2 (scalar)

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

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'

       o   'static-name' / 'G_PARAM_STATIC_NAME'

       o   'static-nick' / 'G_PARAM_STATIC_NICK'

       o   'static-blurb' / 'G_PARAM_STATIC_BLURB'

       o   'explicit-notify' / 'G_PARAM_EXPLICIT_NOTIFY'

       o   'deprecated'	/ 'G_PARAM_DEPRECATED'

SEE ALSO
       Glib

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

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

perl v5.32.1			  2021-09-21		    Glib::ParamSpec(3)

NAME | DESCRIPTION | HIERARCHY | METHODS | ENUMS AND FLAGS | SEE ALSO | COPYRIGHT

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Glib::ParamSpec&sektion=3&manpath=FreeBSD+13.0-RELEASE+and+Ports>

home | help