/ 
Termbox-0.10
River stage zero No dependents
/ Termbox::Event

NAME

Termbox::Event - A Single User Interaction

SYNOPSIS

Description

This class represents an event or single interaction from the user.

The mod( ) and ch( ) values are valid if type( ) is TB_EVENT_KEY.
The w( ) and h( ) values are valid if type( ) is TB_EVENT_RESIZE.
The x( ) and y( ) values are valid if type( ) is TB_EVENT_MOUSE.
The key( ) value is valid if type( ) is either TB_EVENT_KEY or TB_EVENT_MOUSE.
The key( ) and <ch( )> values are mutually exclusive; only one of them can be non-zero at a time.

Methods

Events are loaded with a lot of data... user these methods to access it:

type( )

The type of event. Please see the :type import tag from Termbox.

mod( )

Modifiers to either key( ) or ch( ) below.

key( )

One of the TB_KEY_.+ constants imported from Termobx with the :key tag.

ch( )

A single unicode character, if available.

w( )

The width of the event.

h( )

The height of the event.

x( )

The horizontal position of the event.

y( )

The vertical position of the event.

Author

Sanko Robinson <sanko@cpan.org> - http://sankorobinson.com/

CPAN ID: SANKO

License and Legal

Copyright (C) 2020 by Sanko Robinson <sanko@cpan.org>

This program is free software; you can redistribute it and/or modify it under the terms of The Artistic License 2.0. See http://www.perlfoundation.org/artistic_license_2_0. For clarification, see http://www.perlfoundation.org/artistic_2_0_notes.

When separated from the distribution, all POD documentation is covered by the Creative Commons Attribution-Share Alike 3.0 License. See http://creativecommons.org/licenses/by-sa/3.0/us/legalcode. For clarification, see http://creativecommons.org/licenses/by-sa/3.0/us/.