=head1 NAME

Gnome2::GConf::Client

=head1 HIERARCHY

  Glib::Object
  +----Gnome2::GConf::Client

=for apidoc
=for signature list = $client->get_list($key)
=cut

=for apidoc
=for signature (car, cdr) = $client->get_pair($key)
=cut




=head1 METHODS

=head2 $client-E<gt>B<add_dir> ($dir, $preload)

=over

=over

=item * $dir (string) 

=item * $preload (Gnome2::GConf::ClientPreloadType) 

=back

=back

=head2 list = $client-E<gt>B<all_dirs> ($dir)

=over

=over

=item * $dir (string) 

=back

This method returns an array containing all the directories in a given directory.

=back

=head2 list = $client-E<gt>B<all_entries> ($dir)

=over

=over

=item * $dir (string) 

=back

This method returns an array containing all the entries of a given directory.

=back

=head2 boolean = $client-E<gt>B<get_bool> ($key)

=over

=over

=item * $key (string) 

=back

=back

=head2 boolean = $client-E<gt>B<set_bool> ($key, $val)

=over

=over

=item * $key (string) 

=item * $val (boolean) 

=back

=back

=head2 changeset>) = $client-E<gt>B<change_set_from_current> ($key, ...)

=over

=over

=item * ... (list) list of keys to add to the changeset

=back


Create a L<Gnome2::GConf::ChangeSet> from a list of keys inside the GConf
database.


=back

=head2 $client-E<gt>B<clear_cache> 

=over

=back

=head2 boolean = $client->B<commit_change_set> ($cs, $remove_committed)

=head2 (boolean, hash) = $client->B<commit_change_set> ($cs, $remove_committed)

=over

=over

=item * $cs (change set hash (see L<Gnome2::GConf::ChangeSet>)) 

=item * $remove_committed (boolean) 

=back


Commit a given L<Gnome2::GConf::ChangeSet>.  In scalar context, or if
I<$remove_committed> is FALSE, return a boolean value; otherwise, return the
boolean value and the L<Gnome2::GConf::ChangeSet> I<$cs>, pruned of the
successfully committed changes.


=back

=head2 value>) = $client-E<gt>B<get_default_from_schema> ($key)

=over

=over

=item * $key (string) 

=back

=back

=head2 client = Gnome2::GConf::Client-E<gt>B<get_default> 

=over

=back

=head2 boolean = $client-E<gt>B<dir_exists> ($dir)

=over

=over

=item * $dir (string) 

=back

=back

=head2 entry>) = $client-E<gt>B<get_entry> ($key, $locale, $use_schema_default)

=over

=over

=item * $key (string) 

=item * $locale (string) 

=item * $use_schema_default (boolean) 

=back

=back

=head2 list = $client-E<gt>B<error> ($error)

=over

=over

=item * $error (hash) a L<Glib::Error>

=back


You should not use this method.
This method emits the "error" signal.


=back

=head2 double = $client-E<gt>B<get_float> ($key)

=over

=over

=item * $key (string) 

=back

=back

=head2 boolean = $client-E<gt>B<set_float> ($key, $val)

=over

=over

=item * $key (string) 

=item * $val (double) 

=back

=back

=head2 value>) = $client-E<gt>B<get> ($key)

=over

=over

=item * $key (string) 

=back

Fetch the C<GConfValue> bound to the give I<$key>.

=back

=head2 $client-E<gt>B<set> ($key, $value)

=over

=over

=item * $key (string) 

=item * $value (value hash (see L<Gnome2::GConf::Value>)) 

=back

Set the C<GConfValue> I<$val> bound to the given I<$key>.

=back

=head2 integer = $client-E<gt>B<get_int> ($key)

=over

=over

=item * $key (string) 

=back

=back

=head2 boolean = $client-E<gt>B<set_int> ($key, $val)

=over

=over

=item * $key (string) 

=item * $val (integer) 

=back

=back

=head2 boolean = $client-E<gt>B<key_is_writable> ($key)

=over

=over

=item * $key (string) 

=back

=back

=head2 $client-E<gt>B<get_list> ($key)

=over

=over

=item * $key (string) 

=back

=back

=head2 boolean = $client-E<gt>B<set_list> ($key, $list_type, $list)

=over

=over

=item * $key (string) 

=item * $list_type (string) 

=item * $list (scalar) 

=back

=back

=head2 integer = $client-E<gt>B<notify_add> ($namespace_section, $func, $data=undef)

=over

=over

=item * $namespace_section (string) 

=item * $func (scalar) 

=item * $data (scalar) 

=back

=back

=head2 $client-E<gt>B<notify_remove> ($cnxn_id)

=over

=over

=item * $cnxn_id (integer) 

=back

=back

=head2 $client-E<gt>B<get_pair> ($key)

=over

=over

=item * $key (string) 

=back

=back

=head2 boolean = $client-E<gt>B<set_pair> ($key, $car, $cdr)

=over

=over

=item * $key (string) 

=item * $car (value hash (see L<Gnome2::GConf::Value>)) 

=item * $cdr (value hash (see L<Gnome2::GConf::Value>)) 

=back

=back

=head2 $client-E<gt>B<preload> ($dirname, $type)

=over

=over

=item * $dirname (string) 

=item * $type (Gnome2::GConf::ClientPreloadType) 

=back

=back

=head2 $client-E<gt>B<remove_dir> ($dir)

=over

=over

=item * $dir (string) 

=back

=back

=head2 changeset>) = $client-E<gt>B<reverse_change_set> ($cs)

=over

=over

=item * $cs (change set hash (see L<Gnome2::GConf::ChangeSet>)) 

=back


Reverse the given L<Gnome2::GConf::ChangeSet>.


=back

=head2 schema>) = $client-E<gt>B<get_schema> ($key)

=over

=over

=item * $key (string) 

=back

=back

=head2 boolean = $client-E<gt>B<set_schema> ($key, $schema)

=over

=over

=item * $key (string) 

=item * $schema (schema hash (see L<Gnome2::GConf::Schema>)) 

=back

=back

=head2 string = $client-E<gt>B<get_string> ($key)

=over

=over

=item * $key (string) 

=back

=back

=head2 boolean = $client-E<gt>B<set_string> ($key, $val)

=over

=over

=item * $key (string) 

=item * $val (string) 

=back

=back

=head2 $client-E<gt>B<suggest_sync> 

=over

=back

=head2 list = $client-E<gt>B<unreturned_error> ($error)

=over

=over

=item * $error (hash) a L<Glib::Error>

=back


You should not use this method.
This method emits the "unreturned-error" signal.


=back

=head2 boolean = $client-E<gt>B<unset> ($key)

=over

=over

=item * $key (string) 

=back

=back

=head2 list = $client-E<gt>B<value_changed> ($key, $value)

=over

=over

=item * $key (string) 

=item * $value (value hash (see L<Gnome2::GConf::Value>)) 

=back


You should not use this method.
This method emits the "value-changed" signal.


=back

=head2 value>) = $client-E<gt>B<get_without_default> ($key)

=over

=over

=item * $key (string) 

=back

=back


=head1 SIGNALS

=over

=item B<value-changed> (Gnome2::GConf::Client, string, gpointer)

=item B<unreturned-error> (Gnome2::GConf::Client, gpointer)

=item B<error> (Gnome2::GConf::Client, gpointer)

=back


=head1 ENUMS AND FLAGS

=head2 enum Gnome2::GConf::ClientPreloadType



=over

=item * 'preload-none' / 'GCONF_CLIENT_PRELOAD_NONE'

=item * 'preload-onelevel' / 'GCONF_CLIENT_PRELOAD_ONELEVEL'

=item * 'preload-recursive' / 'GCONF_CLIENT_PRELOAD_RECURSIVE'

=back



=head1 SEE ALSO

L<Gnome2::GConf>, L<Glib::Object>

=head1 COPYRIGHT

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

This software is licensed under the LGPL.  See L<Gnome2::GConf> for a full
notice.


=cut

