# -*- mode: TCL; fill-column: 75; tab-width: 8; coding: iso-latin-1-unix -*-

#

#	$Id: ComboBox.tcl,v 1.8 2004/03/28 02:44:57 hobbs Exp $

#

# tixCombobox --

#

#	A combobox widget is basically a listbox widget with an entry

#	widget.

#

#

# Copyright (c) 1993-1999 Ioi Kim Lam.

# Copyright (c) 2000-2001 Tix Project Group.

# Copyright (c) 2004 ActiveState

#

# See the file "license.terms" for information on usage and redistribution

# of this file, and for a DISCLAIMER OF ALL WARRANTIES.

global tkPriv

if {![llength [info globals tkPriv]]} {

    tk::unsupported::ExposePrivateVariable tkPriv

}

#--------------------------------------------------------------------------

# tkPriv elements used in this file:

#

# afterId -		Token returned by "after" for autoscanning.

#--------------------------------------------------------------------------

#

foreach fun {tkCancelRepeat tkListboxUpDown tkButtonUp} {

    if {![llength [info commands $fun]]} {

	tk::unsupported::ExposePrivateCommand $fun

    }

}

unset fun

tixWidgetClass tixComboBox {

    -classname TixComboBox

    -superclass tixLabelWidget

    -method {

	addhistory align appendhistory flash invoke insert pick popdown

    }

    -flag {

	-anchor -arrowbitmap -browsecmd -command -crossbitmap

	-disablecallback -disabledforeground -dropdown -editable

	-fancy -grab -histlimit -historylimit -history -listcmd

	-listwidth -prunehistory -selection -selectmode -state

	-tickbitmap -validatecmd -value -variable

    }

    -static {

	-dropdown -fancy

    }

    -forcecall {

	-variable -selectmode -state

    }

    -configspec {

	{-arrowbitmap arrowBitmap ArrowBitmap ""}

	{-anchor anchor Anchor w}

	{-browsecmd browseCmd BrowseCmd ""}

        {-command command Command ""}

	{-crossbitmap crossBitmap CrossBitmap ""}

	{-disablecallback disableCallback DisableCallback 0 tixVerifyBoolean}

	{-disabledforeground disabledForeground DisabledForeground #606060}

	{-dropdown dropDown DropDown true tixVerifyBoolean}

	{-editable editable Editable false tixVerifyBoolean}

	{-fancy fancy Fancy false tixVerifyBoolean}

	{-grab grab Grab global}

	{-listcmd listCmd ListCmd ""}

	{-listwidth listWidth ListWidth ""}

	{-historylimit historyLimit HistoryLimit ""}

	{-history history History false tixVerifyBoolean}

	{-prunehistory pruneHistory PruneHistory true tixVerifyBoolean}

	{-selectmode selectMode SelectMode browse}

	{-selection selection Selection ""}

        {-state state State normal}

	{-validatecmd validateCmd ValidateCmd ""}

	{-value value Value ""}

	{-variable variable Variable ""}

	{-tickbitmap tickBitmap TickBitmap ""}

    }

    -alias {

	{-histlimit -historylimit}

    }

    -default {

	{*Entry.relief				sunken}

	{*TixScrolledListBox.scrollbar		auto}

	{*Listbox.exportSelection		false}

	{*Listbox.takeFocus			false}

	{*shell.borderWidth			2}

	{*shell.relief				raised}

	{*shell.cursor				arrow}

	{*Button.anchor				c}

	{*Button.borderWidth			1}

	{*Button.highlightThickness		0}

	{*Button.padX				0}

	{*Button.padY				0}

	{*tick.width				18}

	{*tick.height				18}

	{*cross.width				18}

	{*cross.height				18}

	{*arrow.anchor				c}

	{*arrow.width				15}

	{*arrow.height				18}

    }

}

# States: normal numbers: for dropdown style

#         d+digit(s)    : for non-dropdown style

#

proc tixComboBox:InitWidgetRec {w} {

    upvar #0 $w data

    tixChainMethod $w InitWidgetRec

    set data(curIndex)    ""

    set data(varInited)	  0

    set data(state)       none

    set data(ignore)      0

    if {$data(-history)} {

        set data(-editable) 1

    }

    if {$data(-arrowbitmap) eq ""} {

	set data(-arrowbitmap) [tix getbitmap cbxarrow]

    }

    if {$data(-crossbitmap) eq ""} {

	set data(-crossbitmap) [tix getbitmap cross]

    }

    if {$data(-tickbitmap) eq ""} {

	set data(-tickbitmap) [tix getbitmap tick]

    }

}

proc tixComboBox:ConstructFramedWidget {w frame} {

    upvar #0 $w data

    tixChainMethod $w ConstructFramedWidget $frame

    if {$data(-dropdown)} {

	tixComboBox:ConstructEntryFrame $w $frame

	tixComboBox:ConstructListShell $w

    } else {

	set f1 [frame $frame.f1]

	set f2 [frame $frame.f2]

	tixComboBox:ConstructEntryFrame $w $f1

	tixComboBox:ConstructListFrame  $w $f2

	pack $f1 -side top -pady 2 -fill x

	pack $f2 -side top -pady 2 -fill both -expand yes

    }

}

proc tixComboBox:ConstructEntryFrame {w frame} {

    upvar #0 $w data

    # (1) The entry

    #

    set data(w:entry) [entry $frame.entry]

    if {!$data(-editable)} {

	set bg [$w cget -bg]

	$data(w:entry) config -bg $bg -state disabled -takefocus 1

    }

    # This is used during "config-state"

    #

    set data(entryfg) [$data(w:entry) cget -fg]

    # (2) The dropdown button, not necessary when not in dropdown mode

    #

    set data(w:arrow) [button $frame.arrow -bitmap $data(-arrowbitmap)]

    if {!$data(-dropdown)} {

	set xframe [frame $frame.xframe -width 19]

    }

    # (3) The fancy tick and cross buttons

    #

    if {$data(-fancy)} {

	if {$data(-editable)} {

           set data(w:cross)  [button $frame.cross -bitmap $data(-crossbitmap)]

	   set data(w:tick)   [button $frame.tick  -bitmap $data(-tickbitmap)]

	   pack $frame.cross -side left -padx 1

	   pack $frame.tick  -side left -padx 1

	} else {

	   set data(w:tick)   [button $frame.tick  -bitmap $data(-tickbitmap)]

	   pack $frame.tick  -side left -padx 1

	}

    }

    if {$data(-dropdown)} {

	pack $data(w:arrow) -side right -padx 1

	foreach wid [list $data(w:frame) $data(w:label)] {

	    tixAddBindTag $wid TixComboWid

	    tixSetMegaWidget $wid $w TixComboBox

	}

    } else {

	pack $xframe -side right -padx 1

    }

    pack $frame.entry -side right -fill x -expand yes -padx 1

}

proc tixComboBox:ConstructListShell {w} {

    upvar #0 $w data

    # Create the shell and the list

    #------------------------------

    set data(w:shell) [menu $w.shell -bd 2 -relief raised -tearoff 0]

    wm overrideredirect $data(w:shell) 1

    wm withdraw $data(w:shell)

    set data(w:slistbox) [tixScrolledListBox $data(w:shell).slistbox \

	-anchor $data(-anchor) -scrollbarspace y \

	-options {listbox.selectMode "browse"}]

    set data(w:listbox) [$data(w:slistbox) subwidget listbox]

    pack $data(w:slistbox) -expand yes -fill both -padx 2 -pady 2

}

proc tixComboBox:ConstructListFrame {w frame} {

    upvar #0 $w data

    set data(w:slistbox) [tixScrolledListBox $frame.slistbox \

	-anchor $data(-anchor)]

    set data(w:listbox) [$data(w:slistbox) subwidget listbox]

    pack $data(w:slistbox) -expand yes -fill both

}

proc tixComboBox:SetBindings {w} {

    upvar #0 $w data

    tixChainMethod $w SetBindings

    # (1) Fix the bindings for the combobox

    #

    bindtags $w [list $w TixComboBox [winfo toplevel $w] all]

    # (2) The entry subwidget

    #

    tixSetMegaWidget $data(w:entry) $w TixComboBox

    bindtags $data(w:entry) [list $data(w:entry) Entry TixComboEntry\

	TixComboWid [winfo toplevel $data(w:entry)] all]

    # (3) The listbox and slistbox

    #

    $data(w:slistbox) config -browsecmd \

	[list tixComboBox:LbBrowse  $w]

    $data(w:slistbox) config -command\

	[list tixComboBox:LbCommand $w]

    $data(w:listbox) config -takefocus 0

    tixAddBindTag $data(w:listbox)  TixComboLb

    tixAddBindTag $data(w:slistbox) TixComboLb

    tixSetMegaWidget $data(w:listbox)  $w TixComboBox

    tixSetMegaWidget $data(w:slistbox) $w TixComboBox

    # (4) The buttons

    #

    if {$data(-dropdown)} {

	$data(w:arrow) config -takefocus 0

	tixAddBindTag $data(w:arrow) TixComboArrow

	tixSetMegaWidget $data(w:arrow) $w TixComboBox

	bind $data(w:root) <1>                [list tixComboBox:RootDown $w]

	bind $data(w:root) <ButtonRelease-1>  [list tixComboBox:RootUp   $w]

    }

    if {$data(-fancy)} {

	if {$data(-editable)} {

	    $data(w:cross) config -command [list tixComboBox:CrossBtn $w] \

		-takefocus 0

	}

	$data(w:tick) config -command [list tixComboBox:Invoke $w] -takefocus 0

    }

    if {$data(-dropdown)} {

	set data(state) 0

    } else {

	set data(state) n0

    }

}

proc tixComboBoxBind {} {

    #----------------------------------------------------------------------

    # The class bindings for the TixComboBox

    #

    tixBind TixComboBox <Escape> {

	if {[tixComboBox:EscKey %W]} {

	    break

	}

    }

    tixBind TixComboBox <Configure> {

	tixWidgetDoWhenIdle tixComboBox:align %W

    }

    # Only the two "linear" detail_fields  are for tabbing (moving) among

    # widgets inside the same toplevel. Other detail_fields are sort

    # of irrelevant

    #

    tixBind TixComboBox <FocusOut>  {

	if {[string equal %d NotifyNonlinear] ||

	    [string equal %d NotifyNonlinearVirtual]} {

	    if {[info exists %W(cancelTab)]} {

		unset %W(cancelTab)

	    } else {

		if {[set %W(-state)] ne "disabled"} {

		    if {[set %W(-selection)] ne [set %W(-value)]} {

			tixComboBox:Invoke %W

		    }

		}

	    }

	}

    }

    tixBind TixComboBox <FocusIn>  {

	if {"%d" eq "NotifyNonlinear" || "%d" eq "NotifyNonlinearVirtual"} {

	    focus [%W subwidget entry]

	    # CYGNUS: Setting the selection if there is no data

	    # causes backspace to misbehave.

	    if {[[set %W(w:entry)] get] ne ""} {

  		[set %W(w:entry)] selection from 0

  		[set %W(w:entry)] selection to end

  	    }

	}

    }

    #----------------------------------------------------------------------

    # The class tixBindings for the arrow button widget inside the TixComboBox

    #

    tixBind TixComboArrow <1>               {

	tixComboBox:ArrowDown [tixGetMegaWidget %W TixComboBox]

    }

    tixBind TixComboArrow <ButtonRelease-1> {

	tixComboBox:ArrowUp   [tixGetMegaWidget %W TixComboBox]

    }

    tixBind TixComboArrow <Escape>          {

	if {[tixComboBox:EscKey [tixGetMegaWidget %W TixComboBox]]} {

	    break

	}

    }

    #----------------------------------------------------------------------

    # The class tixBindings for the entry widget inside the TixComboBox

    #

    tixBind TixComboEntry <Up>		{

	tixComboBox:EntDirKey [tixGetMegaWidget %W TixComboBox] up

    }

    tixBind TixComboEntry <Down>	{

	tixComboBox:EntDirKey [tixGetMegaWidget %W TixComboBox] down

    }

    tixBind TixComboEntry <Prior>	{

	tixComboBox:EntDirKey [tixGetMegaWidget %W TixComboBox] pageup

    }

    tixBind TixComboEntry <Next>	{

	tixComboBox:EntDirKey [tixGetMegaWidget %W TixComboBox] pagedown

    }

    tixBind TixComboEntry <Return>	{

	tixComboBox:EntReturnKey [tixGetMegaWidget %W TixComboBox]

    }

    tixBind TixComboEntry <KeyPress>	{

	tixComboBox:EntKeyPress [tixGetMegaWidget %W TixComboBox]

    }

    tixBind TixComboEntry <Escape> 	{

	if {[tixComboBox:EscKey [tixGetMegaWidget %W TixComboBox]]} {

	    break

	}

    }

    tixBind TixComboEntry <Tab> 	{

	if {[set [tixGetMegaWidget %W TixComboBox](-state)] ne "disabled"} {

	    if {[tixComboBox:EntTab [tixGetMegaWidget %W TixComboBox]]} {

		break

	    }

	}

    }

    tixBind TixComboEntry <1>	{

	if {[set [tixGetMegaWidget %W TixComboBox](-state)] ne "disabled"} {

	    focus %W

	}

    }

    tixBind TixComboEntry <ButtonRelease-2>	{

	tixComboBox:EntKeyPress [tixGetMegaWidget %W TixComboBox]

    }

    #----------------------------------------------------------------------

    # The class bindings for the listbox subwidget

    #

    tixBind TixComboWid <Escape> {

	if {[tixComboBox:EscKey [tixGetMegaWidget %W TixComboBox]]} {

	    break

	}

    }

    #----------------------------------------------------------------------

    # The class bindings for some widgets inside ComboBox

    #

    tixBind TixComboWid <ButtonRelease-1> {

	tixComboBox:WidUp [tixGetMegaWidget %W TixComboBox]

    }

    tixBind TixComboWid <Escape> {

	if {[tixComboBox:EscKey [tixGetMegaWidget %W TixComboBox]]} {

	    break

	}

    }

}

#----------------------------------------------------------------------

#              Cooked events

#----------------------------------------------------------------------

proc tixComboBox:ArrowDown {w} {

    upvar #0 $w data

    if {$data(-state) eq "disabled"} {

	return

    }

    switch -exact -- $data(state) {

	0	{ tixComboBox:GoState 1 $w }

	2	{ tixComboBox:GoState 19 $w }

	default	{ tixComboBox:StateError $w }

    }

}

proc tixComboBox:ArrowUp {w} {

    upvar #0 $w data

    switch -exact -- $data(state) {

	1	{ tixComboBox:GoState 2 $w }

	19	{

	    # data(ignore) was already set in state 19

	    tixComboBox:GoState 4 $w

	}

	5	{ tixComboBox:GoState 13 $w }

	default	{ tixComboBox:StateError $w }

    }

}

proc tixComboBox:RootDown {w} {

    upvar #0 $w data

    switch -exact -- $data(state) {

	0	{

	    # Ignore

	}

	2	{ tixComboBox:GoState 3 $w }

	default { tixComboBox:StateError $w }

    }

}

proc tixComboBox:RootUp {w} {

    upvar #0 $w data

    switch -exact -- $data(state) {

	{1} {

	    tixComboBox:GoState 12 $w

	}

	{3} {

	    # data(ignore) was already set in state 3

	    tixComboBox:GoState 4 $w

	}

	{5} {

	    tixComboBox:GoState 7 $w

	}

	default {

	    tixComboBox:StateError $w

	}

    }

}

proc tixComboBox:WidUp {w} {

    upvar #0 $w data

    switch -exact -- $data(state) {

	{1} {

	    tixComboBox:GoState 12 $w

	}

	{5} {

	    tixComboBox:GoState 13 $w

	}

    }

}

proc tixComboBox:LbBrowse {w args} {

    upvar #0 $w data

    set event [tixEvent type]

    set x [tixEvent flag x]

    set y [tixEvent flag y]

    set X [tixEvent flag X]

    set Y [tixEvent flag Y]

    if {$data(-state) eq "disabled"} { return }

    switch -exact -- $event {

	<1> {

	    case $data(state) {

		{2} {

		    tixComboBox:GoState 5 $w $x $y $X $Y

		}

		{5} {

		    tixComboBox:GoState 5 $w $x $y $X $Y

		}

		{n0} {

		    tixComboBox:GoState n6 $w $x $y $X $Y

		}

		default {

		    tixComboBox:StateError $w

		}

	    }

	}

	<ButtonRelease-1> {

	    case $data(state) {

		{5} {

		    tixComboBox:GoState 6 $w $x $y $X $Y

		}

		{n6} {

		    tixComboBox:GoState n0 $w

		}

		default {

		    tixComboBox:StateError $w

		}