NAME

DESCRIPTION

METHODS

_init(App:PFM::Application $pfm, App::PFM::Screen $screen, string $pfm_version)

Initializes new instances. Called from the constructor.

_parse_colorsets()

Parses the colorsets defined in the .pfmrc.

_ask_to_backup(string $message)

Prompts for confirmation to backup the current .pfmrc and work on a new one.

configfilename( [ string $filename ] )

Getter/setter for the current filename of the .pfmrc file.

pfmrc( [ hashref $pfmrc ] )

Getter/setter for the _pfmrc member variable holding the config options.

text( [ arrayref $lines ] )

Getter/setter for the member variable holding the unparsed text of the config file.

your_commands()

Getter for the keys of the Your commands in the config file.

your(char $key)

Getter for a specific Your command from the config file.

location()

Returns a message string for the user indicating which .pfmrc is currently being used.

read(bool $firstread)

Reads in the .pfmrc file. If none exists, a default .pfmrc is written. The firstread variable ensures that the message "Your config file may be outdated" is given only once. If the config file is outdated, offer to update it (see App::PFM::Config::Update).

parse()

Processes the settings from the .pfmrc file. Most options are fetched into member variables. Those that aren't, remain accessable in the hash member "$config->{_pfmrc}".

write_default()

Writes a default config file. Creates the default containing directory (~/.pfm) if does not exist. An existing config file will be clobbered.

backup()

Creates a backup of the current config file, e.g. .pfmrc.20100901T231201.

write_text()

Creates a new config file by writing the raw text to it.

read_bookmarks()

Reads the bookmarks file. Fails silently if the bookmarks file cannot be read.

write_bookmarks( [ bool $finishing [, bool $silent ] ] )

Writes the states to the bookmarks file. Reports an error if the bookmarks file cannot be written.

The argument finishing indicates that the final message should be shown without delay.

The argument silent suppresses output and may be used for testing.

on_shutdown( [ bool $silent ] )

Called when the application is shutting down. Writes the bookmarks to file if so indicated by the config.

The silent argument suppresses output and may be used for testing if the application shuts down correctly.

EVENTS

after_parse_usecolor

Called when the 'usecolor' setting of the config file has been parsed. This allows the caller to show a colored message on screen while the rest of the config file is being parsed.

SEE ALSO