Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
WaitBox(3)	      User Contributed Perl Documentation	    WaitBox(3)

NAME
       Tk::WaitBox - An	Object Oriented	Wait Dialog for	Perl/Tk, of the	Please
       Wait variety.

DESCRIPTION
       A WaitBox consists of a number of subwidgets:

       o

   bitmap
       A bitmap	(configurable via the -bitmap command, the default is an
       hourglass) on the left side of the WaitBox

   label
       A label (configurable via the -txt1 command), with text in the upper
       portion of the right hand frame

   secondary label
       Another label (configurable via the -txt2 command, the default is
       'Please Wait'), with text in the	lower portion of the right hand	frame

   userframe
       A frame displayed, if required, between the label and the secondary
       label.  For details, see	the example code and the Advertised Widget
       section

   cancel button
       If a cancelroutine (configured via the -cancelroutine command) is
       defined,	a frame	will be	packed below the labels	and bitmap, with a
       single button.  The text	of the button will be 'Cancel' (configurable
       via the -canceltext command), and the button will call the supplied
       subroutine when pressed.

SYNOPSIS
       Usage Description

   Basic Usage
       To use, create your WaitDialog objects during initialization, or	at
       least before a Show.  When you wish to display the WaitDialog object,
       invoke the 'Show' method	on the WaitDialog object; when you wish	to
       cease displaying	the WaitDialog object, invoke the 'unShow' method on
       the object.

   Configuration
       Configuration may be done at creation or	via the	configure method.

   Example Code
	#!/usr/local/bin/perl -w
	       ## Dependent on Graham Barr's Tk::ProgressBar
	       use strict;

	       use Tk;
	       use Tk::WaitBox;
	       use Tk::ProgressBar;

	       my($root) = MainWindow->new;
	       $root->withdraw;
	       my($utxt) = "Initializing...";
	       my($percent);

	       my($wd);
	       $wd = $root->WaitBox(
				    -bitmap =>'questhead', # Default would be 'hourglass'
				    -txt2 => 'tick-tick-tick', #default	would be 'Please Wait'
				    -title => 'Takes forever to	get service around here',
				    -cancelroutine => sub {
					print "\nI'm canceling....\n";
					$wd->unShow;
					$utxt =	undef;
				    });
	       $wd->configure(-txt1 => "Hurry up and Wait, my Drill Sergeant told me");
	       $wd->configure(-foreground => 'blue',-background	=> 'white');

	       ### Do something	quite boring with the user frame
	       my($u) =	$wd->{SubWidget}{uframe};
	       $u->pack(-expand	=> 1, -fill => 'both');
	       $u->Label(-textvariable => \$utxt)->pack(-expand	=> 1, -fill => 'both');

	       ## It would definitely be better	to do this with	a canvas... this is dumb
	       my($bar)	= $u->ProgressBar(
					  -variable => \$percent,
					  -blocks => 0,
					  -width => 20,
					  -colors => [	0 => 'green',
							30 => 'yellow',
							50 => 'orange',
							80 => 'red'],
					 )
		       ->pack(-expand =>1, -fill =>'both');

	       $wd->configure(-canceltext => 'Halt, Cease, Desist'); # default is 'Cancel'

	       $wd->Show;

	       my($diff) = 240;
	       for (1..$diff) {
		   $percent = int($_/$diff*100);
		   $utxt = sprintf("%5.2f%% Complete",$percent);
		   $bar->update;
		   last	if !defined($utxt);
	       }

	       sleep(2);
	       $wd->unShow;

Advertised Subwidgets
       uframe
	   uframe is a frame created between the two messages.	It may be used
	   for anything	the user has in	mind...	including exciting cycle
	   wasting displays of sand dropping through an	hour glass, Zippy
	   riding either a Gnu or a bronc, et cetera.

	   Assuming that the WaitBox is	referenced by $w, the uframe may be
	   addressed as	$w->subwidget{uframe}.	Having gotten the address, you
	   can do anything (I think) you would like with it

Miscellaneous Methods
       -takefocus
	   Specifying -takeFocus = 0 will prevent the WaitBox widget from
	   taking focus. Default is to take focus and do an application	grab.
	   I'm not sure	why, but someone told me it was	necessary.

Author
       Brent B.	Powers,	(B2Pi) Powers@B2Pi.com

       Copyright(c) 1996-2000 Brent B. Powers. All rights reserved.  This
       program is free software, you may redistribute it and/or	modify it
       under the same terms as Perl itself.

POD ERRORS
       Hey! The	above document had some	coding errors, which are explained
       below:

       Around line 189:
	   You forgot a	'=back'	before '=head2'

       Around line 209:
	   =back without =over

       Around line 217:
	   Expected text after =item, not a bullet

       Around line 219:
	   You forgot a	'=back'	before '=head2'

       Around line 229:
	   '=item' outside of any '=over'

perl v5.24.1			  2000-07-27			    WaitBox(3)

NAME | DESCRIPTION | SYNOPSIS | Advertised Subwidgets | Miscellaneous Methods | Author | POD ERRORS

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Tk::WaitBox&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help