Gnome2::GConf::Engine (3)

Leading comments

Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man3/Gnome2::GConf::Engine.3pm".)

NAME

Gnome2::GConf::Engine - A Configuration Engine

SYNOPSIS

DESCRIPTION

Gnome2::GConf::Engine is the Perl binding for the "GConfEngine" object. A GConfEngine is a configuration engine, that is a stack of config sources. Normally, there's just one of these on the system.

Gnome2::GConf::Engine provides a low-level interface for accessing GConf data; you should normally use a Gnome2::GConf::Client inside your code.

SEE ALSO

Gnome2::GConf(3pm), Gnome2::GConf::Value(3pm), Gnome2::GConf::ChangeSet(3pm).

HIERARCHY

  Glib::Boxed
  +----Gnome2::GConf::Engine

METHODS

list = $engine->all_dirs ($dir)

*

$dir (string)

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

list = $engine->all_entries ($dir)

*

$dir (string)

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

boolean = $engine->associate_schema ($key, $schema_key)

*

$key (string)

*

$schema_key (string)

Associate a schema to a key.

$schema_key should have a schema (if $key stores a value) or a dir full of schemas (if $key stores a directory name)

changeset = $engine->change_set_from_current ($key, ...)

*

... (list) list of keys to add to the changeset

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

boolean = $engine->commit_change_set ($cs, $remove_committed)

(boolean, changeset) = $engine->commit_change_set ($cs, $remove_committed)

*

$cs (changeset)

*

$remove_committed (boolean)

Commit a given Gnome2::GConf::ChangeSet. In scalar context, or if $remove_committed is

return a boolean value; otherwise, return the boolean value and the Gnome2::GConf::ChangeSet $cs, pruned of the successfully committed changes.

engine = Gnome2::GConf::Engine->get_default

Get the default Gnome2::GConf::Engine.

boolean = $engine->dir_exists ($dir)

*

$dir (string)

engine or undef = Gnome2::GConf::Engine->get_for_address ($address)

*

$address (string)

Create a Gnome2::GConf::Engine for the given address.

engine or undef = Gnome2::GConf::Engine->get_for_addresses (...)

*

... (list)

Create a Gnome2::GConf::Engine for the given addresses.

Since: gconf 2.7

value = $engine->get ($key)

*

$key (string)

Fetch and return the Gnome2::GConf::Value bound to the given $key.

This overrides Glib::Object's "get", so you'll want to use "$object->get_property" to get object's properties.

boolean = $engine->set ($key, $value)

*

$key (string)

*

$value (value)

Set the Gnome2::GConf::Value bound to the given key.

integer = $engine->notify_add ($namespace_section, $func, $data=undef)

*

$namespace_section (string)

*

$func (scalar)

*

$data (scalar)

$engine->notify_remove ($cnxn_id)

*

$cnxn_id (integer)

$engine->remove_dir ($dir)

*

$dir (string)

changeset = $engine->reverse_change_set ($cs)

*

$cs (changeset)

Create a change set that would revert the given change set for the given Gnome2::GConf::Engine.

$engine->suggest_sync

boolean = $engine->unset ($key)

*

$key (string)

Unset the given key.

value = $engine->get_with_locale ($key, $locale)

*

$key (string)

*

$locale (string)

Fetch and return the Gnome2::GConf::Value bound to the given $key, for a specific $locale.

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.

value = $engine->get_without_default ($key)

*

$key (string)

Fetch the Gnome2::GConf::Value bound to the given key, without returning the default value (specified inside the schema) if the key is unset.

SEE ALSO

Gnome2::GConf, Glib::Boxed

COPYRIGHT

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

This software is licensed under the

See Gnome2::GConf for a full notice.