/ 
Tk-Multi-1.006
River stage zero No dependents
/ Tk::Multi::Frame

NAME

Tk::Multi::Frame - A TFrame widget managed by Tk::Multi

SYNOPSIS

use Tk::Multi::Manager;

use Tk::Multi::Frame ; 

my $manager = $yourWindow -> MultiManager 
 (
  menu => $menu_ref , # optionnal
  printSub => $sub_ref ,  # optionnal
  title => "windows" # optionnal
 ) -> pack ();

# Don't pack it, the manager will do it
my $w1 = $manager -> newSlave('type' => 'MultiFrame', 
                              'title' => 'a_label');

DESCRIPTION

This composite widget features :

  • a frame with a title (e.g. a Tk::TFrame).

  • A print button (if the printSub parameter was provided)

    (The shell print command may be modified by setting $Tk::Multi::Frame::printCmd to the appropriate shell command. By default, it is set to 'lp -opostscript')

This widget will forward all unrecognize commands to the Frame object.

Note that this widget should be created only by the Multi::Manager.

WIDGET-SPECIFIC OPTIONS

title

The frame title (See Tk::TFrame)

The log window feature a set of menu items which must be added in a menu. This menu ref must be passed with the menu_button prameter to the object during its instaciation

printSub

By itself, a frame cannot be printed. So if the user wants to print some informations related to what's packed inside the frame, he must provide a sub ref which will return a string. This string will be printed as is by the widget.

WIDGET-SPECIFIC METHODS

print

Will raise a popup window with an Entry to modify the actual print command, a print button, a default button (to restore the default print command), and a cancel button.

doPrint

Print the label and the content of the text window. The print is invoked by dumping the text content into a piped command.

You may want to set up a new command to print correctly on your machine. You may do it by using the setPrintCmd method or by invoking the 'print' method.

setPrintCmd('print command')

Will set the $printCmd class variable to the passed string. You may use this method to set the appropriate print command on your machine. Note that using this method will affect all other Tk::Multi::Frame object since the modified variable is not an instance variable but a class variable.

Delegated methods

By default all widget method are delegated to the TFrame widget. Excepted :

command(-label => 'some text', -command => sub {...} )

Delegated to the menu entry managed by Multi::Manager. Will add a new command to the aforementionned menu.

NOTE

If you want to use a scrolled frame, you pack a Tk::Pane within the frame provided by this widget. See Tk::Pane.

TO DO

I'm not really satisfied with print management. May be one day, I'll write a print management composite widget which will look like Netscape's print window. But that's quite low on my priority list. Any volunteer ?

Defines ressources for the config options.

AUTHOR

Dominique Dumont, domi@komarr.grenoble.hp.com

Copyright (c) 1997-1999,2002,2004 Dominique Dumont. All rights
reserved.  This program is free software; you can redistribute it
and/or modify it under the same terms as Perl itself.

SEE ALSO

perl(1), Tk, Tk::Multi, Tk::Multi::Manager, Tk::TFrame, Tk::Pane