/usr/lib/perl5/Gnome2/GConf/Engine.pod is in libgnome2-gconf-perl 1.044-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 | =head1 NAME
Gnome2::GConf::Engine - A Configuration Engine
=cut
=for position SYNOPSIS
=head1 SYNOPSIS
=cut
=for position DESCRIPTION
=head1 DESCRIPTION
Gnome2::GConf::Engine is the Perl binding for the C<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.
=for see_also
=head1 SEE ALSO
L<Gnome2::GConf>(3pm), L<Gnome2::GConf::Value>(3pm), L<Gnome2::GConf::ChangeSet>(3pm).
=cut
=head1 HIERARCHY
Glib::Boxed
+----Gnome2::GConf::Engine
=cut
=for object Gnome2::GConf::Engine A Configuration Engine
=cut
=head1 METHODS
=head2 list = $engine-E<gt>B<all_dirs> ($dir)
=over
=item * $dir (string)
=back
This method returns an array containing all the directories in a given directory.
=head2 list = $engine-E<gt>B<all_entries> ($dir)
=over
=item * $dir (string)
=back
This method returns an array containing all the entries of a given directory.
=head2 boolean = $engine-E<gt>B<associate_schema> ($key, $schema_key)
=over
=item * $key (string)
=item * $schema_key (string)
=back
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)
=head2 changeset = $engine-E<gt>B<change_set_from_current> ($key, ...)
=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.
=head2 boolean = $engine->B<commit_change_set> ($cs, $remove_committed)
=head2 (boolean, changeset) = $engine->B<commit_change_set> ($cs, $remove_committed)
=over
=item * $cs (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.
=head2 engine = Gnome2::GConf::Engine-E<gt>B<get_default>
Get the default Gnome2::GConf::Engine.
=head2 boolean = $engine-E<gt>B<dir_exists> ($dir)
=over
=item * $dir (string)
=back
=head2 engine or undef = Gnome2::GConf::Engine-E<gt>B<get_for_address> ($address)
=over
=item * $address (string)
=back
Create a Gnome2::GConf::Engine for the given address.
=head2 engine or undef = Gnome2::GConf::Engine-E<gt>B<get_for_addresses> (...)
=over
=item * ... (list)
=back
Create a Gnome2::GConf::Engine for the given addresses.
Since: gconf 2.7
=head2 value = $engine-E<gt>B<get> ($key)
=over
=item * $key (string)
=back
Fetch and return the Gnome2::GConf::Value bound to the given $key.
This overrides Glib::Object's C<get>, so you'll want to use
C<< $object->get_property >> to get object's properties.
=head2 boolean = $engine-E<gt>B<set> ($key, $value)
=over
=item * $key (string)
=item * $value (value)
=back
Set the Gnome2::GConf::Value bound to the given key.
=head2 integer = $engine-E<gt>B<notify_add> ($namespace_section, $func, $data=undef)
=over
=item * $namespace_section (string)
=item * $func (scalar)
=item * $data (scalar)
=back
=head2 $engine-E<gt>B<notify_remove> ($cnxn_id)
=over
=item * $cnxn_id (integer)
=back
=head2 $engine-E<gt>B<remove_dir> ($dir)
=over
=item * $dir (string)
=back
=head2 changeset = $engine-E<gt>B<reverse_change_set> ($cs)
=over
=item * $cs (changeset)
=back
Create a change set that would revert the given change set for the given L<Gnome2::GConf::Engine>.
=head2 $engine-E<gt>B<suggest_sync>
=head2 boolean = $engine-E<gt>B<unset> ($key)
=over
=item * $key (string)
=back
Unset the given key.
=head2 value = $engine-E<gt>B<get_with_locale> ($key, $locale)
=over
=item * $key (string)
=item * $locale (string)
=back
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.
=head2 value = $engine-E<gt>B<get_without_default> ($key)
=over
=item * $key (string)
=back
Fetch the Gnome2::GConf::Value bound to the given key, without returning the
default value (specified inside the schema) if the key is unset.
=cut
=head1 SEE ALSO
L<Gnome2::GConf>, L<Glib::Boxed>
=cut
=head1 COPYRIGHT
Copyright (C) 2003-2006 by the gtk2-perl team.
This software is licensed under the LGPL. See L<Gnome2::GConf> for a full
notice.
=cut
|