.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "Gnome2::GConf::Value 3pm"
.TH Gnome2::GConf::Value 3pm "2017-07-22" "perl v5.26.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Gnome2::GConf::Value \-  Opaque datatype for generic values
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 7
\&  $client = Gnome2::GConf::Client\->get_default;
\&  $client\->set($config_key,
\&      {
\&        type  => \*(Aqstring\*(Aq,
\&        value => \*(AqHello, World\*(Aq,
\&      });
\&  print "The Meaning of Life." if ($client\->get($another_key)\->{value} == 42);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`GConfValue\*(C'\fR is a dynamic type similar to \f(CW\*(C`GValue\*(C'\fR,  and represents a value
that can be obtained from or stored in the configuration database; it contains
the value bound to a key, and its type.
.PP
In perl, it's an hashref containing these keys:
.IP "\fBtype\fR" 4
.IX Item "type"
The type of the data.  Fundamental types are 'string', 'int', 'float' and
\&'bool'.  Lists are handled by passing an arrayref as the payload of the \f(CW\*(C`value\*(C'\fR
key:
.Sp
.Vb 4
\&        $client\->set($key, { type => \*(Aqstring\*(Aq, value => \*(Aqsome string\*(Aq });
\&        $client\->set($key, { type => \*(Aqfloat\*(Aq,  value => 0.5           });
\&        $client\->set($key, { type => \*(Aqbool\*(Aq,   value => FALSE         });
\&        $client\->set($key, { type => \*(Aqint\*(Aq,    value => [0..15]       });
.Ve
.Sp
Pairs are handled by using the special type 'pair', and passing, in place
of the \f(CW\*(C`value\*(C'\fR key, the \f(CW\*(C`car\*(C'\fR and the \f(CW\*(C`cdr\*(C'\fR keys, each containing an hashref
representing a GConfValue:
.Sp
.Vb 5
\&        $client\->set($key, {
\&                        type => \*(Aqpair\*(Aq,
\&                        car  => { type => \*(Aqstring\*(Aq, value => \*(Aqsome string\*(Aq },
\&                        cdr  => { type => \*(Aqint\*(Aq,    value => 42            },
\&                });
.Ve
.Sp
This is needed since pairs might have different types; lists, instead, are of
the same type.
.IP "\fBvalue\fR" 4
.IX Item "value"
The payload, containing the value of type \f(CW\*(C`type\*(C'\fR.  It is used only for
fundamental types (scalars or lists).
.IP "\fBcar\fR, \fBcdr\fR" 4
.IX Item "car, cdr"
Special keys, that must be used only when working with the 'pair' type.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Gnome2::GConf(3pm), Gnome2::GConf::Entry(3pm), Gnome2::GConf::Schema(3pm),
Gnome2::GConf::ChangeSet(3pm).
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS "integer = $value_a\->\fBcompare\fP ($value_b)"
.el .SS "integer = \f(CW$value_a\fP\->\fBcompare\fP ($value_b)"
.IX Subsection "integer = $value_a->compare ($value_b)"
.IP "\(bu" 4
\&\f(CW$value_b\fR (value)
.PP
Since: gconf 2.13
.ie n .SS "string = $value\->\fBto_string\fP"
.el .SS "string = \f(CW$value\fP\->\fBto_string\fP"
.IX Subsection "string = $value->to_string"
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Gnome2::GConf
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2003\-2006 by the gtk2\-perl team.
.PP
This software is licensed under the \s-1LGPL.\s0  See Gnome2::GConf for a full
notice.