1Padre::Config(3)      User Contributed Perl Documentation     Padre::Config(3)
2
3
4

NAME

6       Padre::Config - Configuration subsystem for Padre
7

SYNOPSIS

9           use Padre::Config;
10           [...]
11           if ( Padre::Config->main_statusbar ) { [...] }
12

DESCRIPTION

14       This module not only stores the complete Padre configuration, it also
15       holds the functions for loading and saving the configuration.
16
17       The Padre configuration lives in two places:
18
19       a user-editable text file usually called config.yml
20       an SQLite database which shouldn't be edited by the user
21
22   Generic usage
23       Every setting is accessed by a mutator named after it, i.e. it can be
24       used both as a getter and a setter depending on the number of arguments
25       passed to it.
26
27   Different types of settings
28       Padre needs to store different settings. Those preferences are stored
29       in different places depending on their impact. But "Padre::Config"
30       allows to access them with a unified API (a mutator). Only their
31       declaration differs in the module.
32
33       Here are the various types of settings that "Padre::Config" can manage:
34
35       ·   User settings
36
37           Those settings are general settings that relates to user
38           preferences. They range from general user interface look & feel
39           (whether to show the line numbers, etc.)  to editor preferences
40           (tab width, etc.) and other personal settings.
41
42           Those settings are stored in a YAML file, and accessed with
43           "Padre::Config::Human".
44
45       ·   Host settings
46
47           Those preferences are related to the host on which Padre is run.
48           The principal example of those settings are window appearance.
49
50           Those settings are stored in a DB file, and accessed with
51           "Padre::Config::Host".
52
53       ·   Project settings
54
55           Those preferences are related to the project of the file you are
56           currently editing. Examples of those settings are whether to use
57           tabs or spaces, etc.
58
59           Those settings are accessed with "Padre::Config::Project".
60

ADDING CONFIGURATION OPTIONS

62       Add a "setting()" - call to the correct section of this file.
63
64       The setting() call initially creates the option and defines some
65       metadata like the type of the option, it's living place and the default
66       value which should be used until the user configures a own value.
67

69       Copyright 2008-2011 The Padre development team as listed in Padre.pm.
70
71       This program is free software; you can redistribute it and/or modify it
72       under the same terms as Perl 5 itself.
73
74
75
76perl v5.28.0                      2011-08-16                  Padre::Config(3)
Impressum