770 lines
21 KiB
HTML
770 lines
21 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of Glib::ParamSpec</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>Glib::ParamSpec</H1>
|
|
Section: User Contributed Perl Documentation (3pm)<BR>Updated: 2020-02-18<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
Glib::ParamSpec - encapsulates metadate needed to specify parameters
|
|
<A NAME="lbAC"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
|
|
|
|
Glib::ParamSpec encapsulates the metadata required to specify parameters.
|
|
You will see these most often when creating new Glib::Object types; see
|
|
<TT>"Glib::Type->register"</TT> and Glib::Object::Subclass.
|
|
<P>
|
|
|
|
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 <FONT SIZE="-1">API</FONT> 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.
|
|
<P>
|
|
|
|
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.
|
|
<A NAME="lbAD"> </A>
|
|
<H2>HIERARCHY</H2>
|
|
|
|
|
|
|
|
|
|
|
|
<PRE>
|
|
Glib::ParamSpec
|
|
|
|
</PRE>
|
|
|
|
|
|
<A NAME="lbAE"> </A>
|
|
<H2>METHODS</H2>
|
|
|
|
|
|
|
|
<A NAME="lbAF"> </A>
|
|
<H3>paramspec = Glib::ParamSpec-><B></B><FONT SIZE="-1"><B>IV</B></FONT><B></B> ($name, $nick, $blurb, $minimum, $maximum, $default_value, $flags)</H3>
|
|
|
|
|
|
|
|
|
|
|
|
<DL COMPACT>
|
|
<DT id="1">•<DD>
|
|
<TT>$name</TT> (string)
|
|
<DT id="2">•<DD>
|
|
<TT>$nick</TT> (string)
|
|
<DT id="3">•<DD>
|
|
<TT>$blurb</TT> (string)
|
|
<DT id="4">•<DD>
|
|
<TT>$minimum</TT> (integer)
|
|
<DT id="5">•<DD>
|
|
<TT>$maximum</TT> (integer)
|
|
<DT id="6">•<DD>
|
|
<TT>$default_value</TT> (integer)
|
|
<DT id="7">•<DD>
|
|
<TT>$flags</TT> (Glib::ParamFlags)
|
|
</DL>
|
|
<A NAME="lbAG"> </A>
|
|
<H3>paramspec = Glib::ParamSpec-><B></B><FONT SIZE="-1"><B>UV</B></FONT><B></B> ($name, $nick, $blurb, $minimum, $maximum, $default_value, $flags)</H3>
|
|
|
|
|
|
|
|
|
|
|
|
<DL COMPACT>
|
|
<DT id="8">•<DD>
|
|
<TT>$name</TT> (string)
|
|
<DT id="9">•<DD>
|
|
<TT>$nick</TT> (string)
|
|
<DT id="10">•<DD>
|
|
<TT>$blurb</TT> (string)
|
|
<DT id="11">•<DD>
|
|
<TT>$minimum</TT> (unsigned)
|
|
<DT id="12">•<DD>
|
|
<TT>$maximum</TT> (unsigned)
|
|
<DT id="13">•<DD>
|
|
<TT>$default_value</TT> (unsigned)
|
|
<DT id="14">•<DD>
|
|
<TT>$flags</TT> (Glib::ParamFlags)
|
|
</DL>
|
|
<A NAME="lbAH"> </A>
|
|
<H3>string = $pspec-><B>get_blurb</B></H3>
|
|
|
|
|
|
|
|
|
|
|
|
<A NAME="lbAI"> </A>
|
|
<H3>paramspec = Glib::ParamSpec-><B>boolean</B> ($name, $nick, $blurb, $default_value, $flags)</H3>
|
|
|
|
|
|
|
|
|
|
|
|
<DL COMPACT>
|
|
<DT id="15">•<DD>
|
|
<TT>$name</TT> (string)
|
|
<DT id="16">•<DD>
|
|
<TT>$nick</TT> (string)
|
|
<DT id="17">•<DD>
|
|
<TT>$blurb</TT> (string)
|
|
<DT id="18">•<DD>
|
|
<TT>$default_value</TT> (boolean)
|
|
<DT id="19">•<DD>
|
|
<TT>$flags</TT> (Glib::ParamFlags)
|
|
</DL>
|
|
<A NAME="lbAJ"> </A>
|
|
<H3>paramspec = Glib::ParamSpec-><B>boxed</B> ($name, $nick, $blurb, $package, $flags)</H3>
|
|
|
|
|
|
|
|
|
|
|
|
<DL COMPACT>
|
|
<DT id="20">•<DD>
|
|
<TT>$name</TT> (string)
|
|
<DT id="21">•<DD>
|
|
<TT>$nick</TT> (string)
|
|
<DT id="22">•<DD>
|
|
<TT>$blurb</TT> (string)
|
|
<DT id="23">•<DD>
|
|
<TT>$package</TT> (string) name of the class, derived from Glib::Boxed, of the objects this property will hold.
|
|
<DT id="24">•<DD>
|
|
<TT>$flags</TT> (Glib::ParamFlags)
|
|
</DL>
|
|
<A NAME="lbAK"> </A>
|
|
<H3>paramspec = Glib::ParamSpec-><B>char</B> ($name, $nick, $blurb, $minimum, $maximum, $default_value, $flags)</H3>
|
|
|
|
|
|
|
|
|
|
|
|
<DL COMPACT>
|
|
<DT id="25">•<DD>
|
|
<TT>$name</TT> (string)
|
|
<DT id="26">•<DD>
|
|
<TT>$nick</TT> (string)
|
|
<DT id="27">•<DD>
|
|
<TT>$blurb</TT> (string)
|
|
<DT id="28">•<DD>
|
|
<TT>$minimum</TT> (integer)
|
|
<DT id="29">•<DD>
|
|
<TT>$maximum</TT> (integer)
|
|
<DT id="30">•<DD>
|
|
<TT>$default_value</TT> (integer)
|
|
<DT id="31">•<DD>
|
|
<TT>$flags</TT> (Glib::ParamFlags)
|
|
</DL>
|
|
<A NAME="lbAL"> </A>
|
|
<H3>scalar = $pspec-><B>get_default_value</B></H3>
|
|
|
|
|
|
|
|
|
|
|
|
(This is the C level <TT>"g_param_value_set_default"</TT> function.)
|
|
<P>
|
|
|
|
Note that on a <TT>"Glib::Param::Unichar"</TT> the return is a single-char
|
|
string. This is the same as the constructor
|
|
<TT>"Glib::ParamSpec->unichar"</TT>, but it's not the same as
|
|
<TT>"Glib::Object"</TT> <TT>"get_property"</TT> / <TT>"set_property"</TT>, so an
|
|
<TT>"ord()"</TT> conversion is needed if passing the default value to a
|
|
unichar <TT>"set_property"</TT>.
|
|
<A NAME="lbAM"> </A>
|
|
<H3>paramspec = Glib::ParamSpec-><B>double</B> ($name, $nick, $blurb, $minimum, $maximum, $default_value, $flags)</H3>
|
|
|
|
|
|
|
|
|
|
|
|
<DL COMPACT>
|
|
<DT id="32">•<DD>
|
|
<TT>$name</TT> (string)
|
|
<DT id="33">•<DD>
|
|
<TT>$nick</TT> (string)
|
|
<DT id="34">•<DD>
|
|
<TT>$blurb</TT> (string)
|
|
<DT id="35">•<DD>
|
|
<TT>$minimum</TT> (double)
|
|
<DT id="36">•<DD>
|
|
<TT>$maximum</TT> (double)
|
|
<DT id="37">•<DD>
|
|
<TT>$default_value</TT> (double)
|
|
<DT id="38">•<DD>
|
|
<TT>$flags</TT> (Glib::ParamFlags)
|
|
</DL>
|
|
<A NAME="lbAN"> </A>
|
|
<H3>paramspec = Glib::ParamSpec-><B>enum</B> ($name, $nick, $blurb, $enum_type, $default_value, $flags)</H3>
|
|
|
|
|
|
|
|
|
|
|
|
<DL COMPACT>
|
|
<DT id="39">•<DD>
|
|
<TT>$name</TT> (string)
|
|
<DT id="40">•<DD>
|
|
<TT>$nick</TT> (string)
|
|
<DT id="41">•<DD>
|
|
<TT>$blurb</TT> (string)
|
|
<DT id="42">•<DD>
|
|
<TT>$enum_type</TT> (string)
|
|
<DT id="43">•<DD>
|
|
<TT>$default_value</TT> (scalar)
|
|
<DT id="44">•<DD>
|
|
<TT>$flags</TT> (Glib::ParamFlags)
|
|
</DL>
|
|
<A NAME="lbAO"> </A>
|
|
<H3>paramspec = Glib::ParamSpec-><B>flags</B> ($name, $nick, $blurb, $flags_type, $default_value, $flags)</H3>
|
|
|
|
|
|
|
|
|
|
|
|
<DL COMPACT>
|
|
<DT id="45">•<DD>
|
|
<TT>$name</TT> (string)
|
|
<DT id="46">•<DD>
|
|
<TT>$nick</TT> (string)
|
|
<DT id="47">•<DD>
|
|
<TT>$blurb</TT> (string)
|
|
<DT id="48">•<DD>
|
|
<TT>$flags_type</TT> (string)
|
|
<DT id="49">•<DD>
|
|
<TT>$default_value</TT> (scalar)
|
|
<DT id="50">•<DD>
|
|
<TT>$flags</TT> (Glib::ParamFlags)
|
|
</DL>
|
|
<A NAME="lbAP"> </A>
|
|
<H3>paramflags = $pspec-><B>get_flags</B></H3>
|
|
|
|
|
|
|
|
|
|
|
|
<A NAME="lbAQ"> </A>
|
|
<H3>paramspec = Glib::ParamSpec-><B>float</B> ($name, $nick, $blurb, $minimum, $maximum, $default_value, $flags)</H3>
|
|
|
|
|
|
|
|
|
|
|
|
<DL COMPACT>
|
|
<DT id="51">•<DD>
|
|
<TT>$name</TT> (string)
|
|
<DT id="52">•<DD>
|
|
<TT>$nick</TT> (string)
|
|
<DT id="53">•<DD>
|
|
<TT>$blurb</TT> (string)
|
|
<DT id="54">•<DD>
|
|
<TT>$minimum</TT> (double)
|
|
<DT id="55">•<DD>
|
|
<TT>$maximum</TT> (double)
|
|
<DT id="56">•<DD>
|
|
<TT>$default_value</TT> (double)
|
|
<DT id="57">•<DD>
|
|
<TT>$flags</TT> (Glib::ParamFlags)
|
|
</DL>
|
|
<A NAME="lbAR"> </A>
|
|
<H3>paramspec = Glib::ParamSpec-><B>gtype</B> ($name, $nick, $blurb, $is_a_type, $flags)</H3>
|
|
|
|
|
|
|
|
|
|
|
|
<DL COMPACT>
|
|
<DT id="58">•<DD>
|
|
<TT>$name</TT> (string)
|
|
<DT id="59">•<DD>
|
|
<TT>$nick</TT> (string)
|
|
<DT id="60">•<DD>
|
|
<TT>$blurb</TT> (string)
|
|
<DT id="61">•<DD>
|
|
<TT>$is_a_type</TT> (string or undef) The name of a class whose subtypes are allowed as values of the property. Use <TT>"undef"</TT> to allow any type.
|
|
<DT id="62">•<DD>
|
|
<TT>$flags</TT> (Glib::ParamFlags)
|
|
</DL>
|
|
<P>
|
|
|
|
Since: glib 2.10
|
|
<A NAME="lbAS"> </A>
|
|
<H3>paramspec = Glib::ParamSpec-><B>int</B> ($name, $nick, $blurb, $minimum, $maximum, $default_value, $flags)</H3>
|
|
|
|
|
|
|
|
|
|
|
|
<DL COMPACT>
|
|
<DT id="63">•<DD>
|
|
<TT>$name</TT> (string)
|
|
<DT id="64">•<DD>
|
|
<TT>$nick</TT> (string)
|
|
<DT id="65">•<DD>
|
|
<TT>$blurb</TT> (string)
|
|
<DT id="66">•<DD>
|
|
<TT>$minimum</TT> (integer)
|
|
<DT id="67">•<DD>
|
|
<TT>$maximum</TT> (integer)
|
|
<DT id="68">•<DD>
|
|
<TT>$default_value</TT> (integer)
|
|
<DT id="69">•<DD>
|
|
<TT>$flags</TT> (Glib::ParamFlags)
|
|
</DL>
|
|
<A NAME="lbAT"> </A>
|
|
<H3>paramspec = Glib::ParamSpec-><B>int64</B> ($name, $nick, $blurb, $minimum, $maximum, $default_value, $flags)</H3>
|
|
|
|
|
|
|
|
|
|
|
|
<DL COMPACT>
|
|
<DT id="70">•<DD>
|
|
<TT>$name</TT> (string)
|
|
<DT id="71">•<DD>
|
|
<TT>$nick</TT> (string)
|
|
<DT id="72">•<DD>
|
|
<TT>$blurb</TT> (string)
|
|
<DT id="73">•<DD>
|
|
<TT>$minimum</TT> (64 bit integer)
|
|
<DT id="74">•<DD>
|
|
<TT>$maximum</TT> (64 bit integer)
|
|
<DT id="75">•<DD>
|
|
<TT>$default_value</TT> (64 bit integer)
|
|
<DT id="76">•<DD>
|
|
<TT>$flags</TT> (Glib::ParamFlags)
|
|
</DL>
|
|
<A NAME="lbAU"> </A>
|
|
<H3>paramspec = Glib::ParamSpec-><B>long</B> ($name, $nick, $blurb, $minimum, $maximum, $default_value, $flags)</H3>
|
|
|
|
|
|
|
|
|
|
|
|
<DL COMPACT>
|
|
<DT id="77">•<DD>
|
|
<TT>$name</TT> (string)
|
|
<DT id="78">•<DD>
|
|
<TT>$nick</TT> (string)
|
|
<DT id="79">•<DD>
|
|
<TT>$blurb</TT> (string)
|
|
<DT id="80">•<DD>
|
|
<TT>$minimum</TT> (integer)
|
|
<DT id="81">•<DD>
|
|
<TT>$maximum</TT> (integer)
|
|
<DT id="82">•<DD>
|
|
<TT>$default_value</TT> (integer)
|
|
<DT id="83">•<DD>
|
|
<TT>$flags</TT> (Glib::ParamFlags)
|
|
</DL>
|
|
<A NAME="lbAV"> </A>
|
|
<H3>string = $paramspec-><B>get_name</B></H3>
|
|
|
|
|
|
|
|
|
|
|
|
Dashes in the name are converted to underscores.
|
|
<A NAME="lbAW"> </A>
|
|
<H3>string = $pspec-><B>get_nick</B></H3>
|
|
|
|
|
|
|
|
|
|
|
|
<A NAME="lbAX"> </A>
|
|
<H3>paramspec = Glib::ParamSpec-><B>object</B> ($name, $nick, $blurb, $package, $flags)</H3>
|
|
|
|
|
|
|
|
|
|
|
|
<DL COMPACT>
|
|
<DT id="84">•<DD>
|
|
<TT>$name</TT> (string)
|
|
<DT id="85">•<DD>
|
|
<TT>$nick</TT> (string)
|
|
<DT id="86">•<DD>
|
|
<TT>$blurb</TT> (string)
|
|
<DT id="87">•<DD>
|
|
<TT>$package</TT> (string) name of the class, derived from Glib::Object, of the objects this property will hold.
|
|
<DT id="88">•<DD>
|
|
<TT>$flags</TT> (Glib::ParamFlags)
|
|
</DL>
|
|
<A NAME="lbAY"> </A>
|
|
<H3>paramspec = Glib::ParamSpec-><B>override</B> ($name, $overridden)</H3>
|
|
|
|
|
|
|
|
|
|
|
|
<DL COMPACT>
|
|
<DT id="89">•<DD>
|
|
<TT>$name</TT> (string)
|
|
<DT id="90">•<DD>
|
|
<TT>$overridden</TT> (Glib::ParamSpec)
|
|
</DL>
|
|
<P>
|
|
|
|
Since: glib 2.4
|
|
<A NAME="lbAZ"> </A>
|
|
<H3>string = $pspec-><B>get_owner_type</B></H3>
|
|
|
|
|
|
|
|
|
|
|
|
<A NAME="lbBA"> </A>
|
|
<H3>paramspec = Glib::ParamSpec-><B>param_spec</B> ($name, $nick, $blurb, $package, $flags)</H3>
|
|
|
|
|
|
|
|
|
|
|
|
<DL COMPACT>
|
|
<DT id="91">•<DD>
|
|
<TT>$name</TT> (string)
|
|
<DT id="92">•<DD>
|
|
<TT>$nick</TT> (string)
|
|
<DT id="93">•<DD>
|
|
<TT>$blurb</TT> (string)
|
|
<DT id="94">•<DD>
|
|
<TT>$package</TT> (string) name of the class, derived from Glib::ParamSpec, of the objects this property will hold.
|
|
<DT id="95">•<DD>
|
|
<TT>$flags</TT> (Glib::ParamFlags)
|
|
</DL>
|
|
<A NAME="lbBB"> </A>
|
|
<H3>paramspec or undef = $pspec-><B>get_redirect_target</B></H3>
|
|
|
|
|
|
|
|
|
|
|
|
Since: glib 2.4
|
|
<A NAME="lbBC"> </A>
|
|
<H3>paramspec = Glib::ParamSpec-><B>scalar</B> ($name, $nick, $blurb, $flags)</H3>
|
|
|
|
|
|
|
|
|
|
|
|
<DL COMPACT>
|
|
<DT id="96">•<DD>
|
|
<TT>$name</TT> (string)
|
|
<DT id="97">•<DD>
|
|
<TT>$nick</TT> (string)
|
|
<DT id="98">•<DD>
|
|
<TT>$blurb</TT> (string)
|
|
<DT id="99">•<DD>
|
|
<TT>$flags</TT> (Glib::ParamFlags)
|
|
</DL>
|
|
<P>
|
|
|
|
ParamSpec to be used for any generic perl scalar, including references to
|
|
complex objects.
|
|
<P>
|
|
|
|
Currently <TT>"Gtk2::Builder"</TT> 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 <TT>"boxed"</TT> of <TT>"Glib::Strv"</TT> can give an array of strings. A signal
|
|
handler callback can do most of what a coderef might.
|
|
<A NAME="lbBD"> </A>
|
|
<H3>paramspec = Glib::ParamSpec-><B>string</B> ($name, $nick, $blurb, $default_value, $flags)</H3>
|
|
|
|
|
|
|
|
|
|
|
|
<DL COMPACT>
|
|
<DT id="100">•<DD>
|
|
<TT>$name</TT> (string)
|
|
<DT id="101">•<DD>
|
|
<TT>$nick</TT> (string)
|
|
<DT id="102">•<DD>
|
|
<TT>$blurb</TT> (string)
|
|
<DT id="103">•<DD>
|
|
<TT>$default_value</TT> (string or undef)
|
|
<DT id="104">•<DD>
|
|
<TT>$flags</TT> (Glib::ParamFlags)
|
|
</DL>
|
|
<A NAME="lbBE"> </A>
|
|
<H3>paramspec = Glib::ParamSpec-><B>uchar</B> ($name, $nick, $blurb, $minimum, $maximum, $default_value, $flags)</H3>
|
|
|
|
|
|
|
|
|
|
|
|
<DL COMPACT>
|
|
<DT id="105">•<DD>
|
|
<TT>$name</TT> (string)
|
|
<DT id="106">•<DD>
|
|
<TT>$nick</TT> (string)
|
|
<DT id="107">•<DD>
|
|
<TT>$blurb</TT> (string)
|
|
<DT id="108">•<DD>
|
|
<TT>$minimum</TT> (unsigned)
|
|
<DT id="109">•<DD>
|
|
<TT>$maximum</TT> (unsigned)
|
|
<DT id="110">•<DD>
|
|
<TT>$default_value</TT> (unsigned)
|
|
<DT id="111">•<DD>
|
|
<TT>$flags</TT> (Glib::ParamFlags)
|
|
</DL>
|
|
<A NAME="lbBF"> </A>
|
|
<H3>paramspec = Glib::ParamSpec-><B>uint</B> ($name, $nick, $blurb, $minimum, $maximum, $default_value, $flags)</H3>
|
|
|
|
|
|
|
|
|
|
|
|
<DL COMPACT>
|
|
<DT id="112">•<DD>
|
|
<TT>$name</TT> (string)
|
|
<DT id="113">•<DD>
|
|
<TT>$nick</TT> (string)
|
|
<DT id="114">•<DD>
|
|
<TT>$blurb</TT> (string)
|
|
<DT id="115">•<DD>
|
|
<TT>$minimum</TT> (unsigned)
|
|
<DT id="116">•<DD>
|
|
<TT>$maximum</TT> (unsigned)
|
|
<DT id="117">•<DD>
|
|
<TT>$default_value</TT> (unsigned)
|
|
<DT id="118">•<DD>
|
|
<TT>$flags</TT> (Glib::ParamFlags)
|
|
</DL>
|
|
<A NAME="lbBG"> </A>
|
|
<H3>paramspec = Glib::ParamSpec-><B>uint64</B> ($name, $nick, $blurb, $minimum, $maximum, $default_value, $flags)</H3>
|
|
|
|
|
|
|
|
|
|
|
|
<DL COMPACT>
|
|
<DT id="119">•<DD>
|
|
<TT>$name</TT> (string)
|
|
<DT id="120">•<DD>
|
|
<TT>$nick</TT> (string)
|
|
<DT id="121">•<DD>
|
|
<TT>$blurb</TT> (string)
|
|
<DT id="122">•<DD>
|
|
<TT>$minimum</TT> (64 bit unsigned)
|
|
<DT id="123">•<DD>
|
|
<TT>$maximum</TT> (64 bit unsigned)
|
|
<DT id="124">•<DD>
|
|
<TT>$default_value</TT> (64 bit unsigned)
|
|
<DT id="125">•<DD>
|
|
<TT>$flags</TT> (Glib::ParamFlags)
|
|
</DL>
|
|
<A NAME="lbBH"> </A>
|
|
<H3>paramspec = Glib::ParamSpec-><B>ulong</B> ($name, $nick, $blurb, $minimum, $maximum, $default_value, $flags)</H3>
|
|
|
|
|
|
|
|
|
|
|
|
<DL COMPACT>
|
|
<DT id="126">•<DD>
|
|
<TT>$name</TT> (string)
|
|
<DT id="127">•<DD>
|
|
<TT>$nick</TT> (string)
|
|
<DT id="128">•<DD>
|
|
<TT>$blurb</TT> (string)
|
|
<DT id="129">•<DD>
|
|
<TT>$minimum</TT> (unsigned)
|
|
<DT id="130">•<DD>
|
|
<TT>$maximum</TT> (unsigned)
|
|
<DT id="131">•<DD>
|
|
<TT>$default_value</TT> (unsigned)
|
|
<DT id="132">•<DD>
|
|
<TT>$flags</TT> (Glib::ParamFlags)
|
|
</DL>
|
|
<A NAME="lbBI"> </A>
|
|
<H3>paramspec = Glib::ParamSpec-><B>unichar</B> ($name, $nick, $blurb, $default_value, $flags)</H3>
|
|
|
|
|
|
|
|
|
|
|
|
<DL COMPACT>
|
|
<DT id="133">•<DD>
|
|
<TT>$name</TT> (string)
|
|
<DT id="134">•<DD>
|
|
<TT>$nick</TT> (string)
|
|
<DT id="135">•<DD>
|
|
<TT>$blurb</TT> (string)
|
|
<DT id="136">•<DD>
|
|
<TT>$default_value</TT> (character)
|
|
<DT id="137">•<DD>
|
|
<TT>$flags</TT> (Glib::ParamFlags)
|
|
</DL>
|
|
<A NAME="lbBJ"> </A>
|
|
<H3>string = $pspec-><B>get_value_type</B></H3>
|
|
|
|
|
|
|
|
|
|
|
|
<A NAME="lbBK"> </A>
|
|
<H3>bool = $paramspec-><B>value_validate</B> ($value)</H3>
|
|
|
|
|
|
|
|
|
|
|
|
<A NAME="lbBL"> </A>
|
|
<H3>(bool, newval) = $paramspec-><B>value_validate</B> ($value)</H3>
|
|
|
|
|
|
|
|
|
|
|
|
<DL COMPACT>
|
|
<DT id="138">•<DD>
|
|
<TT>$value</TT> (scalar)
|
|
</DL>
|
|
<P>
|
|
|
|
In scalar context return true if <TT>$value</TT> must be modified to be valid
|
|
for <TT>$paramspec</TT>, or false if it's valid already. In array context
|
|
return also a new value which is <TT>$value</TT> made valid.
|
|
<P>
|
|
|
|
<TT>$value</TT> must be the right type for <TT>$paramspec</TT> (with usual stringizing,
|
|
numizing, etc). <TT>"value_validate"</TT> 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.
|
|
<A NAME="lbBM"> </A>
|
|
<H3>integer = $pspec-><B>values_cmp</B> ($value1, $value2)</H3>
|
|
|
|
|
|
|
|
|
|
|
|
<DL COMPACT>
|
|
<DT id="139">•<DD>
|
|
<TT>$value1</TT> (scalar)
|
|
<DT id="140">•<DD>
|
|
<TT>$value2</TT> (scalar)
|
|
</DL>
|
|
<P>
|
|
|
|
Compares <I>value1</I> with <I>value2</I> according to <I>pspec</I>, and returns -1, 0 or
|
|
+1, if value1 is found to be less than, equal to or greater than value2,
|
|
respectively.
|
|
<A NAME="lbBN"> </A>
|
|
<H2>ENUMS AND FLAGS</H2>
|
|
|
|
|
|
|
|
<A NAME="lbBO"> </A>
|
|
<H3>flags Glib::ParamFlags</H3>
|
|
|
|
|
|
|
|
<DL COMPACT>
|
|
<DT id="141">•<DD>
|
|
'readable' / 'G_PARAM_READABLE'
|
|
<DT id="142">•<DD>
|
|
'writable' / 'G_PARAM_WRITABLE'
|
|
<DT id="143">•<DD>
|
|
'construct' / 'G_PARAM_CONSTRUCT'
|
|
<DT id="144">•<DD>
|
|
'construct-only' / 'G_PARAM_CONSTRUCT_ONLY'
|
|
<DT id="145">•<DD>
|
|
'lax-validation' / 'G_PARAM_LAX_VALIDATION'
|
|
<DT id="146">•<DD>
|
|
'private' / 'G_PARAM_PRIVATE'
|
|
</DL>
|
|
<A NAME="lbBP"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
|
|
|
|
Glib
|
|
<A NAME="lbBQ"> </A>
|
|
<H2>COPYRIGHT</H2>
|
|
|
|
|
|
|
|
Copyright (C) 2003-2011 by the gtk2-perl team.
|
|
<P>
|
|
|
|
This software is licensed under the <FONT SIZE="-1">LGPL.</FONT> See Glib for a full notice.
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="147"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="148"><A HREF="#lbAC">DESCRIPTION</A><DD>
|
|
<DT id="149"><A HREF="#lbAD">HIERARCHY</A><DD>
|
|
<DT id="150"><A HREF="#lbAE">METHODS</A><DD>
|
|
<DL>
|
|
<DT id="151"><A HREF="#lbAF">paramspec = Glib::ParamSpec-><B></B><FONT SIZE="-1"><B>IV</B></FONT><B></B> ($name, $nick, $blurb, $minimum, $maximum, $default_value, $flags)</A><DD>
|
|
<DT id="152"><A HREF="#lbAG">paramspec = Glib::ParamSpec-><B></B><FONT SIZE="-1"><B>UV</B></FONT><B></B> ($name, $nick, $blurb, $minimum, $maximum, $default_value, $flags)</A><DD>
|
|
<DT id="153"><A HREF="#lbAH">string = $pspec-><B>get_blurb</B></A><DD>
|
|
<DT id="154"><A HREF="#lbAI">paramspec = Glib::ParamSpec-><B>boolean</B> ($name, $nick, $blurb, $default_value, $flags)</A><DD>
|
|
<DT id="155"><A HREF="#lbAJ">paramspec = Glib::ParamSpec-><B>boxed</B> ($name, $nick, $blurb, $package, $flags)</A><DD>
|
|
<DT id="156"><A HREF="#lbAK">paramspec = Glib::ParamSpec-><B>char</B> ($name, $nick, $blurb, $minimum, $maximum, $default_value, $flags)</A><DD>
|
|
<DT id="157"><A HREF="#lbAL">scalar = $pspec-><B>get_default_value</B></A><DD>
|
|
<DT id="158"><A HREF="#lbAM">paramspec = Glib::ParamSpec-><B>double</B> ($name, $nick, $blurb, $minimum, $maximum, $default_value, $flags)</A><DD>
|
|
<DT id="159"><A HREF="#lbAN">paramspec = Glib::ParamSpec-><B>enum</B> ($name, $nick, $blurb, $enum_type, $default_value, $flags)</A><DD>
|
|
<DT id="160"><A HREF="#lbAO">paramspec = Glib::ParamSpec-><B>flags</B> ($name, $nick, $blurb, $flags_type, $default_value, $flags)</A><DD>
|
|
<DT id="161"><A HREF="#lbAP">paramflags = $pspec-><B>get_flags</B></A><DD>
|
|
<DT id="162"><A HREF="#lbAQ">paramspec = Glib::ParamSpec-><B>float</B> ($name, $nick, $blurb, $minimum, $maximum, $default_value, $flags)</A><DD>
|
|
<DT id="163"><A HREF="#lbAR">paramspec = Glib::ParamSpec-><B>gtype</B> ($name, $nick, $blurb, $is_a_type, $flags)</A><DD>
|
|
<DT id="164"><A HREF="#lbAS">paramspec = Glib::ParamSpec-><B>int</B> ($name, $nick, $blurb, $minimum, $maximum, $default_value, $flags)</A><DD>
|
|
<DT id="165"><A HREF="#lbAT">paramspec = Glib::ParamSpec-><B>int64</B> ($name, $nick, $blurb, $minimum, $maximum, $default_value, $flags)</A><DD>
|
|
<DT id="166"><A HREF="#lbAU">paramspec = Glib::ParamSpec-><B>long</B> ($name, $nick, $blurb, $minimum, $maximum, $default_value, $flags)</A><DD>
|
|
<DT id="167"><A HREF="#lbAV">string = $paramspec-><B>get_name</B></A><DD>
|
|
<DT id="168"><A HREF="#lbAW">string = $pspec-><B>get_nick</B></A><DD>
|
|
<DT id="169"><A HREF="#lbAX">paramspec = Glib::ParamSpec-><B>object</B> ($name, $nick, $blurb, $package, $flags)</A><DD>
|
|
<DT id="170"><A HREF="#lbAY">paramspec = Glib::ParamSpec-><B>override</B> ($name, $overridden)</A><DD>
|
|
<DT id="171"><A HREF="#lbAZ">string = $pspec-><B>get_owner_type</B></A><DD>
|
|
<DT id="172"><A HREF="#lbBA">paramspec = Glib::ParamSpec-><B>param_spec</B> ($name, $nick, $blurb, $package, $flags)</A><DD>
|
|
<DT id="173"><A HREF="#lbBB">paramspec or undef = $pspec-><B>get_redirect_target</B></A><DD>
|
|
<DT id="174"><A HREF="#lbBC">paramspec = Glib::ParamSpec-><B>scalar</B> ($name, $nick, $blurb, $flags)</A><DD>
|
|
<DT id="175"><A HREF="#lbBD">paramspec = Glib::ParamSpec-><B>string</B> ($name, $nick, $blurb, $default_value, $flags)</A><DD>
|
|
<DT id="176"><A HREF="#lbBE">paramspec = Glib::ParamSpec-><B>uchar</B> ($name, $nick, $blurb, $minimum, $maximum, $default_value, $flags)</A><DD>
|
|
<DT id="177"><A HREF="#lbBF">paramspec = Glib::ParamSpec-><B>uint</B> ($name, $nick, $blurb, $minimum, $maximum, $default_value, $flags)</A><DD>
|
|
<DT id="178"><A HREF="#lbBG">paramspec = Glib::ParamSpec-><B>uint64</B> ($name, $nick, $blurb, $minimum, $maximum, $default_value, $flags)</A><DD>
|
|
<DT id="179"><A HREF="#lbBH">paramspec = Glib::ParamSpec-><B>ulong</B> ($name, $nick, $blurb, $minimum, $maximum, $default_value, $flags)</A><DD>
|
|
<DT id="180"><A HREF="#lbBI">paramspec = Glib::ParamSpec-><B>unichar</B> ($name, $nick, $blurb, $default_value, $flags)</A><DD>
|
|
<DT id="181"><A HREF="#lbBJ">string = $pspec-><B>get_value_type</B></A><DD>
|
|
<DT id="182"><A HREF="#lbBK">bool = $paramspec-><B>value_validate</B> ($value)</A><DD>
|
|
<DT id="183"><A HREF="#lbBL">(bool, newval) = $paramspec-><B>value_validate</B> ($value)</A><DD>
|
|
<DT id="184"><A HREF="#lbBM">integer = $pspec-><B>values_cmp</B> ($value1, $value2)</A><DD>
|
|
</DL>
|
|
<DT id="185"><A HREF="#lbBN">ENUMS AND FLAGS</A><DD>
|
|
<DL>
|
|
<DT id="186"><A HREF="#lbBO">flags Glib::ParamFlags</A><DD>
|
|
</DL>
|
|
<DT id="187"><A HREF="#lbBP">SEE ALSO</A><DD>
|
|
<DT id="188"><A HREF="#lbBQ">COPYRIGHT</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:05:45 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|