NAME

X11::Fvwm::Xforms - X11::Fvwm with the Xforms widget library attached

SYNOPSIS

use X11::Xforms;
use X11::Fvwm::Xforms;

fl_initialize("Xforms example");
$top = fl_bgn_form(...);
...
fl_end_form();
fl_show_form($top, ...);

$handle = new X11::Fvwm::Xforms $top;

$handle->initModule;

$handle->addHandler(M_CONFIGURE_WINDOW, \&configure_Toplevel);
$handle->addHandler(M_CONFIG_INFO, \&some_other_sub);

$handle->eventLoop;

$handle->endModule;

DESCRIPTION

The X11::Fvwm package is designed to provide access via Perl 5 to the module API of Fvwm 2. This code is based upon Fvwm 2.0.45 beta.

The X11::Fvwm::Xforms package is a sub-class of X11::Fvwm that overloads the methods new and eventLoop to manage Xforms GUI objects as well.

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

METHODS

Only those methods that are not available in X11::Fvwm, or are overloaded are covered here:

new

$self = new X11::Fvwm::Xforms $top, %params

Create and return an object of the X11::Fvwm::Xforms class. The return value is the blessed reference. This new method is identical to the parent class method, with the exception that a Xforms form object must be passed before the hash of options. The options themselves are as specified in X11::Fvwm. As Xforms does not necessarily require an object instance for most calls, this value can be passed as either an empty string or undef if it will not be needed in packet handlers. It is provided as a means of giving access to the top-most form to subroutines.

eventLoop

$self->eventLoop(@optional_args)

From outward appearances, this methods operates just as the parent eventLoop does. It is worth mentioning, however, that this version enters into the Xforms fl_do_forms subroutine, ostensibly not to return. Any arguments passed to eventLoop are passed along unmodified to fl_do_forms.

topform

$self->topform

Returns the Xforms form object that this object was created with. Unlike other instance variable-related methods, the form cannot be changed, so this method ignores any arguments passed to it.

Instance Variables

The following are instance variables not present in the parent class:

topForm

The Xforms object that was passed as the toplevel this object will use, should it need to call any Xforms routines (such as dialog creation). It is recommended that you use the access method topform instead of reading this directly.

EXAMPLES

Examples are provided in the scripts directory of the distribution. No Xforms-related examples are available yet.

BUGS

Would not surprise me in the least.

CAVEATS

In keeping with the UNIX philosophy, X11::Fvwm does not keep you from doing stupid things, as that would also keep you from doing clever things. What this means is that there are several areas with which you can hang your module or even royally confuse your running Fvwm process. This is due to flexibility, not bugs.

The X11::Xforms module itself is still in early development stages, and as such may be somewhat noisy if -w is used.

AUTHOR

Randy J. Ray <randy@byz.org>

ADDITIONAL THANKS TO

Martin Bartlett <martin@nitram.demon.co.uk>, who developed the X11::Xforms Perl extension.

SEE ALSO

For more information, see fvwm, X11::Fvwm and X11::Xforms