Gnome2::GConf::Client

NAME
DESCRIPTION
ERROR HANDLING
HIERARCHY
METHODS
SIGNALS
ENUMS AND FLAGS
SEE ALSO
COPYRIGHT

Gnome2::GConf::Client is a commodity class based on GObject used to access the default GConfEngine provided by the GConf daemon. It has a cache, finer-grained notification of changes and a default error handling mechanism.

ERROR HANDLING

In C, each fallible function has a GError optional argument: by setting it to a valid GError structure, the function will fill it in case of error; by passing a NULL value, the function will silently fail.

In Perl, each fallible method has a boolean check_error argument; by setting this argument to TRUE, the method will croak con failure, otherwise it will silently fail.

NOTE: To retain backward compatibility, the default behaviour is to check each error; that is, the check_error argument silently is set to TRUE.

In order to catch an error, you might use eval as a try...catch equivalent:

  eval { $s = $client->get_string($some_key); 1; };
  if (Glib::Error::matches($@, 'Gnome2::GConf::Error', 'bad-key'))
  {
    # recover from a bad-key error.
  }

On failure, if the error is unchecked, the unreturned_error signal will be fired by the Gnome2::GConf::Client object; the error signal will always be fired, whether the error is checked or not.

If you want to let the global error handler function catch just the unchecked error, use the Gnome2::GConf::Client::set_error_handling method, and attach a callback to the unreturned_error signal:

  $client->set_error_handling('handle-unreturned');
  $client->signal_connect(unreturned_error => sub {
      my ($client, $error) = @_;
      warn $error; # is a Glib::Error
    });

HIERARCHY

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

METHODS

$client->add_dir ($dir, $preload, $check_error=TRUE)

$dir (string)
$preload (Gnome2::GConf::ClientPreloadType)
$check_error (boolean)

list = $client->all_dirs($dir, $check_error=TRUE)

$dir (string)
$check_error (boolean)

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

list = $client->all_entries($dir, $check_error=TRUE)

$dir (string)
$check_error (boolean)

This method returns an array containing all the entries (as Gnome2::GConf::Entry) of a given directory.

boolean = $client->get_bool ($key, $check_error=TRUE)

$key (string)
$check_error (boolean)

boolean = $client->set_bool ($key, $val, $check_error=TRUE)

$key (string)
$val (boolean)
$check_error (boolean)

Returns FALSE on failure.

changeset = $client->change_set_from_current ($check_error=TRUE, $key, ...)

$check_error (boolean)
... (list) list of keys to add to the changeset

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

$client->clear_cache

boolean = $client->commit_change_set ($cs, $remove_committed, $check_error=TRUE)

(boolean, changeset) = $client->commit_change_set ($cs, $remove_committed, $check_error=TRUE)

$cs (changeset)
$remove_committed (boolean)
$check_error (boolean)

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