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 / spinner.itk < prev    next >
Text File  |  1999-02-24  |  16KB  |  457 lines
  1. # Spinner 
  2. # ----------------------------------------------------------------------
  3. # Implements a spinner widget.  The Spinner is comprised of an  
  4. # EntryField plus up and down arrow buttons. 
  5. # Spinner is meant to be used as a base class for creating more
  6. # specific spinners such as SpinInt.itk
  7. # Arrows may be drawn horizontally or vertically.
  8. # User may define arrow behavior or accept the default arrow behavior.
  9. #
  10. # ----------------------------------------------------------------------
  11. #   AUTHOR:  Sue Yockey               Phone: (214) 519-2517
  12. #                                     E-mail: syockey@spd.dsccc.com
  13. #                                             yockey@acm.org
  14. #
  15. #   @(#) $Id: spinner.itk,v 1.1 1998/07/27 18:49:52 stanton Exp $
  16. # ----------------------------------------------------------------------
  17. #            Copyright (c) 1995 DSC Technologies Corporation
  18. # ======================================================================
  19. # Permission to use, copy, modify, distribute and license this software 
  20. # and its documentation for any purpose, and without fee or written 
  21. # agreement with DSC, is hereby granted, provided that the above copyright 
  22. # notice appears in all copies and that both the copyright notice and 
  23. # warranty disclaimer below appear in supporting documentation, and that 
  24. # the names of DSC Technologies Corporation or DSC Communications 
  25. # Corporation not be used in advertising or publicity pertaining to the 
  26. # software without specific, written prior permission.
  27. # 
  28. # DSC DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING 
  29. # ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, AND NON-
  30. # INFRINGEMENT. THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, AND THE
  31. # AUTHORS AND DISTRIBUTORS HAVE NO OBLIGATION TO PROVIDE MAINTENANCE, 
  32. # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. IN NO EVENT SHALL 
  33. # DSC BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR 
  34. # ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, 
  35. # WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTUOUS ACTION,
  36. # ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS 
  37. # SOFTWARE.
  38. # ======================================================================
  39.  
  40. #
  41. # Default resources.
  42. #
  43. option add *Spinner.relief sunken widgetDefault
  44. option add *Spinner.labelPos w widgetDefault
  45. option add *Spinner.labelMargin 2 widgetDefault
  46.  
  47. #
  48. # Usual options.
  49. #
  50. itk::usual Spinner {
  51.     keep -background -borderwidth -cursor -foreground -highlightcolor \
  52.      -highlightthickness -insertbackground -insertborderwidth \
  53.      -insertofftime -insertontime -insertwidth -labelfont \
  54.      -selectbackground -selectborderwidth -selectforeground \
  55.      -textbackground -textfont
  56. }
  57.  
  58. # ------------------------------------------------------------------
  59. #                              SPINNER
  60. # ------------------------------------------------------------------
  61. class iwidgets::Spinner {
  62.     inherit iwidgets::Entryfield 
  63.  
  64.     constructor {args} {}
  65.     destructor {}
  66.  
  67.     itk_option define -arroworient arrowOrient Orient vertical
  68.     itk_option define -textfont textFont \
  69.         Font -Adobe-Helvetica-Medium-R-Normal--*-120-*-*-*-*-*-*
  70.     itk_option define -borderwidth borderWidth BorderWidth 2
  71.     itk_option define -highlightthickness highlightThickness \
  72.         HighlightThickness 2
  73.     itk_option define -increment increment Command {}
  74.     itk_option define -decrement decrement Command {}
  75.     itk_option define -repeatdelay repeatDelay RepeatDelay 300 
  76.     itk_option define -repeatinterval repeatInterval RepeatInterval 100
  77.     itk_option define -foreground foreground Foreground black
  78.  
  79.     public method up {}
  80.     public method down {}
  81.  
  82.     protected method _pushup {}
  83.     protected method _pushdown {}
  84.     protected method _relup {}
  85.     protected method _reldown {}
  86.     protected method _doup {rate}
  87.     protected method _dodown {rate}
  88.     protected method _up {}
  89.     protected method _down {}
  90.  
  91.     protected method _positionArrows {{when later}}
  92.  
  93.     protected variable _reposition ""  ;# non-null => _positionArrows pending
  94.     protected variable _uptimer ""     ;# non-null => _uptimer pending
  95.     protected variable _downtimer ""   ;# non-null => _downtimer pending
  96. }
  97.     
  98. #
  99. # Provide a lowercased access method for the Spinner class.
  100. # 
  101. proc ::iwidgets::spinner {pathName args} {
  102.     uplevel ::iwidgets::Spinner $pathName $args
  103. }
  104.  
  105. # ------------------------------------------------------------------
  106. #                        CONSTRUCTOR
  107. # ------------------------------------------------------------------
  108. body iwidgets::Spinner::constructor {args} {
  109.  
  110.     #
  111.     # Create arrow frame.
  112.     # 
  113.     itk_component add arrowFrame {
  114.     frame $itk_interior.arrowFrame
  115.     } {
  116.     }
  117.     pack $itk_component(arrowFrame) -side left -padx 2
  118.     
  119.     #
  120.     # Create up arrow button.
  121.     # 
  122.     itk_component add uparrow {
  123.     canvas $itk_component(arrowFrame).uparrow -height 10 -width 10 \
  124.         -relief raised -highlightthickness 0
  125.     } {
  126.     keep -background -borderwidth
  127.     }
  128.     
  129.     #
  130.     # Create down arrow button.
  131.     # 
  132.     itk_component add downarrow {
  133.     canvas $itk_component(arrowFrame).downarrow -height 10 -width 10 \
  134.         -relief raised -highlightthickness 0
  135.     } {
  136.     keep -background -borderwidth
  137.     }
  138.  
  139.     bind $itk_component(uparrow) <ButtonPress-1> [code $this _pushup]
  140.     bind $itk_component(uparrow) <ButtonRelease-1> [code $this _relup]
  141.  
  142.     bind $itk_component(downarrow)  <ButtonPress-1> [code $this _pushdown]
  143.     bind $itk_component(downarrow) <ButtonRelease-1> [code $this _reldown]
  144.     
  145.     eval itk_initialize $args
  146.  
  147.     # 
  148.     # When idle, position the arrows.
  149.     #
  150.     _positionArrows
  151. }
  152.  
  153. # ------------------------------------------------------------------
  154. #                          DESTRUCTOR
  155. # ------------------------------------------------------------------
  156.  
  157. body iwidgets::Spinner::destructor {} {
  158.     if {$_reposition != ""} {after cancel $_reposition}
  159.     if {$_uptimer != ""} {after cancel $_uptimer}
  160.     if {$_downtimer != ""} {after cancel $_downtimer}
  161. }
  162.  
  163. # ------------------------------------------------------------------
  164. #                             OPTIONS
  165. # ------------------------------------------------------------------
  166.  
  167. # ------------------------------------------------------------------
  168. # OPTION: -arroworient
  169. #
  170. # Place arrows vertically or horizontally .
  171. # ------------------------------------------------------------------
  172. configbody iwidgets::Spinner::arroworient {
  173.     _positionArrows
  174. }
  175.  
  176. # ------------------------------------------------------------------
  177. # OPTION: -textfont
  178. #
  179. # Change font, resize arrow buttons.
  180. # ------------------------------------------------------------------
  181. configbody iwidgets::Spinner::textfont {
  182.     _positionArrows
  183. }
  184.  
  185. # ------------------------------------------------------------------
  186. # OPTION: -highlightthickness
  187. #
  188. # Change highlightthickness, resize arrow buttons.
  189. # ------------------------------------------------------------------
  190. configbody iwidgets::Spinner::highlightthickness {
  191.     _positionArrows
  192. }
  193.  
  194. # ------------------------------------------------------------------
  195. # OPTION: -borderwidth
  196. #
  197. # Change borderwidth, resize arrow buttons.
  198. # ------------------------------------------------------------------
  199. configbody iwidgets::Spinner::borderwidth {
  200.     _positionArrows
  201. }
  202.  
  203. # ------------------------------------------------------------------
  204. # OPTION: -increment
  205. #
  206. # Up arrow callback. 
  207. # ------------------------------------------------------------------
  208. configbody iwidgets::Spinner::increment {
  209.     if {$itk_option(-increment) == {}} {
  210.     set itk_option(-increment) [code $this up]
  211.     }
  212. }
  213.  
  214. # ------------------------------------------------------------------
  215. # OPTION: -decrement
  216. #
  217. # Down arrow callback. 
  218. # ------------------------------------------------------------------
  219. configbody iwidgets::Spinner::decrement {
  220.     if {$itk_option(-decrement) == {}} {
  221.     set itk_option(-decrement) [code $this down]
  222.     }
  223. }
  224.  
  225. # ------------------------------------------------------------------
  226. # OPTION: -repeatinterval
  227. #
  228. # Arrow repeat rate in milliseconds. A repeatinterval of 0 disables 
  229. # button repeat.
  230. # ------------------------------------------------------------------
  231. configbody iwidgets::Spinner::repeatinterval {
  232.     if {$itk_option(-repeatinterval) < 0} {
  233.        set itk_option(-repeatinterval) 0
  234.     } 
  235. }
  236.  
  237. # ------------------------------------------------------------------
  238. # OPTION: -repeatdelay
  239. #
  240. # Arrow repeat delay in milliseconds. 
  241. # ------------------------------------------------------------------
  242. configbody iwidgets::Spinner::repeatdelay {
  243.     if {$itk_option(-repeatdelay) < 0} {
  244.        set itk_option(-repeatdelay) 0
  245.     } 
  246. }
  247.  
  248. # ------------------------------------------------------------------
  249. # OPTION: -foreground
  250. #
  251. # Set the foreground color of the up and down arrows. Remember
  252. # to make sure the "tag" exists before setting them...
  253. # ------------------------------------------------------------------
  254. configbody iwidgets::Spinner::foreground {
  255.  
  256.     if { [$itk_component(uparrow) gettags up] != "" } {
  257.     $itk_component(uparrow) itemconfigure up \
  258.         -fill $itk_option(-foreground)
  259.     }
  260.  
  261.     if { [$itk_component(downarrow) gettags down] != "" } {
  262.     $itk_component(downarrow) itemconfigure down \
  263.         -fill $itk_option(-foreground)
  264.     }
  265. }
  266.  
  267. # ------------------------------------------------------------------
  268. #                            METHODS
  269. # ------------------------------------------------------------------
  270.  
  271. # ------------------------------------------------------------------
  272. # METHOD: up
  273. #
  274. # Up arrow command.  Meant to be overloaded by derived class. 
  275. # ------------------------------------------------------------------
  276. body iwidgets::Spinner::up {} {
  277. }
  278.  
  279. # ------------------------------------------------------------------
  280. # METHOD: down 
  281. #
  282. # Down arrow command.  Meant to be overloaded by derived class.
  283. # ------------------------------------------------------------------
  284. body iwidgets::Spinner::down {} {
  285. }
  286.  
  287. # ------------------------------------------------------------------
  288. # PROTECTED METHOD: _positionArrows ?when?
  289. #
  290. # Draw Arrows for spinner. If "when" is "now", the change is applied
  291. # immediately.  If it is "later" or it is not specified, then the 
  292. # change is applied later, when the application is idle.
  293. # ------------------------------------------------------------------
  294. body iwidgets::Spinner::_positionArrows {{when later}} {
  295.     if {$when == "later"} {
  296.     if {$_reposition == ""} {
  297.         set _reposition [after idle [code $this _positionArrows now]]
  298.     }
  299.     return
  300.     } elseif {$when != "now"} {
  301.     error "bad option \"$when\": should be now or later"
  302.     }
  303.  
  304.     set _reposition ""
  305.  
  306.     set bdw [cget -borderwidth]
  307.  
  308.     #
  309.     # Based on the orientation of the arrows, pack them accordingly and
  310.     # determine the width and height of the spinners.  For vertical 
  311.     # orientation, it is really tight in the y direction, so we'll take 
  312.     # advantage of the highlightthickness.  Horizontal alignment has 
  313.     # plenty of space vertically, thus we'll ignore the thickness.
  314.     # 
  315.     switch $itk_option(-arroworient) {
  316.     vertical {
  317.         pack configure $itk_component(uparrow) \
  318.             $itk_component(downarrow) -side top
  319.  
  320.         set totalHgt [winfo reqheight $itk_component(entry)] 
  321.         set spinHgt [expr $totalHgt / 2]
  322.         set spinWid [expr round ($spinHgt * 1.6)]
  323.     }
  324.     horizontal {
  325.         pack configure $itk_component(uparrow) \
  326.             $itk_component(downarrow) -side left
  327.  
  328.         set spinHgt [expr [winfo reqheight $itk_component(entry)] - \
  329.             (2 * [$itk_component(entry) cget -highlightthickness])]
  330.         set spinWid $spinHgt
  331.     }
  332.     default {
  333.         error "bad orientation option \"$itk_option(-arroworient)\",\
  334.            should be horizontal or vertical"
  335.     }
  336.     }
  337.  
  338.     #
  339.     # Configure the width and height of the spinners minus the borderwidth.
  340.     # Next delete the previous spinner polygons and create new ones.
  341.     #
  342.     $itk_component(uparrow) config \
  343.         -height [expr $spinHgt - (2 * $bdw)] \
  344.         -width [expr $spinWid - (2 * $bdw)]
  345.     $itk_component(uparrow) delete up
  346.     $itk_component(uparrow) create polygon \
  347.         [expr $spinWid / 2] $bdw \
  348.         [expr $spinWid - $bdw - 1] [expr $spinHgt - $bdw -1] \
  349.         [expr $bdw + 1] [expr $spinHgt - $bdw - 1] \
  350.         -fill $itk_option(-foreground) -tags up
  351.         
  352.     $itk_component(downarrow) config \
  353.         -height [expr $spinHgt - (2 * $bdw)] \
  354.         -width [expr $spinWid - (2 * $bdw)]
  355.     $itk_component(downarrow) delete down
  356.     $itk_component(downarrow) create polygon \
  357.         [expr $spinWid / 2] [expr ($spinHgt - $bdw) - 1] \
  358.         [expr $bdw + 2] [expr $bdw + 1] \
  359.         [expr $spinWid - $bdw - 2] [expr $bdw + 1] \
  360.         -fill $itk_option(-foreground) -tags down
  361. }
  362.  
  363. # ------------------------------------------------------------------
  364. # PRIVATE METHOD: _pushup
  365. #
  366. # Up arrow button press event.  Call _doup with repeatdelay. 
  367. # ------------------------------------------------------------------
  368. body iwidgets::Spinner::_pushup {} {
  369.     $itk_component(uparrow) config -relief sunken
  370.     _doup $itk_option(-repeatdelay)
  371. }
  372.  
  373. # ------------------------------------------------------------------
  374. # PRIVATE METHOD: _pushdown
  375. #
  376. # Down arrow button press event.  Call _dodown with repeatdelay. 
  377. # ------------------------------------------------------------------
  378. body iwidgets::Spinner::_pushdown {} {
  379.     $itk_component(downarrow) config -relief sunken
  380.     _dodown $itk_option(-repeatdelay)
  381. }
  382.  
  383. # ------------------------------------------------------------------
  384. # PRIVATE METHOD: _doup
  385. #
  386. # Call _up and post to do another one after "rate" milliseconds if
  387. # repeatinterval > 0.
  388. # ------------------------------------------------------------------
  389. body iwidgets::Spinner::_doup {rate} {
  390.     _up 
  391.  
  392.     if {$itk_option(-repeatinterval) > 0} {
  393.     set _uptimer [after $rate [code $this _doup $itk_option(-repeatinterval)]]
  394.     }
  395. }
  396.  
  397. # ------------------------------------------------------------------
  398. # PRIVATE METHOD: _dodown
  399. #
  400. # Call _down and post to do another one after "rate" milliseconds if 
  401. # repeatinterval > 0.
  402. # ------------------------------------------------------------------
  403. body iwidgets::Spinner::_dodown {rate} {
  404.     _down 
  405.  
  406.     if {$itk_option(-repeatinterval) > 0} {
  407.     set _downtimer \
  408.         [after $rate [code $this _dodown $itk_option(-repeatinterval)]]
  409.     }
  410. }
  411.  
  412. # ------------------------------------------------------------------
  413. # PRIVATE METHOD: _relup
  414. #
  415. # Up arrow button release event.  Cancel pending up timer.
  416. # ------------------------------------------------------------------
  417. body iwidgets::Spinner::_relup {} {
  418.     $itk_component(uparrow) config -relief raised
  419.  
  420.     if {$_uptimer != ""} {
  421.     after cancel $_uptimer 
  422.     set _uptimer ""
  423.     }
  424. }
  425.  
  426. # ------------------------------------------------------------------
  427. # PRIVATE METHOD: _reldown
  428. #
  429. # Up arrow button release event.  Cancel pending down timer.
  430. # ------------------------------------------------------------------
  431. body iwidgets::Spinner::_reldown {} {
  432.     $itk_component(downarrow) config -relief raised
  433.  
  434.     if {$_downtimer != ""} { 
  435.     after cancel $_downtimer
  436.     set _downtimer ""
  437.     }
  438. }
  439.  
  440. # ------------------------------------------------------------------
  441. # PRIVATE METHOD: _up
  442. #
  443. # Up arrow button press event.  Call defined increment command. 
  444. # ------------------------------------------------------------------
  445. body iwidgets::Spinner::_up {} {
  446.     uplevel #0 $itk_option(-increment)
  447. }
  448.  
  449. # ------------------------------------------------------------------
  450. # PRIVATE METHOD: _down 
  451. #
  452. # Down arrow button press event.  Call defined decrement command. 
  453. # ------------------------------------------------------------------
  454. body iwidgets::Spinner::_down {} {
  455.     uplevel #0 $itk_option(-decrement)
  456. }
  457.