home *** CD-ROM | disk | FTP | other *** search
/ PC World 2000 December / PCWorld_2000-12_cd.bin / Komunikace / Comanche / comanche.exe / lib / iwidgets2.2.0 / scripts / scrolledframe.itk < prev    next >
Text File  |  1999-02-24  |  20KB  |  614 lines
  1. #
  2. # Scrolledframe
  3. # ----------------------------------------------------------------------
  4. # Implements horizontal and vertical scrollbars around a childsite
  5. # frame.  Includes options to control display of scrollbars.
  6. #
  7. # ----------------------------------------------------------------------
  8. #  AUTHOR: Sue Yockey                           syockey@spd.dsccc.com 
  9. #          Mark Ulferts                         mulferts@spd.dsccc.com 
  10. #
  11. #  @(#) $Id: scrolledframe.itk,v 1.1 1998/07/27 18:49:48 stanton Exp $
  12. # ----------------------------------------------------------------------
  13. #            Copyright (c) 1995 DSC Technologies Corporation
  14. # ======================================================================
  15. # Permission to use, copy, modify, distribute and license this software 
  16. # and its documentation for any purpose, and without fee or written 
  17. # agreement with DSC, is hereby granted, provided that the above copyright 
  18. # notice appears in all copies and that both the copyright notice and 
  19. # warranty disclaimer below appear in supporting documentation, and that 
  20. # the names of DSC Technologies Corporation or DSC Communications 
  21. # Corporation not be used in advertising or publicity pertaining to the 
  22. # software without specific, written prior permission.
  23. # 
  24. # DSC DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING 
  25. # ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, AND NON-
  26. # INFRINGEMENT. THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, AND THE
  27. # AUTHORS AND DISTRIBUTORS HAVE NO OBLIGATION TO PROVIDE MAINTENANCE, 
  28. # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. IN NO EVENT SHALL 
  29. # DSC BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR 
  30. # ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, 
  31. # WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTUOUS ACTION,
  32. # ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS 
  33. # SOFTWARE.
  34. # ======================================================================
  35.  
  36. #
  37. # Default resources.
  38. #
  39. option add *Scrolledframe.borderWidth 2 widgetDefault
  40. option add *Scrolledframe.relief sunken widgetDefault
  41. option add *Scrolledframe.scrollMargin 3 widgetDefault
  42. option add *Scrolledframe.vscrollMode static widgetDefault
  43. option add *Scrolledframe.hscrollMode static widgetDefault
  44. option add *Scrolledframe.width 100 widgetDefault
  45. option add *Scrolledframe.height 100 widgetDefault
  46. option add *Scrolledframe.labelPos n widgetDefault
  47.  
  48. #
  49. # Usual options.
  50. #
  51. itk::usual Scrolledframe {
  52.     keep -activebackground -activerelief -background -borderwidth -cursor \
  53.      -elementborderwidth -foreground -highlightcolor -highlightthickness \
  54.      -jump -labelfont -troughcolor
  55. }
  56.  
  57. # ------------------------------------------------------------------
  58. #                            SCROLLEDFRAME
  59. # ------------------------------------------------------------------
  60. class iwidgets::Scrolledframe {
  61.     inherit iwidgets::Labeledwidget
  62.  
  63.     constructor {args} {}
  64.     destructor {}
  65.  
  66.     itk_option define -sbwidth sbWidth Width 15
  67.     itk_option define -scrollmargin scrollMargin ScrollMargin 3
  68.     itk_option define -vscrollmode vscrollMode VScrollMode static
  69.     itk_option define -hscrollmode hscrollMode HScrollMode static
  70.     itk_option define -width width Width 30
  71.     itk_option define -height height Height 30
  72.  
  73.     public method childsite {} 
  74.     public method justify {direction} 
  75.     public method xview {args} 
  76.     public method yview {args} 
  77.  
  78.     protected method _configureCanvas {} 
  79.     protected method _configureFrame {} 
  80.     protected method _scrollFrame {wid first last} 
  81.     protected method _updateFiller {}
  82.     protected method _configureFiller {}
  83.  
  84.     private method _fillerWidth {} 
  85.     private method _horizScrollbarDisplay {mode} 
  86.     private method _vertScrollbarDisplay {mode} 
  87.  
  88.     protected variable _vmode off            ;# Vertical scroll mode
  89.     protected variable _hmode off            ;# Vertical scroll mode
  90.     protected variable _reconfigPlanned ""   ;# non-null, filler update pending
  91.  
  92.     private variable _initialized 0            ;# Initialization flag.
  93. }
  94.  
  95. #
  96. # Provide a lowercased access method for the Scrolledframe class.
  97. # 
  98. proc ::iwidgets::scrolledframe {pathName args} {
  99.     uplevel ::iwidgets::Scrolledframe $pathName $args
  100. }
  101.  
  102. # ------------------------------------------------------------------
  103. #                        CONSTRUCTOR
  104. # ------------------------------------------------------------------
  105. body iwidgets::Scrolledframe::constructor {args} {
  106.     component hull configure -borderwidth 0
  107.     pack propagate $itk_component(shell) no
  108.  
  109.     #
  110.     # Create some frames to hold both the top and bottom halves of 
  111.     # the widget.  The top will contain both the canvas and vertical 
  112.     # scrollbar.  The bottom houses the horizontal scrollbar and 
  113.     # some filler.
  114.     #
  115.     itk_component add topFrame {
  116.     frame $itk_interior.topFrame
  117.     } {
  118.     keep -background -cursor 
  119.     }
  120.     pack $itk_component(topFrame) -fill both -expand yes
  121.     
  122.     #
  123.     # Frame around horizontal scrollbar 
  124.     #
  125.     itk_component add bottomHalf {
  126.     frame $itk_component(topFrame).bottomHalf
  127.     } {
  128.     keep -background -cursor
  129.     }
  130.     pack $itk_component(bottomHalf) -fill x -side bottom
  131.     
  132.     #
  133.     # Frame for horizontal margin between scrolled area & scrollbar
  134.     #
  135.     itk_component add hMargin {
  136.     frame $itk_component(topFrame).hMargin
  137.     } {
  138.     keep -background -cursor
  139.     }
  140.     pack $itk_component(hMargin) -side bottom
  141.  
  142.     #
  143.     # Frame around canvas and vertical scrollbar
  144.     #
  145.     itk_component add topHalf {
  146.     frame $itk_component(topFrame).topHalf
  147.     } {
  148.     keep -background -cursor
  149.     }
  150.     pack $itk_component(topHalf) -fill both -expand yes    
  151.     
  152.     # 
  153.     # Create a frame for the canvas to provide relief for the canvas.
  154.     #
  155.     itk_component add canvasFrame {
  156.     frame $itk_component(topHalf).canvasFrame \
  157.         -relief sunken -borderwidth 2
  158.     } {
  159.     keep -background -borderwidth -cursor -relief 
  160.     }
  161.     
  162.     # 
  163.     # Create a canvas to scroll
  164.     #
  165.     itk_component add scrCanvas {
  166.     canvas $itk_component(canvasFrame).scrCanvas \
  167.         -height 1.0 -width 1.0 \
  168.                 -scrollregion "0 0 1 1" \
  169.         -highlightthickness 0 \
  170.                 -borderwidth 0 -relief flat \
  171.                 -xscrollcommand \
  172.         [code $this _scrollFrame $itk_component(bottomHalf).hSB] \
  173.         -yscrollcommand \
  174.         [code $this _scrollFrame $itk_component(topHalf).vSB]
  175.     } {
  176.     keep -background -cursor
  177.     }
  178.     pack $itk_component(scrCanvas) -fill both -expand yes
  179.     bind $itk_component(scrCanvas) <Configure> [code $this _configureCanvas]
  180.     
  181.     #
  182.     # Create a Frame inside canvas to hold widgets to be scrolled 
  183.     #
  184.     itk_component add scrFrame {
  185.     frame $itk_component(scrCanvas).scrFrame 
  186.     } {
  187.     keep -background -cursor
  188.     }
  189.     pack $itk_component(scrFrame) -fill both -expand yes
  190.     $itk_component(scrCanvas) create window 1 1 -tags frameTag \
  191.             -window $itk_component(scrFrame) -anchor nw
  192.     set itk_interior $itk_component(scrFrame)
  193.     bind $itk_component(scrFrame) <Configure> [code $this _configureFrame]
  194.     
  195.     #
  196.     # Create frame for the vertical margin between the scrolling
  197.     # area and the scrollbar.
  198.     #
  199.     itk_component add vMargin {
  200.     frame $itk_component(topHalf).vMargin -width 0
  201.     } {
  202.     keep -background -cursor
  203.     }
  204.     
  205.     # 
  206.     # Create the vertical scroll bar.
  207.     #
  208.     itk_component add vSB {
  209.     scrollbar $itk_component(topHalf).vSB -orient vertical \
  210.         -command [code $itk_component(scrCanvas) yview]
  211.     } {
  212.     keep -activebackground -activerelief -background -borderwidth \
  213.         -cursor -elementborderwidth \
  214.         -highlightcolor -jump -highlightthickness -relief \
  215.         -repeatdelay -repeatinterval -troughcolor
  216.     rename -highlightbackground -background background Background
  217.     }
  218.     pack $itk_component(vSB) -side right -fill y
  219.     pack $itk_component(vMargin) -side right
  220.     pack $itk_component(canvasFrame) -fill both -expand yes -side left
  221.     
  222.     #
  223.     # Create the horizontal scrollbar.
  224.     #
  225.     itk_component add hSB {
  226.     scrollbar $itk_component(bottomHalf).hSB -orient horizontal \
  227.         -command [code $itk_component(scrCanvas) xview]
  228.     } {
  229.     keep -activebackground -activerelief -background -borderwidth \
  230.         -cursor -elementborderwidth \
  231.         -highlightcolor -jump -highlightthickness -relief \
  232.         -repeatdelay -repeatinterval -troughcolor
  233.     rename -highlightbackground -background background Background
  234.     }
  235.     pack $itk_component(hSB) -side left -fill x -expand yes
  236.     
  237.     #
  238.     # Create the filler frame and compute its width.
  239.     #
  240.     itk_component add filler {
  241.     frame $itk_component(bottomHalf).filler -width [_fillerWidth]
  242.     } {
  243.     keep -background -cursor
  244.     }
  245.     pack $itk_component(filler) -side right 
  246.     
  247.     #
  248.     # Explicitly handle configs that may have been ignored earlier.
  249.     #
  250.     eval itk_initialize $args
  251.     
  252.     bind $itk_component(hMargin) <Configure> [code $this _configureFiller]
  253.     bind $itk_component(vSB) <Configure> [code $this _configureFiller]
  254.     bind $itk_component(vMargin) <Configure> [code $this _configureFiller]
  255.     bind $itk_component(hSB) <Configure> [code $this _configureFiller]
  256.  
  257.     set _initialized 1
  258.     configure -scrollmargin $itk_option(-scrollmargin)
  259. }
  260.  
  261. # ------------------------------------------------------------------
  262. #                           DESTURCTOR
  263. # ------------------------------------------------------------------
  264. body iwidgets::Scrolledframe::destructor {} {
  265.     if {$_reconfigPlanned != ""} {after cancel $_reconfigPlanned}
  266. }
  267.  
  268. # ------------------------------------------------------------------
  269. #                             OPTIONS
  270. # ------------------------------------------------------------------
  271.  
  272. # ------------------------------------------------------------------
  273. # OPTION: -sbwidth
  274. #
  275. # Set the width of the scrollbars.
  276. # ------------------------------------------------------------------
  277. configbody iwidgets::Scrolledframe::sbwidth {
  278.     if {$_initialized} {
  279.     $itk_component(vSB) configure -width $itk_option(-sbwidth)
  280.     $itk_component(hSB) configure -width $itk_option(-sbwidth)
  281.     }
  282. }
  283.  
  284. # ------------------------------------------------------------------
  285. # OPTION: -scrollmargin
  286. #
  287. # Set the distance between the scrollbars and the canvas.
  288. # ------------------------------------------------------------------
  289. configbody iwidgets::Scrolledframe::scrollmargin {
  290.     if {$_initialized} {
  291.     set pixels [winfo pixels $itk_component(hMargin) \
  292.         $itk_option(-scrollmargin)]
  293.     
  294.     if {$_hmode == "on"} {
  295.         $itk_component(hMargin) config -width 1 -height $pixels
  296.     }
  297.     
  298.     if {$_vmode == "on"} {
  299.         $itk_component(vMargin) config -width $pixels -height 1
  300.     }
  301.     
  302.     $itk_component(filler) config -width [_fillerWidth] -height 1
  303.     }
  304. }
  305.  
  306. # ------------------------------------------------------------------
  307. # OPTION: -vscrollmode
  308. #
  309. # Enable/disable display and mode of veritcal scrollbars.
  310. # ------------------------------------------------------------------
  311. configbody iwidgets::Scrolledframe::vscrollmode {
  312.     switch $itk_option(-vscrollmode) {
  313.         static {
  314.             _vertScrollbarDisplay on
  315.         }
  316.     
  317.         dynamic -
  318.         none {
  319.             _vertScrollbarDisplay off
  320.         }
  321.     
  322.         default {
  323.             error "bad vscrollmode option\
  324.             \"$itk_option(-vscrollmode)\": should be\
  325.             static, dynamic, or none"
  326.         }
  327.     }
  328. }
  329.  
  330. # ------------------------------------------------------------------
  331. # OPTION: -hscrollmode
  332. #
  333. # Enable/disable display and mode of horizontal scrollbars.
  334. # ------------------------------------------------------------------
  335. configbody iwidgets::Scrolledframe::hscrollmode {
  336.     switch $itk_option(-hscrollmode) {
  337.         static {
  338.             _horizScrollbarDisplay on
  339.         }
  340.     
  341.         dynamic -
  342.         none {
  343.             _horizScrollbarDisplay off
  344.         }
  345.     
  346.         default {
  347.             error "bad hscrollmode option\
  348.             \"$itk_option(-hscrollmode)\": should be\
  349.             static, dynamic, or none"
  350.         }
  351.     }
  352. }
  353.  
  354. # ------------------------------------------------------------------
  355. # OPTION: -width
  356. #
  357. # Specifies the width of the scrolled frame.  The value may be 
  358. # specified in any of the forms acceptable to Tk_GetPixels.  
  359. # ------------------------------------------------------------------
  360. configbody iwidgets::Scrolledframe::width {
  361.     set pixels \
  362.             [winfo pixels $itk_component(shell) $itk_option(-width)]
  363.     
  364.     $itk_component(shell) config -width $pixels
  365. }
  366.  
  367. # ------------------------------------------------------------------
  368. # OPTION: -height
  369. #
  370. # Specifies the height of the scrolled frame.  The value may be 
  371. # specified in any of the forms acceptable to Tk_GetPixels.  
  372. # ------------------------------------------------------------------
  373. configbody iwidgets::Scrolledframe::height {
  374.     set pixels \
  375.             [winfo pixels $itk_component(shell) $itk_option(-height)]
  376.     
  377.     $itk_component(shell) config -height $pixels
  378. }
  379.  
  380. # ------------------------------------------------------------------
  381. #                            METHODS
  382. # ------------------------------------------------------------------
  383.  
  384. # ------------------------------------------------------------------
  385. # METHOD: childsite
  386. #
  387. # Returns the path name of the child site widget.
  388. # ------------------------------------------------------------------
  389. body iwidgets::Scrolledframe::childsite {} {
  390.     return $itk_component(scrFrame)
  391. }
  392.  
  393. # ------------------------------------------------------------------
  394. # METHOD: justify
  395. #
  396. # Justifies the scrolled region in one of four directions: top,
  397. # bottom, left, or right.
  398. # ------------------------------------------------------------------
  399. body iwidgets::Scrolledframe::justify {direction} {
  400.     if {[winfo ismapped $itk_component(scrCanvas)]} {
  401.     update idletasks
  402.     
  403.     switch $direction {
  404.         left {
  405.         $itk_component(scrCanvas) xview moveto 0
  406.         }
  407.         right {
  408.         $itk_component(scrCanvas) xview moveto 1
  409.         }
  410.         top {
  411.         $itk_component(scrCanvas) yview moveto 0
  412.         }
  413.         bottom {
  414.         $itk_component(scrCanvas) yview moveto 1
  415.         }
  416.         default {
  417.         error "bad justify argument \"$direction\": should be\
  418.             left, right, top, or bottom"
  419.         }
  420.     }
  421.     }
  422. }
  423.  
  424. # ------------------------------------------------------------------
  425. # METHOD: xview index
  426. #
  427. # Adjust the view in the frame so that character position index
  428. # is displayed at the left edge of the widget.
  429. # ------------------------------------------------------------------
  430. body iwidgets::Scrolledframe::xview {args} {
  431.     return [eval $itk_component(scrCanvas) xview $args]
  432. }
  433.  
  434. # ------------------------------------------------------------------
  435. # METHOD: yview index
  436. #
  437. # Adjust the view in the frame so that character position index
  438. # is displayed at the top edge of the widget.
  439. # ------------------------------------------------------------------
  440. body iwidgets::Scrolledframe::yview {args} {
  441.     return [eval $itk_component(scrCanvas) yview $args]
  442. }
  443.  
  444. # ------------------------------------------------------------------
  445. # PRIVATE METHOD: _configureCanvas 
  446. #
  447. # Responds to configure events on the canvas widget.  When canvas 
  448. # changes size, adjust frame size.
  449. # ------------------------------------------------------------------
  450. body iwidgets::Scrolledframe::_configureCanvas {} {
  451.     set sr [$itk_component(scrCanvas) cget -scrollregion]
  452.     set srw [lindex $sr 2]
  453.     set srh [lindex $sr 3]
  454.     
  455.     $itk_component(scrFrame) configure -height $srh -width $srw
  456. }
  457.  
  458. # ------------------------------------------------------------------
  459. # PRIVATE METHOD: _configureFrame 
  460. #
  461. # Responds to configure events on the frame widget.  When the frame 
  462. # changes size, adjust scrolling region size.
  463. # ------------------------------------------------------------------
  464. body iwidgets::Scrolledframe::_configureFrame {} {
  465.     $itk_component(scrCanvas) configure \
  466.         -scrollregion [$itk_component(scrCanvas) bbox frameTag] 
  467. }
  468.  
  469. # ------------------------------------------------------------------
  470. # PRIVATE METHOD: _fillerWidth 
  471. #
  472. # Compute the width of the filler frame based on the vertical 
  473. # scrollbar width plus the margin.
  474. # ------------------------------------------------------------------
  475. body iwidgets::Scrolledframe::_fillerWidth {} {
  476.     if {$_vmode == "on"} {
  477.     return [expr [winfo reqwidth $itk_component(vSB)] + \
  478.         [winfo reqwidth $itk_component(vMargin)]]
  479.     } else {
  480.     return 1
  481.     }
  482. }
  483.  
  484. # ------------------------------------------------------------------
  485. # PROTECTED METHOD: _configureFiller 
  486. #
  487. # Set up to do an update of the filler if one is not all ready 
  488. # planned.
  489. # ------------------------------------------------------------------
  490. body iwidgets::Scrolledframe::_configureFiller {} {
  491.     if {$_reconfigPlanned == ""} {
  492.     set _reconfigPlanned [after idle [code $this _updateFiller]]
  493.     }
  494. }
  495.  
  496. # ------------------------------------------------------------------
  497. # PROTECTED METHOD: _updateFiller 
  498. #
  499. # Update the width of the filler following a configure event on 
  500. # a scrollbar or margin.
  501. # ------------------------------------------------------------------
  502. body iwidgets::Scrolledframe::_updateFiller {} {
  503.     $itk_component(filler) config -width [_fillerWidth] -height 1
  504.     set _reconfigPlanned ""
  505. }
  506.  
  507. # ------------------------------------------------------------------
  508. # PRIVATE METHOD: _horizScrollbarDisplay 
  509. #
  510. # Displays the horizontal scrollbar based on the input mode.
  511. # ------------------------------------------------------------------
  512. body iwidgets::Scrolledframe::_horizScrollbarDisplay {mode} {
  513.     switch $mode  {
  514.     on {
  515.         set _hmode on
  516.         
  517.         $itk_component(hMargin) config -width 1 -height \
  518.             [winfo pixels $itk_component(hMargin) \
  519.             $itk_option(-scrollmargin)]
  520.         
  521.         pack $itk_component(hSB) -side left -fill x -expand yes
  522.     }
  523.     
  524.     off {
  525.         set _hmode off
  526.         
  527.         pack forget $itk_component(hSB)
  528.         
  529.         $itk_component(hMargin) config -width 1 -height 1
  530.         $itk_component(filler) config -width 1 -height 1
  531.     }
  532.     
  533.     default {
  534.         error "invalid argument \"$mode\": should be on or off"
  535.     }
  536.     }
  537. }
  538.  
  539. # ------------------------------------------------------------------
  540. # PRIVATE METHOD: _vertScrollbarDisplay 
  541. #
  542. # Displays the vertical scrollbar based on the input mode.
  543. # ------------------------------------------------------------------
  544. body iwidgets::Scrolledframe::_vertScrollbarDisplay {mode} {
  545.     switch $mode  {
  546.     on {
  547.         set _vmode on
  548.         
  549.         $itk_component(vMargin) config -height 1 -width \
  550.             [winfo pixels $itk_component(vMargin) \
  551.             $itk_option(-scrollmargin)]
  552.  
  553.         pack forget $itk_component(canvasFrame)
  554.         pack forget $itk_component(vMargin)
  555.         pack $itk_component(vSB) -side right -fill y
  556.         pack $itk_component(vMargin) -side right
  557.         pack $itk_component(canvasFrame) -fill both -expand yes -side left
  558.     }
  559.     
  560.     off {
  561.         set _vmode off
  562.         
  563.         pack forget $itk_component(vSB)
  564.         
  565.         $itk_component(vMargin) config -width 1 -height 1
  566.         $itk_component(filler) config -width 1 -height 1
  567.     }
  568.     
  569.     default {
  570.         error "invalid argument \"$mode\": should be on or off"
  571.     }
  572.     }
  573. }
  574.  
  575. # ------------------------------------------------------------------
  576. # PRIVATE METHOD: _scrollFrame 
  577. #
  578. # Performs scrolling and display of scrollbars based on the total 
  579. # and maximum frame size as well as the current -vscrollmode and 
  580. # -hscrollmode settings.  Parameters are automatic scroll parameters.
  581. # ------------------------------------------------------------------
  582. body iwidgets::Scrolledframe::_scrollFrame {wid first last} {
  583.     $wid set $first $last
  584.     
  585.     if {$wid == $itk_component(vSB)} {
  586.     if {$itk_option(-vscrollmode) == "dynamic"} {
  587.         if {($first == 0) && ($last == 1)} {
  588.         if {$_vmode != "off"} {
  589.             _vertScrollbarDisplay off
  590.         }
  591.         
  592.         } else {
  593.         if {$_vmode != "on"} {
  594.             _vertScrollbarDisplay on
  595.         }
  596.         }
  597.     }
  598.     
  599.     } elseif {$wid == $itk_component(hSB)} {
  600.     if {$itk_option(-hscrollmode) == "dynamic"} {
  601.         if {($first == 0) && ($last == 1)} {
  602.         if {$_hmode != "off"} {
  603.             _horizScrollbarDisplay off
  604.         }
  605.         
  606.         } else {
  607.         if {$_hmode != "on"} {
  608.             _horizScrollbarDisplay on
  609.         }
  610.         }
  611.     }
  612.     }
  613. }
  614.