Tk::NoteBook man page on BSDOS

Man page or keyword search:  
man Server   6284 pages
apropos Keyword Search (all sections)
Output format
BSDOS logo
[printable version]



NoteBook(3)	      perl/Tk Documentation	      NoteBook(3)

NAME
       Tk::NoteBook - display several windows in limited space
       with notebook metaphor.

SYNOPSIS
	 use Tk::NoteBook;
	 ...
	 $w = $frame->NoteBook();
	 $page1 = $w->add("page1", options);
	 $page2 = $w->add("page2", options);
	 ...

DESCRIPTION
       The NoteBook widget provides a notebook metaphor to
       display several windows in limited space. The notebook is
       divided into a stack of pages of which only one is
       displayed at any time. The other pages can be selected by
       means of choosing the visual "tabs" at the top of the
       widget. Additionally, the <Tab> key may be used to
       traverse the pages.  If -underline is used, Alt- bindings
       will also work.

       The widget takes all the options that a Frame does. In
       addition, it supports the following options:

       -dynamicgeometry
	   If set to false (default and recommended), the size of
	   the NoteBook will match the size of the largest page.
	   Otherwise the size will match the size of the current
	   page causing the NoteBook to change size when
	   different pages of different sizes are selected.

       -ipadx
	   The amount of internal horizontal padding around the
	   pages.

       -ipady
	   The amount of internal vertical padding around the
	   pages.

METHODS
       The following methods may be used with a NoteBook object
       in addition to standard methods.

       add(page, options)
	   Adds a page with name page to the notebook. Returns an
	   object of type Frame. The recognized options are:

       -anchor Specifies how the information in a tab is to be
	       displayed. Must be one of n, ne, e, se, s, sw, w,
	       nw or center.

25/Aug/1997		      Tk1.1				1

NoteBook(3)	      perl/Tk Documentation	      NoteBook(3)

       -bitmap Specifies a bitmap to display on the tab of this
	       page. The bitmap is displayed only if none of the
	       -label or -image options are specified.

       -image  Specifies an image to display on the tab of this
	       page. The image is displayed only if the -label
	       option is not specified.

       -label  Specifies the text string to display on the tab of
	       this page.

       -justify
	       When there are multiple lines of text displayed in
	       a tab, this option determines the justification of
	       the lines.

       -createcmd
	       Specifies a Perl command to be called the first
	       time the page is shown on the screen. This option
	       can be used to delay the creation of the contents
	       of a page until necessary. It can be useful in
	       situations where there are a large number of pages
	       in a NoteBook widget; with -createcmd you do not
	       have to make the user wait until all pages are
	       constructed before displaying the first page.

       -raisecmd
	       Specifies a Perl command to be called whenever
	       this page is raised by the user.

       -state  Specifies whether this page can be raised by the
	       user. Must be either normal or disabled.

       -underline
	       Specifies the integer index of a character to
	       underline in the tab. This option is used by the
	       default bindings to implement keyboard traversal
	       for menu buttons and menu entries. 0 corresponds
	       to the first character of text displayed on the
	       widget, 1 to the next character and so on.

       -wraplength
	       This option specifies the maximum line length of
	       the label string on this tab. If the line length
	       of the label string exceeds this length, then it
	       is wrapped onto the next line so that no line is
	       longer than the specified length. The value may be
	       specified in any standard forms for screen
	       distances. If this value is less than or equal to
	       0, then no wrapping is done: lines will break only
	       at newline characters in the text.

       delete(page)
	   Deletes the page identified by page.

25/Aug/1997		      Tk1.1				2

NoteBook(3)	      perl/Tk Documentation	      NoteBook(3)

       pagecget(page, option)
	   Returns the current value of the configuration otion
	   given by option in the page given by page. Option may
	   have any of the values accepted in the add method.

       pageconfigure(page, options)
	   Like configure for the page indicated by page. Options
	   may be any of the options accepted by the add method.

       raise(page)
	   Raise the page identified by page.

       raised()
	   Returns the name of the currently raised page.

AUTHOR
       Rajappa Iyer rsi@ziplink.net

       This code and documentation was derived from NoteBook.tcl
       in Tix4.0 written by Ioi Lam. It may be distributed under
       the same conditions as Perl itself.

25/Aug/1997		      Tk1.1				3

[top]
                             _         _         _ 
                            | |       | |       | |     
                            | |       | |       | |     
                         __ | | __ __ | | __ __ | | __  
                         \ \| |/ / \ \| |/ / \ \| |/ /  
                          \ \ / /   \ \ / /   \ \ / /   
                           \   /     \   /     \   /    
                            \_/       \_/       \_/ 
More information is available in HTML format for server BSDOS

List of man pages available for BSDOS

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net