.\" 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::Engine 3pm"
.TH Gnome2::GConf::Engine 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::Engine \-  A Configuration Engine
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Gnome2::GConf::Engine is the Perl binding for the \f(CW\*(C`GConfEngine\*(C'\fR object.  A
GConfEngine is a configuration engine, that is a stack of config sources.
Normally, there's just one of these on the system.
.PP
Gnome2::GConf::Engine provides a low-level interface for accessing GConf data;
you should normally use a Gnome2::GConf::Client inside your code.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Gnome2::GConf(3pm), Gnome2::GConf::Value(3pm), Gnome2::GConf::ChangeSet(3pm).
.SH "HIERARCHY"
.IX Header "HIERARCHY"
.Vb 2
\&  Glib::Boxed
\&  +\-\-\-\-Gnome2::GConf::Engine
.Ve
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS "list = $engine\->\fBall_dirs\fP ($dir)"
.el .SS "list = \f(CW$engine\fP\->\fBall_dirs\fP ($dir)"
.IX Subsection "list = $engine->all_dirs ($dir)"
.IP "\(bu" 4
\&\f(CW$dir\fR (string)
.PP
This method returns an array containing all the directories in a given directory.
.ie n .SS "list = $engine\->\fBall_entries\fP ($dir)"
.el .SS "list = \f(CW$engine\fP\->\fBall_entries\fP ($dir)"
.IX Subsection "list = $engine->all_entries ($dir)"
.IP "\(bu" 4
\&\f(CW$dir\fR (string)
.PP
This method returns an array containing all the entries of a given directory.
.ie n .SS "boolean = $engine\->\fBassociate_schema\fP ($key, $schema_key)"
.el .SS "boolean = \f(CW$engine\fP\->\fBassociate_schema\fP ($key, \f(CW$schema_key\fP)"
.IX Subsection "boolean = $engine->associate_schema ($key, $schema_key)"
.IP "\(bu" 4
\&\f(CW$key\fR (string)
.IP "\(bu" 4
\&\f(CW$schema_key\fR (string)
.PP
Associate a schema to a key.
.PP
\&\f(CW$schema_key\fR should have a schema (if \f(CW$key\fR stores a value) or a dir full of
schemas (if \f(CW$key\fR stores a directory name)
.ie n .SS "changeset = $engine\->\fBchange_set_from_current\fP ($key, ...)"
.el .SS "changeset = \f(CW$engine\fP\->\fBchange_set_from_current\fP ($key, ...)"
.IX Subsection "changeset = $engine->change_set_from_current ($key, ...)"
.IP "\(bu" 4
\&... (list) list of keys to add to the changeset
.PP
Create a Gnome2::GConf::ChangeSet from a list of keys inside the GConf
database.
.ie n .SS "boolean = $engine\->\fBcommit_change_set\fP ($cs, $remove_committed)"
.el .SS "boolean = \f(CW$engine\fP\->\fBcommit_change_set\fP ($cs, \f(CW$remove_committed\fP)"
.IX Subsection "boolean = $engine->commit_change_set ($cs, $remove_committed)"
.ie n .SS "(boolean, changeset) = $engine\->\fBcommit_change_set\fP ($cs, $remove_committed)"
.el .SS "(boolean, changeset) = \f(CW$engine\fP\->\fBcommit_change_set\fP ($cs, \f(CW$remove_committed\fP)"
.IX Subsection "(boolean, changeset) = $engine->commit_change_set ($cs, $remove_committed)"
.IP "\(bu" 4
\&\f(CW$cs\fR (changeset)
.IP "\(bu" 4
\&\f(CW$remove_committed\fR (boolean)
.PP
Commit a given Gnome2::GConf::ChangeSet.  In scalar context, or if
\&\fI\f(CI$remove_committed\fI\fR is \s-1FALSE,\s0 return a boolean value; otherwise, return the
boolean value and the Gnome2::GConf::ChangeSet \fI\f(CI$cs\fI\fR, pruned of the
successfully committed changes.
.SS "engine = Gnome2::GConf::Engine\->\fBget_default\fP"
.IX Subsection "engine = Gnome2::GConf::Engine->get_default"
Get the default Gnome2::GConf::Engine.
.ie n .SS "boolean = $engine\->\fBdir_exists\fP ($dir)"
.el .SS "boolean = \f(CW$engine\fP\->\fBdir_exists\fP ($dir)"
.IX Subsection "boolean = $engine->dir_exists ($dir)"
.IP "\(bu" 4
\&\f(CW$dir\fR (string)
.SS "engine or undef = Gnome2::GConf::Engine\->\fBget_for_address\fP ($address)"
.IX Subsection "engine or undef = Gnome2::GConf::Engine->get_for_address ($address)"
.IP "\(bu" 4
\&\f(CW$address\fR (string)
.PP
Create a Gnome2::GConf::Engine for the given address.
.SS "engine or undef = Gnome2::GConf::Engine\->\fBget_for_addresses\fP (...)"
.IX Subsection "engine or undef = Gnome2::GConf::Engine->get_for_addresses (...)"
.IP "\(bu" 4
\&... (list)
.PP
Create a Gnome2::GConf::Engine for the given addresses.
.PP
Since: gconf 2.7
.ie n .SS "value = $engine\->\fBget\fP ($key)"
.el .SS "value = \f(CW$engine\fP\->\fBget\fP ($key)"
.IX Subsection "value = $engine->get ($key)"
.IP "\(bu" 4
\&\f(CW$key\fR (string)
.PP
Fetch and return the Gnome2::GConf::Value bound to the given \f(CW$key\fR.
.PP
This overrides Glib::Object's \f(CW\*(C`get\*(C'\fR, so you'll want to use
\&\f(CW\*(C`$object\->get_property\*(C'\fR to get object's properties.
.ie n .SS "boolean = $engine\->\fBset\fP ($key, $value)"
.el .SS "boolean = \f(CW$engine\fP\->\fBset\fP ($key, \f(CW$value\fP)"
.IX Subsection "boolean = $engine->set ($key, $value)"
.IP "\(bu" 4
\&\f(CW$key\fR (string)
.IP "\(bu" 4
\&\f(CW$value\fR (value)
.PP
Set the Gnome2::GConf::Value bound to the given key.
.ie n .SS "integer = $engine\->\fBnotify_add\fP ($namespace_section, $func, $data=undef)"
.el .SS "integer = \f(CW$engine\fP\->\fBnotify_add\fP ($namespace_section, \f(CW$func\fP, \f(CW$data\fP=undef)"
.IX Subsection "integer = $engine->notify_add ($namespace_section, $func, $data=undef)"
.IP "\(bu" 4
\&\f(CW$namespace_section\fR (string)
.IP "\(bu" 4
\&\f(CW$func\fR (scalar)
.IP "\(bu" 4
\&\f(CW$data\fR (scalar)
.ie n .SS "$engine\->\fBnotify_remove\fP ($cnxn_id)"
.el .SS "\f(CW$engine\fP\->\fBnotify_remove\fP ($cnxn_id)"
.IX Subsection "$engine->notify_remove ($cnxn_id)"
.IP "\(bu" 4
\&\f(CW$cnxn_id\fR (integer)
.ie n .SS "$engine\->\fBremove_dir\fP ($dir)"
.el .SS "\f(CW$engine\fP\->\fBremove_dir\fP ($dir)"
.IX Subsection "$engine->remove_dir ($dir)"
.IP "\(bu" 4
\&\f(CW$dir\fR (string)
.ie n .SS "changeset = $engine\->\fBreverse_change_set\fP ($cs)"
.el .SS "changeset = \f(CW$engine\fP\->\fBreverse_change_set\fP ($cs)"
.IX Subsection "changeset = $engine->reverse_change_set ($cs)"
.IP "\(bu" 4
\&\f(CW$cs\fR (changeset)
.PP
Create a change set that would revert the given change set for the given Gnome2::GConf::Engine.
.ie n .SS "$engine\->\fBsuggest_sync\fP"
.el .SS "\f(CW$engine\fP\->\fBsuggest_sync\fP"
.IX Subsection "$engine->suggest_sync"
.ie n .SS "boolean = $engine\->\fBunset\fP ($key)"
.el .SS "boolean = \f(CW$engine\fP\->\fBunset\fP ($key)"
.IX Subsection "boolean = $engine->unset ($key)"
.IP "\(bu" 4
\&\f(CW$key\fR (string)
.PP
Unset the given key.
.ie n .SS "value = $engine\->\fBget_with_locale\fP ($key, $locale)"
.el .SS "value = \f(CW$engine\fP\->\fBget_with_locale\fP ($key, \f(CW$locale\fP)"
.IX Subsection "value = $engine->get_with_locale ($key, $locale)"
.IP "\(bu" 4
\&\f(CW$key\fR (string)
.IP "\(bu" 4
\&\f(CW$locale\fR (string)
.PP
Fetch and return the Gnome2::GConf::Value bound to the given \f(CW$key\fR, for a
specific \f(CW$locale\fR.
.PP
Locale only matters if you are expecting to get a schema, or if you don't know
what you are expecting and it might be a schema. Note that 
Gnome2::GConf::Engine::get automatically uses the current locale, which is
normally what you want.
.ie n .SS "value = $engine\->\fBget_without_default\fP ($key)"
.el .SS "value = \f(CW$engine\fP\->\fBget_without_default\fP ($key)"
.IX Subsection "value = $engine->get_without_default ($key)"
.IP "\(bu" 4
\&\f(CW$key\fR (string)
.PP
Fetch the Gnome2::GConf::Value bound to the given key, without returning the
default value (specified inside the schema) if the key is unset.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Gnome2::GConf, Glib::Boxed
.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.