1GConf(3)              User Contributed Perl Documentation             GConf(3)
2
3
4

NAME

6       Gnome2::GConf - (DEPRECATED) Perl wrappers for the GConf configuration
7       engine.
8

SYNOPSIS

10         use Gnome2::GConf;
11
12         my $client = Gnome2::GConf::Client->get_default;
13         my $app_key = "/apps/myapp/mykey";
14
15         $client->add_dir($app_key, 'preload-none');
16
17         # add a notify for the key
18         my $notify_id = $client->notify_add($app_key, sub {
19             my ($client, $cnxn_id, $entry) = @_;
20             return unless $entry->{value};
21
22             if ($entry->{value}->{type} eq 'string') {
23               printf "key '%s' changed to '%s'\n",
24                      $entry->{key},
25                      $entry->{value}->{value};
26             }
27           });
28
29         my $string = $client->get_string($app_key);
30         $string = 'some string' unless $string;
31
32         $client->set($app_key, { type => 'string', data => $string });
33
34         # set a schema for the key
35         $client->set_schema ($app_key,
36             {
37               type => 'string',
38               locale => 'C',
39               short_desc => 'Some key.',
40               long_desc => 'This key does something.',
41               owner => 'some_program'
42             });
43
44         # remove the notification callback
45         $client->notify_remove($notify_id);
46

ABSTRACT

48       (DEPRECATED) Perl bindings to the 2.2 series of the GConf configuration
49       engine libraries, for use with gtk2-perl.
50

DESCRIPTION

52       NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE
53
54       This module has been deprecated by the Gtk-Perl project.  This means
55       that the module will no longer be updated with security patches, bug
56       fixes, or when changes are made in the Perl ABI.  The Git repo for this
57       module has been archived (made read-only), it will no longer possible
58       to submit new commits to it.  You are more than welcome to ask about
59       this module on the Gtk-Perl mailing list, but our priorities going
60       forward will be maintaining Gtk-Perl modules that are supported and
61       maintained upstream; this module is neither.
62
63       Since this module is licensed under the LGPL v2, you may also fork this
64       module, if you wish, but you will need to use a different name for it
65       on CPAN, and the Gtk-Perl team requests that you use your own resources
66       (mailing list, Git repos, bug trackers, etc.) to maintain your fork
67       going forward.
68
69       •   Perl URL: https://gitlab.gnome.org/GNOME/perl-gnome2-gconf
70
71       •   Upstream URL: https://gitlab.gnome.org/Archive/gconf
72
73       •   Last upstream version: 3.2.6
74
75       •   Last upstream release date: 2013-01-21
76
77       •   Migration path for this module: Glib::IO::Settings
78
79       •   Migration module URL: https://metacpan.org/pod/Glib::IO
80
81       NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE
82
83       This module allows you to use the GConf configuration system in order
84       to store/retrieve the configuration of an application.  The GConf
85       system is a powerful configuration manager based on a user daemon that
86       handles a set of key and value pairs, and notifies any changes of the
87       value to every program that monitors those keys.  GConf is used by
88       GNOME 2.x.
89
90       To discuss gtk2-perl, ask questions and flame/praise the authors, join
91       gtk-perl-list@gnome.org at lists.gnome.org.
92
93       Find out more about Gnome at http://www.gnome.org.
94

DIFFERENT DATA TYPES

96       Some opaque data types in GConf are not registered inside the Glib type
97       system.  Thus, they have been implemented in a more perlish way, when
98       possible, for the sake of coherency and following the principle of
99       least surprise for the perl developer.  These changes try to preserve
100       semantics, to add syntactic sugar and to remove the need for accessor
101       methods.
102
103       GConfEntry
104           See Gnome2::GConf::Entry
105
106       GConfValue
107           See Gnome2::GConf::Value
108
109       GConfChangeSet
110           See Gnome2::GConf::ChangeSet
111
112       GConfSchema
113           See Gnome2::GConf::Schema
114

DIFFERENT CALL SIGNATURES

116       Reflecting the changes operated for the data types, some methods that
117       use those type have had the call signature modified.
118
119       GConfNotifyFunc
120           In C, the function passed to "Gnome2::GConf::notify_add" must have
121           the following signature:
122
123                   void (GConfNotifyFunc *) (GConfClient * client,
124                                             guint cnxn_id,
125                                             GConfEntry * entry);
126
127           Where "GConfEntry" is a container for the key/value pair.  Since in
128           perl there's no "GConfEntry" (see above), the "entry" parameter is
129           an hashref.
130
131       GConfClient::get
132       GConfClient::set
133           In C, these accessor methods return/use a "GConfValue".  In perl,
134           they return/use an hashref.  See Gnome2::GConf::Value
135
136       GConfClient::get_list
137       GConfClient::set_list
138           These accessor methods use a string for setting the type of the
139           lists (lists may have values of only one type), and an arrayref
140           containing the values.
141
142       GConfClient::get_pair
143       GConfClient::set_pair
144           These accessor methods use two hashref (representing "GConfValue"s)
145           for the "car" and the "cdr" parameters.
146
147       GConfClient::get_schema
148       GConfClient::set_schema
149           Similarly to the get/set pair above, these two methods return/use
150           an hashref. See Gnome2::GConf::Schema.
151
152       GConfClient::commit_change_set
153           In C, this method return a boolean value (TRUE on success, FALSE on
154           failure). On user request (using the boolean parameter
155           "remove_committed"), it also returns the "GConfChangeSet", pruned
156           of the successfully committed keys.  In perl, this method returns a
157           boolean value both in scalar context or if the user sets to FALSE
158           the "remove_committed" parameter; in array context or if the user
159           requests the uncommitted keys, returns both the return value and
160           the pruned "GConfChangeSet".
161

SEE ALSO

163       perl(1), Glib(3pm).
164

AUTHOR

166       Emmanuele Bassi <ebassi@gmail.com>
167
168       gtk2-perl created by the gtk2-perl team: http://gtk2-perl.sf.net
169

COPYRIGHT AND LICENSE

171       Copyright 2003-2006 by Emmanuele Bassi
172
173       This library is free software; you can redistribute it and/or modify it
174       under the terms of the GNU Library General Public License as published
175       by the Free Software Foundation; either version 2 of the License, or
176       (at your option) any later version.
177
178       This library is distributed in the hope that it will be useful, but
179       WITHOUT ANY WARRANTY; without even the implied warranty of
180       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
181       Library General Public License for more details.
182
183       You should have received a copy of the GNU Library General Public
184       License along with this library; if not, see
185       <https://www.gnu.org/licenses/>.
186
187
188
189perl v5.34.0                      2022-01-21                          GConf(3)