NAME

PDL::Graphics::Prima::ReadLine - allowing Prima and Term::ReadLine to play together

SYNOPSIS

This module's primary functionality is invoked when you use either of these two modules from within your pdl shell:

use PDL::Graphics::Prima;

or

use PDL::Graphics::Prima::Simple;

If you are not using this from within the pdl shell and need to supply your own readline object, you can manually invoke the module and supply it as one of the arguments like so:

BEGIN {
  ... get $readline object ...
}
use PDL::Graphics::Prima::ReadLine ($readline_obj);

If you don't want to fiddle with a BEGIN block, you can say this:

... get $readline_obj ...
require PDL::Graphics::Prima::ReadLine;
PDL::Graphics::Prima::ReadLine->import($readline_obj);

DESCRIPTION

Recent versions of Term::ReadLine (v1.09 and higher) add support for arbitrary event loops. This means that it is possible to add the Prima event loop to the readline, letting you simultaneously interact with a plot and type commands into the terminal.

This module is idempotent, which means you can invoke it multiple times without any trouble. The first invocation of the class's import method is guaranteed to either set up the event loop or die.

AUTHOR

David Mertens (dcmertens.perl@gmail.com)

SEE ALSO

For an introduction to Prima see Prima::tutorial.

This is a component of PDL::Graphics::Prima, a library composed of many modules:

PDL::Graphics::Prima

Defines the Plot widget for use in Prima applications

PDL::Graphics::Prima::Axis

Specifies the behavior of axes (but not the scaling)

PDL::Graphics::Prima::DataSet

Specifies the behavior of DataSets

PDL::Graphics::Prima::Internals

A dumping ground for my partial documentation of some of the more complicated stuff. It's not organized, so you probably shouldn't read it.

PDL::Graphics::Prima::Limits

Defines the lm:: namespace

PDL::Graphics::Prima::Palette

Specifies a collection of different color palettes

PDL::Graphics::Prima::PlotType

Defines the different ways to visualize your data

PDL::Graphics::Prima::ReadLine

Encapsulates all interaction with the Term::ReadLine family of modules.

PDL::Graphics::Prima::Scaling

Specifies different kinds of scaling, including linear and logarithmic

PDL::Graphics::Prima::Simple

Defines a number of useful functions for generating simple and not-so-simple plots

LICENSE AND COPYRIGHT

This module's code are copyright (c) 2013 Northwestern University.

This module's documentation are copyright (c) 2013 David Mertens.

All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.