view release on metacpan or  search on metacpan

lib/Tk/Poplevel.pm  view on Meta::CPAN

package Tk::Poplevel;

=head1 NAME

Tk::Poplevel - Popping a toplevel without decoration relative to a widget

=cut

use strict;
use warnings;
use vars qw($VERSION);
$VERSION = '0.14';

use base qw(Tk::Derived Tk::Toplevel);

use Tk;

Construct Tk::Widget 'Poplevel';

=head1 SYNOPSIS

 require Tk::Poplevel;
 my $pop = $window->Poplevel(@options,
    -widget => $somewidget,
 );
 $pop->popUp;

=head1 DESCRIPTION

This widget pops a toplevel without ornaments relative to the widget specified in the B<-widget> option.
It aligns its size and position to the widget.

Clicking outside the toplevel will pop it down.

=head1 OPTIONS

Accepts all the options of a Toplevel widget;

=over 4

=item B<-confine>

Default value is 0.
If set the popup will have the equal with of the widget.

=item B<-popalign>

Default value 'left'.
Can be 'left' or 'right'.
This is the preferred horizontal alignment.
Does nothing when B<-confine> is set.

=item B<-popdirection>

Default value 'down'.
Can be 'up' or 'down'.
Specifies if the popup should be preferrably above or below the widget.
Does nothing when B<-confine> is set.

=item B<-widget>

Set and return a reference to the widget the Poplevel should pop relative to.

=back

=head1 METHODS

=over 4

=cut

sub Populate {
	my ($self,$args) = @_;