Damien Krotkine > Curses-Toolkit-0.207 > Curses::Toolkit::Event::Key

Download:
Curses-Toolkit-0.207.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

New  1
Open  2
View/Report Bugs
Module Version: 0.207   Source   Latest Release: Curses-Toolkit-0.211

NAME ^

Curses::Toolkit::Event::Key - event that is related to keystrokes

VERSION ^

version 0.207

DESCRIPTION ^

Event that is related to keystrokes

CONSTRUCTOR ^

new

  input : type   : a type of Key Event. STRING, should be one of Curses::Toolkit::Event::Key->get_types()
          params : parameter of the event. Can be optional or mandatory. Call Curses::Toolkit::Event::Key->get_params_definition($type) to see
          root_window : the root window

METHODS ^

get_type

  my $type = $event->get_type();

Returns the type of the event.

get_types

Returns the types that this Event Class supports

  input  : none
  output : ARRAY of string.

get_params_definition

Returns the parameter definition for a given type, as specified in Params::Validate

  input  : the type name
  output : 0 OR 1 OR HASHREF

get_matching_widget

Returns the widget that is affected by the event. In this case, it returns the widget that currently has the focus

  input  : none
  output : the widget that is affected by the event

AUTHOR ^

Damien "dams" Krotkine

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2011 by Damien "dams" Krotkine.

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: