Home News Features Download Screenshots Documentation Mailing Lists Links

Official FVWM Home Page FVWM - Perl library - FVWM::Module::Tk

FVWM::Module::Tk

NAME

SYNOPSIS

    #!/usr/bin/perl -w

    use lib `fvwm-perllib dir`;
    use FVWM::Module::Tk;
    use Tk;  # preferably in this order

    my $top = new MainWindow(-name => "Simple Test");
    my $id = $top->wrapper->[0];

    my $module = new FVWM::Module::Tk(
        TopWindow => $top,
        Mask => M_ICONIFY | M_ERROR,  # Mask may be omitted
        Debug => 2,
    );
    $top->Button(
        -text => "Close", -command => sub { $top->destroy; }
    )->pack;

    $module->addDefaultErrorHandler;
    $module->addHandler(M_ICONIFY, sub {
        my $id0 = $_[1]->_win_id;
        $module->send("Iconify off", $id) if $id0 == $id;
    });
    $module->track('Scheduler')->schedule(60, sub {
        $module->showMessage("You run this module for 1 minute")
    });

    $module->send('Style "*imple Test" Sticky');
    $module->eventLoop;

DESCRIPTION

This manual page details only those differences. For details on the API itself, see FVWM::Module.  

METHODS

new param-hash

$module = new FVWM::Module::Tk TopWindow => $top, %params

Create and return an object of the FVWM::Module::Tk class. This new method is identical to the (grand-)parent class method, with the exception that a Tk top-level of some sort (MainWindow, TopLevel, Frame, etc.) may be passed in the hash of options using the TopWindow named value. Other options in param-hash are the same as described in FVWM::Module.

If no top-level window is specified in the constructor, such dummy window is created and immediatelly withdrawn. This top-level window is needed to create Tk dialogs.

eventLoop

From outward appearances, this methods operates just as the parent eventLoop does. It is worth mentioning, however, that this version enters into the Tk MainLoop subroutine, ostensibly not to return.

showError msg [title]

This method creates a dialog box using the Tk widgets. The dialog has three buttons labeled ``Close'', ``Close All Errors'' and ``Exit Module''. Selecting the ``Close'' button closes the dialog. ``Close All Errors'' closes all error dialogs that may be open on the screen at that time. ``Exit Module'' terminates your entire module.

Good for diagnostics of a Tk based module.

showMessage msg [title]

Creates a message window with one ``Ok'' button.

Useful for notices by a Tk based module.

showDebug msg [title]

Creates a debug window with 3 buttons ``Close'', ``Clear'' and ``Save''. All debug messages are added to the debug window.

``Close'' withdraws the window until the next debug message arrives.

``Clear'' erases the current contents of the debug window.

``Save'' dumps the current contents of the debug window to the selected file.

Useful for debugging a Tk based module.

topWindow

Returns the Tk toplevel that this object was created with.

BUGS

AUTHOR

THANKS TO

Scott Smedley <ss@aao.gov.au>.

Nick Ing-Simmons <Nick.Ing-Simmons@tiuk.ti.com> for Tk Perl extension.  

SEE ALSO

Index

NAME

SYNOPSIS

DESCRIPTION

METHODS

BUGS

AUTHOR

THANKS TO

SEE ALSO

Last modified on August 26, 2005