Home

News

Features

Download

Screenshots

Documentation

Mailing Lists

Links

Official FVWM Home Page

FVWM - Perl library - FVWM::Tracker::ModuleConfig

FVWM::Tracker::ModuleConfig

Section: FVWM Perl library (3)
Updated: 2005-08-24
Source: FVWM/Tracker/ModuleConfig.pm
This page contents - Return to main index

DESCRIPTION

This is a subclass of FVWM::Tracker that enables to read the module configuration. The module configuration is usually represented using a hash, but it may be represented as array of lines too.

This tracker defines the following observables:

    "config line added"

SYNOPSYS

Using FVWM::Module $module object:

    my $configTracker = $module->track("ModuleConfig");
    my $configHash = $configTracker->data;
    my $font = $configHash->{Font} || 'fixed';

or:

    my $configTracker = $module->track(
        "ModuleConfig", DefaultConfig => { Font => 'fixed' } );
    my $font = $configTracker->data('Font');

NEW METHODS

init params: Makes it possible to change the parameters of this tracker on the fly. Use with caution. See new method for the description of the params hash.

OVERRIDDEN METHODS

new module params

It is possible to specify additional parameters that this tracker understands.

    ConfigType     - string "hash" (default) or "array"
    ModuleName     - module to query, the default is $module->name
    LineFilter     - "asis", "spacefree" (default), "lowerkeys", "upperkeys"
    DefaultConfig  - the config hash/array of config to initially use

data [line-key-or-number]

Returns either array ref of configuration hash refs, or one hash ref if line-key-or-number is given.

Returns undef if the configuration line for line-key-or-number is not defined.

dump [line-key-or-number]

Works similarly to data, but returns one or many debug lines.

Returns an empty string if no module configuration is defined.

AUTHOR

Mikhael Goikhman <migo@homemail.com>.

This document was created by man2html, using the manual pages.
Time: 00:51:33 GMT, August 27, 2005

Last modified on August 26, 2005