1Gnome2::GConf::Schema(3U)ser Contributed Perl DocumentatiGonnome2::GConf::Schema(3)
2
3
4
6 Gnome2::GConf::Schema - Schema Objects for key description
7
9 $client->set_schema($key, {
10 owner => 'some_program',
11 short_desc => 'Some key.',
12 long_desc => 'A key that does something to some_program.',
13 locale => 'C',
14 type => 'int',
15 default_value => { type => 'int', value => 42 }
16 });
17 $description{'short'} = $client->get_schema($key)->{short_desc};
18
20 In C, "GConfSchema" is an opaque type for a "schema", that is a
21 collection of useful information about a key/value pair. It may contain
22 a description of the key, a default value, the program which owns the
23 key, etc.
24
25 In perl, it is represented using an hashref containing any of these
26 keys:
27
28 type
29 The type of the value the key points to. It's similar to the
30 corresponding 'type' key of "GConfValue", but it explicitly tags
31 lists and pairs using the 'list' and 'pair' types (the 'type' key
32 is just an indication of what should be expected inside the
33 "default_value" field).
34
35 default_value
36 The default value of the key. In C, this should be a "GConfValue",
37 so, in perl, it becomes an hashref (see Gnome2::GConf::Value)
38
39 short_desc
40 A string containing a short description (a phrase, no more) of the
41 key.
42
43 long_desc
44 A string containing a longer description (a paragraph or more) of
45 the key.
46
47 owner
48 A string containing the name of the program which uses ('owns') the
49 key to which the schema is bound.
50
51 locale
52 The locale for the three strings above (above strings are UTF-8,
53 and the locale is needed for translations purposes).
54
56 Gnome2::GConf(3pm), Gnome2::GConf::Value(3pm).
57
59 Gnome2::GConf
60
62 Copyright (C) 2003-2006 by the gtk2-perl team.
63
64 This software is licensed under the LGPL. See Gnome2::GConf for a full
65 notice.
66
67
68
69perl v5.32.0 2021-01-06 Gnome2::GConf::Schema(3)