Padre::Config::Human.3pm

Langue: en

Autres versions - même langue

Version: 2010-06-02 (ubuntu - 24/10/10)

Section: 3 (Bibliothèques de fonctions)

Sommaire

NAME

Padre::Config::Human - Padre configuration storing personal preferences

DESCRIPTION

This class implements the personal preferences of Padre's users. See Padre::Config for more information on the various types of preferences supported by Padre.

All human settings are stored in a hash as top-level keys (no hierarchy). The hash is then dumped in config.yml, a YAML file in Padre's preferences directory (see Padre::Config).

PUBLIC API

Constructors

create
     my $config = Padre::Config::Human->create;

Create and return an empty user configuration. (Almost empty, since it will still store the configuration schema revision - see ``version'').

No parameters.

read
     my $config = Padre::Config::Human->read;

Load & return the user configuration from the YAML file. Return "undef" in case of failure.

No parameters.

Object methods

version
     my $revision = $config->version;

Return the configuration schema revision. Indeed, we might want to have more structured configuration instead of a plain hash later on. Note that this version is stored with the other user preferences at the same level.

No parameters.

write
     $config->write;

(Over-)write user configuration to the YAML file.

No parameters.

Copyright 2008-2010 The Padre development team as listed in Padre.pm.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl 5 itself.