Curses::UI::Window - Create and manipulate Window widgets

Curses-UI documentation Contained in the Curses-UI distribution.

Index

Code Index:

NAME

Top

Curses::UI::Window - Create and manipulate Window widgets

CLASS HIERARCHY

Top

 Curses::UI::Widget
    |
    +----Curses::UI::Container   
            |
            +----Curses::UI::Window

SYNOPSIS

Top

    use Curses::UI;
    my $cui = new Curses::UI;
    my $win = $cui->add(
        'window_id', 'Window',
        %options,
    );

DESCRIPTION

Top

Curses::UI::Window is a window widget. It can be added to a Curses::UI instance. After that the window can be filled with other widgets to create an application window. For information on how to fill the window with widgets, see Curses::UI::Container.

STANDARD OPTIONS

Top

-parent, -x, -y, -width, -height, -pad, -padleft, -padright, -padtop, -padbottom, -ipad, -ipadleft, -ipadright, -ipadtop, -ipadbottom, -title, -titlefullwidth, -titlereverse, -onfocus, -onblur

For an explanation of these standard options, see Curses::UI::Widget.

WIDGET-SPECIFIC OPTIONS

Top

* -centered < BOOLEAN >

A window can automatically be drawn in the center of the screen. To enable this option use a true value and to disable it use a false value. The default is not to center a window. Example:

    $cui->add('mywindow', 'Window', -centered => 1);

METHODS

Top

* new ( OPTIONS )
* layout ( )
* draw ( BOOLEAN )
* focus ( )
* onFocus ( CODEREF )
* onBlur ( CODEREF )
* intellidraw ( )

These are standard methods. See Curses::UI::Widget for an explanation of these.

* modalfocus ( )

If this method is called, the window will get modal focus. This means that all events will be sent to this window. By calling the loose_focus method, the window will loose its focus.

* loose_focus ( )

This method will have the window loose its focus (using this method you can also let a modal focused window loose its focus).

SEE ALSO

Top

Curses::UI, Curses::UI::Container, Curses::UI::Widget

AUTHOR

Top

Copyright (c) 2001-2002 Maurice Makaay. All rights reserved.

Maintained by Marcus Thiesen (marcus@cpan.thiesenweb.de)

This package is free software and is provided "as is" without express or implied warranty. It may be used, redistributed and/or modified under the same terms as perl itself.

Curses-UI documentation Contained in the Curses-UI distribution. 
# ----------------------------------------------------------------------
# Curses::UI::Window
#
# (c) 2001-2002 by Maurice Makaay. All rights reserved.
# This file is part of Curses::UI. Curses::UI is free software.
# You can redistribute it and/or modify it under the same terms
# as perl itself.
#
# Currently maintained by Marcus Thiesen
# e-mail: marcus@cpan.thiesenweb.de
# ----------------------------------------------------------------------

package Curses::UI::Window;

use strict;
use Curses;
use Curses::UI::Container;
use Curses::UI::Common;

use vars qw(
    $VERSION 
    @ISA
);

$VERSION = '1.10';

@ISA = qw(
    Curses::UI::Container
);

sub new ()
{
    my $class = shift;

    my %userargs = @_;
    keys_to_lowercase(\%userargs);

    # Create the window.
    my $this = $class->SUPER::new( 
        -width     => undef,
        -height    => undef,
        -x         => 0, 
        -y         => 0,
        -centered  => 0,     # Center the window in the display?

        %userargs,

        -nocursor  => 1,     # This widget does not use a cursor
        -assubwin  => 1,     # Always constructed as a subwindow
    );

    return $this;
}

sub layout ()
{
    my $this = shift;

    # Compute the coordinates of the Window if
    # it has to be centered.
    if ($this->{-centered})
    {
        # The maximum available space on the screen.
        my $avail_width = $ENV{COLS};
        my $avail_height = $ENV{LINES};

        # Compute the coordinates for the widget.
        my $w = $this->{-width} || 1;
        my $h = $this->{-height} || 1;
        my $x = int(($avail_width - $w) / 2);
        my $y = int(($avail_height - $h) / 2);
        $x = 0 if $x < 0;
        $y = 0 if $y < 0;
        $this->{-x} = $x; 
        $this->{-y} = $y; 
    }

    $this->SUPER::layout or return;

    return $this;
}


1;