1Gnome2::GConf::Engine(3U)ser Contributed Perl DocumentatiGonnome2::GConf::Engine(3)
2
3
4

NAME

6       Gnome2::GConf::Engine -  A Configuration Engine
7

SYNOPSIS

DESCRIPTION

10       Gnome2::GConf::Engine is the Perl binding for the "GConfEngine" object.
11       A GConfEngine is a configuration engine, that is a stack of config
12       sources.  Normally, there's just one of these on the system.
13
14       Gnome2::GConf::Engine provides a low-level interface for accessing
15       GConf data; you should normally use a Gnome2::GConf::Client inside your
16       code.
17

SEE ALSO

19       Gnome2::GConf(3pm), Gnome2::GConf::Value(3pm),
20       Gnome2::GConf::ChangeSet(3pm).
21

HIERARCHY

23         Glib::Boxed
24         +----Gnome2::GConf::Engine
25

METHODS

27   list = $engine->all_dirs ($dir)
28           ·   $dir (string)
29
30           This method returns an array containing all the directories in a
31           given directory.
32
33   list = $engine->all_entries ($dir)
34           ·   $dir (string)
35
36           This method returns an array containing all the entries of a given
37           directory.
38
39   boolean = $engine->associate_schema ($key, $schema_key)
40           ·   $key (string)
41
42           ·   $schema_key (string)
43
44           Associate a schema to a key.
45
46           $schema_key should have a schema (if $key stores a value) or a dir
47           full of schemas (if $key stores a directory name)
48
49   changeset = $engine->change_set_from_current ($key, ...)
50           ·   ... (list) list of keys to add to the changeset
51
52           Create a Gnome2::GConf::ChangeSet from a list of keys inside the
53           GConf database.
54
55   boolean = $engine->commit_change_set ($cs, $remove_committed)
56   (boolean, changeset) = $engine->commit_change_set ($cs, $remove_committed)
57           ·   $cs (changeset)
58
59           ·   $remove_committed (boolean)
60
61           Commit a given Gnome2::GConf::ChangeSet.  In scalar context, or if
62           $remove_committed is FALSE, return a boolean value; otherwise,
63           return the boolean value and the Gnome2::GConf::ChangeSet $cs,
64           pruned of the successfully committed changes.
65
66   engine = Gnome2::GConf::Engine->get_default
67           Get the default Gnome2::GConf::Engine.
68
69   boolean = $engine->dir_exists ($dir)
70           ·   $dir (string)
71
72   engine or undef = Gnome2::GConf::Engine->get_for_address ($address)
73           ·   $address (string)
74
75           Create a Gnome2::GConf::Engine for the given address.
76
77   engine or undef = Gnome2::GConf::Engine->get_for_addresses (...)
78           ·   ... (list)
79
80           Create a Gnome2::GConf::Engine for the given addresses.
81
82           Since: gconf 2.7
83
84   value = $engine->get ($key)
85           ·   $key (string)
86
87           Fetch and return the Gnome2::GConf::Value bound to the given $key.
88
89           This overrides Glib::Object's "get", so you'll want to use
90           "$object->get_property" to get object's properties.
91
92   boolean = $engine->set ($key, $value)
93           ·   $key (string)
94
95           ·   $value (value)
96
97           Set the Gnome2::GConf::Value bound to the given key.
98
99   boolean = $engine->key_is_writable ($key)
100           ·   $key (string)
101
102   integer = $engine->notify_add ($namespace_section, $func, $data=undef)
103           ·   $namespace_section (string)
104
105           ·   $func (scalar)
106
107           ·   $data (scalar)
108
109   $engine->notify_remove ($cnxn_id)
110           ·   $cnxn_id (integer)
111
112   $engine->remove_dir ($dir)
113           ·   $dir (string)
114
115   changeset = $engine->reverse_change_set ($cs)
116           ·   $cs (changeset)
117
118           Create a change set that would revert the given change set for the
119           given Gnome2::GConf::Engine.
120
121   $engine->suggest_sync
122   boolean = $engine->unset ($key)
123           ·   $key (string)
124
125           Unset the given key.
126
127   value = $engine->get_with_locale ($key, $locale)
128           ·   $key (string)
129
130           ·   $locale (string)
131
132           Fetch and return the Gnome2::GConf::Value bound to the given $key,
133           for a specific $locale.
134
135           Locale only matters if you are expecting to get a schema, or if you
136           don't know what you are expecting and it might be a schema. Note
137           that Gnome2::GConf::Engine::get automatically uses the current
138           locale, which is normally what you want.
139
140   value = $engine->get_without_default ($key)
141           ·   $key (string)
142
143           Fetch the Gnome2::GConf::Value bound to the given key, without
144           returning the default value (specified inside the schema) if the
145           key is unset.
146

SEE ALSO

148       Gnome2::GConf, Glib::Boxed
149

COPYRIGHT

151       Copyright (C) 2003-2006 by the gtk2-perl team.
152
153       This software is licensed under the LGPL.  See Gnome2::GConf for a full
154       notice.
155
156
157
158perl v5.12.0                      2010-05-12          Gnome2::GConf::Engine(3)