/ 
Curses-Toolkit-0.200
/ POE::Component::Curses

NAME

POE::Component::Curses - the ( currently only ) loader for Curses::toolkit

VERSION

version 0.200

SYNOPSIS

# spawn a root window
my $root_window = POE::Component::Curses->spawn();
# adds some widget
$root->add_window(
    my $window = Curses::Toolkit::Widget::Window
      ->new()
      ->set_name('main_window')
      ->add_widget(
        my $border1 = Curses::Toolkit::Widget::Border
          ->new()
          ->set_name('border1')
          ->add_widget(
            my $label1 = Curses::Toolkit::Widget::Label
              ->new()
              ->set_name('label1')
              ->set_text('This demonstrates the use of Curses::Toolkit used with its POE Event Loop : POE::Component::Curses. Keyboard events and window resizing are supported')
          ),
      )
      ->set_coordinates(x1 => 0,   y1 => 0,
                        x2 => '100%',
                        y2 => '100%',
                       )
);

# start main loop
POE::Kernel->run();

DESCRIPTION

POE::Component::Curses is a mainloop for Curses::Toolkit.

It has only one method : spawn, which instantiates and returns a Curses::Toolkit object for you. This is the root window.

You should use this object to populate your root window with widgets. See Curses::Toolkit for more information.

CLASS METHODS

spawn

This is the main method. It will create and return a Curses::Toolkit object, and create a POE Session that will be the mainloop. spawn takes as argument the optional alias you want to give to this POE Session (default is 'curses'), and an optional args which is a hashref. It should contain arguments that will be passed to the init_root_window of Curses::Toolkit. See its documentation for more information

input  : alias <String> : the name of the POE Session. Default : 'curses'
       : args <HashRef> : the arguments to be passed to C<Curses::Toolkit::init_root_window>
output : a L<Curses::Toolkit> instance

AUTHOR

Damien "dams" Krotkine

COPYRIGHT AND LICENSE

This software is copyright (c) 2010 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.