View on
MetaCPAN
Jason May > Term-VT102-Incremental-0.05 > Term::VT102::Incremental

Download:
Term-VT102-Incremental-0.05.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.05   Source  

NAME ^

Term::VT102::Incremental - get VT updates in increments

VERSION ^

version 0.05

SYNOPSIS ^

  my $vti = Term::VT102::Incremental->new(
    rows => 50,
    cols => 100,
  );

  $vti->process(...);
  my $updates = $vti->get_increment(); # at time X

  $vti->process(...);
  $vti->process(...);
  my $updates_since_time_X = $vti->get_increment(); # at time Y

DESCRIPTION ^

Term::VT102::Incremental is a thin wrapper around Term::VT102 with a few internal differences. This module takes the exact same arguments in the constructor as Term::VT102, but has one extra method: get_increment.

ATTRIBUTES ^

vt

Intermal Term::VT102 object. You can make any configurations that any other normal Term::VT102 object would let you make.

METHODS ^

process

See Term::VT102's process.

rows

See Term::VT102's rows.

cols

See Term::VT102's cols.

vt_class

Returns the name of the VT class that the internal VT object will use when instantiated. Currently defaults too Term::VT102 but can be overridden by extending this class.

get_increment

After one or more updates, you can call get_increment to see the incremental series of updates you've made. It returns an arrayref of 3-element lists: row, cell, and cell property differences.

Cell properties consist of:

Foreground (fg)
Background (bg)
Boldness (bo)
Faint (fa)
Standout (st)
Underline (ul)
Blink (bl)
Reverse coloring (rv)

See the attr_pack method in the Term::VT102 documentation for details on this.

AUTHOR ^

Jason May <jason.a.may@gmail.com>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2011 by Jason May.

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

syntax highlighting: