Gnome2::GConf::Schema (3)

Leading comments

Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man3/Gnome2::GConf::Schema.3pm".)

NAME

Gnome2::GConf::Schema - Schema Objects for key description

SYNOPSIS

  $client->set_schema($key, {
        owner           => 'some_program',
        short_desc      => 'Some key.',
        long_desc       => 'A key that does something to some_program.',
        locale          => 'C',
        type            => 'int',
        default_value => { type => 'int', value => 42 }
  });
  $description{'short'} = $client->get_schema($key)->{short_desc};

DESCRIPTION

In C, "GConfSchema" is an opaque type for a ``schema'', that is a collection of useful information about a key/value pair. It may contain a description of the key, a default value, the program which owns the key, etc.

In perl, it is represented using an hashref containing any of these keys:

type

The type of the value the key points to. It's similar to the corresponding 'type' key of "GConfValue", but it explicitly tags lists and pairs using the 'list' and 'pair' types (the 'type' key is just an indication of what should be expected inside the "default_value" field).

default_value

The default value of the key. In C, this should be a "GConfValue", so, in perl, it becomes an hashref (see Gnome2::GConf::Value)

short_desc

A string containing a short description (a phrase, no more) of the key.

long_desc

A string containing a longer description (a paragraph or more) of the key.

owner

A string containing the name of the program which uses ('owns') the key to which the schema is bound.

locale

The locale for the three strings above (above strings are

UTF-8,

and the locale is needed for translations purposes).

SEE ALSO

Gnome2::GConf(3pm), Gnome2::GConf::Value(3pm).

SEE ALSO

Gnome2::GConf

COPYRIGHT

Copyright (C) 2003-2006 by the gtk2-perl team.

This software is licensed under the

See Gnome2::GConf for a full notice.