| '\" |
| '\" Copyright (c) 1993-1998 Lucent Technologies, Inc. |
| '\" |
| '\" See the file "license.terms" for information on usage and redistribution |
| '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. |
| '\" |
| '\" RCS: $Id: Toplevel.n,v 1.3 1998/08/11 14:40:53 welch Exp $ |
| '\" |
| '\" The definitions below are for supplemental macros used in Tcl/Tk |
| '\" manual entries. |
| '\" |
| '\" .AP type name in/out ?indent? |
| '\" Start paragraph describing an argument to a library procedure. |
| '\" type is type of argument (int, etc.), in/out is either "in", "out", |
| '\" or "in/out" to describe whether procedure reads or modifies arg, |
| '\" and indent is equivalent to second arg of .IP (shouldn't ever be |
| '\" needed; use .AS below instead) |
| '\" |
| '\" .AS ?type? ?name? |
| '\" Give maximum sizes of arguments for setting tab stops. Type and |
| '\" name are examples of largest possible arguments that will be passed |
| '\" to .AP later. If args are omitted, default tab stops are used. |
| '\" |
| '\" .BS |
| '\" Start box enclosure. From here until next .BE, everything will be |
| '\" enclosed in one large box. |
| '\" |
| '\" .BE |
| '\" End of box enclosure. |
| '\" |
| '\" .CS |
| '\" Begin code excerpt. |
| '\" |
| '\" .CE |
| '\" End code excerpt. |
| '\" |
| '\" .VS ?version? ?br? |
| '\" Begin vertical sidebar, for use in marking newly-changed parts |
| '\" of man pages. The first argument is ignored and used for recording |
| '\" the version when the .VS was added, so that the sidebars can be |
| '\" found and removed when they reach a certain age. If another argument |
| '\" is present, then a line break is forced before starting the sidebar. |
| '\" |
| '\" .VE |
| '\" End of vertical sidebar. |
| '\" |
| '\" .DS |
| '\" Begin an indented unfilled display. |
| '\" |
| '\" .DE |
| '\" End of indented unfilled display. |
| '\" |
| '\" .SO |
| '\" Start of list of standard options for a Tk widget. The |
| '\" options follow on successive lines, in four columns separated |
| '\" by tabs. |
| '\" |
| '\" .SE |
| '\" End of list of standard options for a Tk widget. |
| '\" |
| '\" .OP cmdName dbName dbClass |
| '\" Start of description of a specific option. cmdName gives the |
| '\" option's name as specified in the class command, dbName gives |
| '\" the option's name in the option database, and dbClass gives |
| '\" the option's class in the option database. |
| '\" |
| '\" .UL arg1 arg2 |
| '\" Print arg1 underlined, then print arg2 normally. |
| '\" |
| '\" SCCS: @(#) man.macros 1.9 97/08/22 18:50:59 |
| '\" |
| '\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages. |
| .if t .wh -1.3i ^B |
| .nr ^l \n(.l |
| .ad b |
| '\" # Start an argument description |
| .de AP |
| .ie !"\\$4"" .TP \\$4 |
| .el \{\ |
| . ie !"\\$2"" .TP \\n()Cu |
| . el .TP 15 |
| .\} |
| .ie !"\\$3"" \{\ |
| .ta \\n()Au \\n()Bu |
| \&\\$1 \\fI\\$2\\fP (\\$3) |
| .\".b |
| .\} |
| .el \{\ |
| .br |
| .ie !"\\$2"" \{\ |
| \&\\$1 \\fI\\$2\\fP |
| .\} |
| .el \{\ |
| \&\\fI\\$1\\fP |
| .\} |
| .\} |
| .. |
| '\" # define tabbing values for .AP |
| .de AS |
| .nr )A 10n |
| .if !"\\$1"" .nr )A \\w'\\$1'u+3n |
| .nr )B \\n()Au+15n |
| .\" |
| .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n |
| .nr )C \\n()Bu+\\w'(in/out)'u+2n |
| .. |
| .AS Tcl_Interp Tcl_CreateInterp in/out |
| '\" # BS - start boxed text |
| '\" # ^y = starting y location |
| '\" # ^b = 1 |
| .de BS |
| .br |
| .mk ^y |
| .nr ^b 1u |
| .if n .nf |
| .if n .ti 0 |
| .if n \l'\\n(.lu\(ul' |
| .if n .fi |
| .. |
| '\" # BE - end boxed text (draw box now) |
| .de BE |
| .nf |
| .ti 0 |
| .mk ^t |
| .ie n \l'\\n(^lu\(ul' |
| .el \{\ |
| .\" Draw four-sided box normally, but don't draw top of |
| .\" box if the box started on an earlier page. |
| .ie !\\n(^b-1 \{\ |
| \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' |
| .\} |
| .el \}\ |
| \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' |
| .\} |
| .\} |
| .fi |
| .br |
| .nr ^b 0 |
| .. |
| '\" # VS - start vertical sidebar |
| '\" # ^Y = starting y location |
| '\" # ^v = 1 (for troff; for nroff this doesn't matter) |
| .de VS |
| .if !"\\$2"" .br |
| .mk ^Y |
| .ie n 'mc \s12\(br\s0 |
| .el .nr ^v 1u |
| .. |
| '\" # VE - end of vertical sidebar |
| .de VE |
| .ie n 'mc |
| .el \{\ |
| .ev 2 |
| .nf |
| .ti 0 |
| .mk ^t |
| \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n' |
| .sp -1 |
| .fi |
| .ev |
| .\} |
| .nr ^v 0 |
| .. |
| '\" # Special macro to handle page bottom: finish off current |
| '\" # box/sidebar if in box/sidebar mode, then invoked standard |
| '\" # page bottom macro. |
| .de ^B |
| .ev 2 |
| 'ti 0 |
| 'nf |
| .mk ^t |
| .if \\n(^b \{\ |
| .\" Draw three-sided box if this is the box's first page, |
| .\" draw two sides but no top otherwise. |
| .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c |
| .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c |
| .\} |
| .if \\n(^v \{\ |
| .nr ^x \\n(^tu+1v-\\n(^Yu |
| \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c |
| .\} |
| .bp |
| 'fi |
| .ev |
| .if \\n(^b \{\ |
| .mk ^y |
| .nr ^b 2 |
| .\} |
| .if \\n(^v \{\ |
| .mk ^Y |
| .\} |
| .. |
| '\" # DS - begin display |
| .de DS |
| .RS |
| .nf |
| .sp |
| .. |
| '\" # DE - end display |
| .de DE |
| .fi |
| .RE |
| .sp |
| .. |
| '\" # SO - start of list of standard options |
| .de SO |
| .SH "STANDARD OPTIONS" |
| .LP |
| .nf |
| .ta 4c 8c 12c |
| .ft B |
| .. |
| '\" # SE - end of list of standard options |
| .de SE |
| .fi |
| .ft R |
| .LP |
| See the \\fBoptions\\fR manual entry for details on the standard options. |
| .. |
| '\" # OP - start of full description for a single option |
| .de OP |
| .LP |
| .nf |
| .ta 4c |
| Command-Line Name: \\fB\\$1\\fR |
| Database Name: \\fB\\$2\\fR |
| Database Class: \\fB\\$3\\fR |
| .fi |
| .IP |
| .. |
| '\" # CS - begin code excerpt |
| .de CS |
| .RS |
| .nf |
| .ta .25i .5i .75i 1i |
| .. |
| '\" # CE - end code excerpt |
| .de CE |
| .fi |
| .RE |
| .. |
| .de UL |
| \\$1\l'|0\(ul'\\$2 |
| .. |
| .TH Toplevel n 3.0 itk "[incr\ Tk]" |
| .BS |
| '\" Note: do not modify the .SH NAME line immediately below! |
| .SH NAME |
| Toplevel \- base class for mega-widgets in a top-level window |
| .SH "INHERITANCE" |
| itk::Archetype <- itk::Toplevel |
| .SH "STANDARD OPTIONS" |
| .LP |
| .nf |
| .ta 4c 8c 12c |
| \fBbackground\fR \fBcursor\fR |
| .fi |
| .LP |
| See the "options" manual entry for details on the standard options. |
| .SH "WIDGET-SPECIFIC OPTIONS" |
| .LP |
| .nf |
| Name: \fBtitle\fR |
| Class: \fBTitle\fR |
| Command-Line Switch: \fB-title\fR |
| .fi |
| .IP |
| Sets the title that the window manager displays in the title bar |
| above the window. The default title is the null string. |
| .BE |
| |
| .SH DESCRIPTION |
| .PP |
| The \fBToplevel\fR class inherits everything from the \fBArchetype\fR |
| class, and adds a Tk toplevel called the "hull" component to represent |
| the body of the mega-widget. The window class name for the hull |
| is set to the most-specific class name for the mega-widget. |
| The protected variable \fBitk_interior\fR contains the window |
| path name for the "hull" component. Derived classes specialize |
| this widget by packing other widget components into the hull. |
| .PP |
| Since the hull for the \fBToplevel\fR class is implemented with |
| a Tk toplevel, mega-widgets in the \fBToplevel\fR class have |
| their own toplevel window. This class is used to create dialog |
| boxes and other pop-up windows. |
| |
| .SH "COMPONENTS" |
| .LP |
| .nf |
| Name: \fBhull\fR |
| Class: \fBToplevel\fR |
| .fi |
| .IP |
| The "hull" component acts as the body for the entire mega-widget. |
| Other components are packed into the hull to further specialize |
| the widget. |
| |
| .SH EXAMPLE |
| .PP |
| The following example implements a \fBMessageInfo\fR |
| mega-widget. It creates a pop-up message that the |
| user can dismiss by pushing the "Dismiss" button. |
| .CS |
| option add *MessageInfo.title "Notice" widgetDefault |
| |
| class MessageInfo { |
| inherit itk::Toplevel |
| |
| constructor {args} { |
| itk_component add dismiss { |
| button $itk_interior.dismiss -text "Dismiss" \ |
| -command "destroy $itk_component(hull)" |
| } |
| pack $itk_component(dismiss) -side bottom -pady 4 |
| |
| itk_component add separator { |
| frame $itk_interior.sep -height 2 -borderwidth 1 -relief sunken |
| } |
| pack $itk_component(separator) -side bottom -fill x -padx 4 |
| |
| itk_component add icon { |
| label $itk_interior.icon -bitmap info |
| } |
| pack $itk_component(icon) -side left -padx 8 -pady 8 |
| |
| itk_component add infoFrame { |
| frame $itk_interior.info |
| } |
| pack $itk_component(infoFrame) -side left -expand yes \ |
| -fill both -padx 4 -pady 4 |
| |
| itk_component add message { |
| label $itk_interior.mesg -width 20 |
| } { |
| usual |
| rename -text -message message Text |
| } |
| pack $itk_component(message) -expand yes -fill both |
| |
| eval itk_initialize $args |
| |
| after idle [code $this centerOnScreen] |
| } |
| |
| protected method centerOnScreen {} { |
| update idletasks |
| set wd [winfo reqwidth $itk_component(hull)] |
| set ht [winfo reqheight $itk_component(hull)] |
| set x [expr ([winfo screenwidth $itk_component(hull)]-$wd)/2] |
| set y [expr ([winfo screenheight $itk_component(hull)]-$ht)/2] |
| wm geometry $itk_component(hull) +$x+$y |
| } |
| } |
| |
| usual MessageInfo { |
| keep -background -cursor -foreground -font |
| keep -activebackground -activeforeground -disabledforeground |
| keep -highlightcolor -highlightthickness |
| } |
| |
| # |
| # EXAMPLE: Create a notice window: |
| # |
| MessageInfo .m -message "File not found:\\n/usr/local/bin/foo" |
| .CE |
| |
| .SH KEYWORDS |
| itk, Archetype, Widget, mega-widget |