Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

usual(n) [osx man page]

usual(n)							     [incr Tk]								  usual(n)


usual - access default option-handling commands for a mega-widget component SYNOPSIS
usual ?tag? ?commands? _________________________________________________________________ DESCRIPTION
The usual command is used outside of an [incr Tcl] class definition to define the usual set of option-handling commands for a component widget. Option-handling commands are used when a component is registered with the Archetype base class via the "itk_component add" method. They specify how the component's configuration options should be integrated into the composite option list for the mega-widget. Options can be kept, renamed, or ignored, as described in the Archetype man page. It is tedious to include the same declarations again and again whenever components are added. The usual command allows a standard code fragment to be registered for each widget class, which is used by default to handle the options. All of the standard Tk widgets have usual declarations defined in the [incr Tk] library. Similar usual declarations should be created whenever a new mega-widget class is conceived. Only the most-generic options should be included in the usual declaration. The tag name is usually the name of a widget class, which starts with a capital letter; however, any string registered here can be used later with the usual command described on the Archetype man page. If the commands argument is specified, it is associated with the tag string, and can be accessed later via itk_component add. If only the tag argument is specified, this command looks for an existing tag name and returns the commands associated with it. If there are no commands associated with tag, this command returns the null string. If no arguments are specified, this command returns a list of all tag names previously registered. EXAMPLE
Following is the usual declaration for the standard Tk button widget: itk::usual Button { keep -background -cursor -foreground -font keep -activebackground -activeforeground -disabledforeground keep -highlightcolor -highlightthickness rename -highlightbackground -background background Background } Only the options that would be common to all buttons in a single mega-widget are kept or renamed. Options like "-text" that would be unique to a particular button are ignored. KEYWORDS
itk, Archetype, component, mega-widget itk 3.0 usual(n)

Check Out this Related Man Page

Toplevel(n)							     [incr Tk]							       Toplevel(n)


Toplevel - base class for mega-widgets in a top-level window INHERITANCE
itk::Archetype <- itk::Toplevel STANDARD OPTIONS
background cursor See the "options" manual entry for details on the standard options. WIDGET-SPECIFIC OPTIONS Name: title Class: Title Command-Line Switch: -title Sets the title that the window manager displays in the title bar above the window. The default title is the null string. _________________________________________________________________ DESCRIPTION
The Toplevel class inherits everything from the Archetype 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 itk_interior contains the window path name for the "hull" component. Derived classes specialize this widget by packing other widget compo- nents into the hull. Since the hull for the Toplevel class is implemented with a Tk toplevel, mega-widgets in the Toplevel class have their own toplevel window. This class is used to create dialog boxes and other pop-up windows. COMPONENTS
Name: hull Class: Toplevel The "hull" component acts as the body for the entire mega-widget. Other components are packed into the hull to further specialize the widget. EXAMPLE
The following example implements a MessageInfo mega-widget. It creates a pop-up message that the user can dismiss by pushing the "Dismiss" button. option add *MessageInfo.title "Notice" widgetDefault itcl::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 $ } 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 } } itk::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: /usr/local/bin/foo" KEYWORDS
itk, Archetype, Widget, mega-widget itk 3.0 Toplevel(n)
Man Page