+ -------------------- +
|  uscrollbar package  |
|       mini doc       |
+ -------------------- +

Description
-----------

  Scrollbar megawidget
  
Version 
-------

  1.3

Licence
-------

  NOL licence (No Obligation Licence)
  
Operations
----------

* package operations (uscrollbar operation args)
 
  $path 
  create
  get 
  help
  set 

  uscrollbar $path ?-option value? 
  uscrollbar create $path ?-option value?
    create a widget
    see Options for option descriptions

  uscrollbar get ?-option? 
    return a default value
    see Options for option descriptions

  uscrollbar set ?-option value?... 
    set default values 
    see Options for option descriptions

  uscrollbar help 
    return help text

* occurence operations ($path operation args)

  cget
  configure 
  get
  info
  set 

  $path cget ?-option? 
    return an option value
    see Options for option descriptions

  $path configure ?-option value?... 
    set option values 
    see Options for option descriptions

  $path get 
    return slider position: {start stop}
    
  $path info ?name? 
    return an info value
    see Infos for info descriptions

  $path set ?start stop? 
    update slider position & size
    start : slider starting position fraction (0.0 - 1.0)
    stop  : slider ending position fraction (0.0 - 1.0)
 
Options
-------

  -abg                   
  -activebackground      
  -activerelief          
  -arelief               
  -background            
  -bd                    
  -bg                    
  -borderwidth           
  -command               
  -delay1                
  -delay2                
  -ebd                   
  -elementborderwidth    
  -elementrelief         
  -erelief               
  -hbd                   
  -hbg                   
  -hfg                   
  -highlightthickness    
  -highlightbackground   
  -highlightcolor        
  -jump                  
  -orient                
  -relief                
  -repeatdelay           
  -repeatinterval        
  -script                
  -size                  
  -takefocus             
  -tbg                   
  -thickness             
  -troughcolor           
  -type
  -width                 

* aliases

  -activebackground      -abg
  -activerelief          -arelief
  -background            -bg
  -borderwidth           -bd
  -command               -script
  -elementborderwidth    -ebd
  -elementrelief         -erelief
  -highlightthickness    -hbd
  -highlightbackground   -hbg
  -highlightcolor        -hfg
  -repeatdelay           -delay1
  -repeatinterval        -delay2
  -troughcolor           -tbg
  -width                 -thickness

* values/default 

  -abg                   ""
    widget active background
    (Tk color)
  -arelief               sunken
    element active relief
    (see -relief)
  -bd                    0
    widget border width
    (Tk size)
  -bg                    gray85
    widget background
    (Tk color)
  -delay1                300
    delay before initial repeat
    (milliseconds)
  -delay2                100
    delay before repeat
    (milliseconds)
  -ebd                   1
    element border width
    (Tk size)
  -erelief               raised
    element relief
    (see -relief)
  -hbd                   1
    focus highlight border width
    (Tk size)
  -hbg                   ""
    focus highlight background
    (Tk color)
  -hfg                   ""
    focus highlight color
    (Tk color)
  -jump                  0
    wait before jump flag
    (boolean)
  -orient                vertical
    widget orientation:
      vertical
      horizontal
  -relief                flat
    widget relief:
      flat
      groove
      solid
      raised
      ridge
      sunken
  -script                {}
    widget script
    scrolling operations when script is not empty:
      script moveto fraction 
      script scroll number units 
      script scroll number pages 
  -size                  15
    widget initial size
    (Tk size)
  -takefocus             1
    take focus flag
    (boolean)
  -tbg                   ""
    trough background
    (Tk color)
  -thickness             15
    widget thickness
    (Tk size)
  -type                  classic 
    scroll bar type:
      classic
      mac
      next

 Empty colors are auto-adaptive.
 Elements are arrow1, slider, arrow2.
 
Infos
-----

* aliases

  activebackground      abg
  background            bg
  down                  arrow2
  highlightbackground   hbg
  highlightcolor        hfg
  left                  arrow1
  right                 arrow2
  troughcolor           tbg
  troughpath            tpath
  up                    arrow1

* values 

  abg                   widget active background effective color
  arrow1                backward button path
  arrow2                foreward button path
  bg                    widget background effective color
  hbg                   focus highlight background effective color
  hfg                   focus highlight color effective color
  size                  widget current size
  slider                slider button path
  start                 slider starting position fraction (0.0 - 1.0)
  stop                  slider ending position fraction (0.0 - 1.0)
  tbg                   trough background effective color
  tpath                 trough path
  
uscrollbar versus Tk scrollbar
------------------------------
 
* Tk missing operations/options
  
  uscrollbar get
  uscrollbar help
  uscrollbar set
  widget info
  empty colors
  -type option

  uscrollbar get ?-option?
    replacement: use "option get" command
  uscrollbar help
    no replacement
    (try "scrollbar operation" or "path operation")
  uscrollbar set ?-option value?...
    replacement: use "option add" command
  widget info
  empty colors
  -type option
    no replacement
    (uscrollbar extension)
    
* uscrollbar missing operations/options
  
  path activate ?element? 
  path delta deltaX deltaY 
  path fraction x y 
  path identify x y 

  These operations are used in scrlbar.tcl (Tk ancillary script)
  and have no replacement.
  
Installation
------------

  - Get uscrollbar.zip at http://wfr.tcl.tk/fichiers/pub/uscrollbar.zip
  - Unzip in the lib subdirectory of Tcl (will create a uscrollbar directory)
  
Use
---

  package require uscrollbar
  text .t -yscrollc {.usv set}
  uscrollbar .usv -orient vertical -script {.t yview}
  grid .t .usv -sticky ns

Copyright
---------

  (C) ulis, 2007
  
Bugs
----

  send mail to maurice.ulis@gmail.com

Thanks
------

* to JO (John K. Ousterhout)
* to the TCT
* to the Tcler's
* aux Técleux