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), Gnome2::GConf::Change‐
20       Set(3pm).
21

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

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

SEE ALSO
162       Gnome2::GConf, Glib::Boxed
163

165       Copyright (C) 2003-2006 by the gtk2-perl team.
166
167       This software is licensed under the LGPL.  See Gnome2::GConf for a full
168       notice.
169
170
171
172perl v5.8.8                       2007-10-24          Gnome2::GConf::Engine(3)



        

    


            
        

        

            Impressum