Fixed bug [1288433] - LisboxSelect event triggers when listbox state is disabled

3 files changed, 55 insertions, 14 deletions

diff --git a/doc/listbox.n b/doc/listbox.n
index 2c80627..9f34b5e 100644
--- a/doc/listbox.n
+++ b/doc/listbox.n
@@ -468,9 +468,12 @@ Most people will probably want to use \fBbrowse\fR mode for
 single selections and \fBextended\fR mode for multiple selections;
 the other modes appear to be useful only in special situations.
 .PP
-Any time the selection changes in the listbox, the virtual event
-\fB<<ListboxSelect>>\fR will be generated.  It is easiest to bind
-to this event to be made aware of any changes to listbox selection.
+Any time the set of selected item(s) in the listbox is updated by the
+user through the keyboard or mouse, the virtual event
+\fB<<ListboxSelect>>\fR will be generated. This virtual event will not
+be generated when adjusting the selection with the \fIpathName
+\fBselection\fR  command. It is easiest to bind to this event to be
+made aware of any user changes to listbox selection.
 .PP
 In addition to the above behavior, the following additional behavior
 is defined by the default bindings:
diff --git a/library/listbox.tcl b/library/listbox.tcl
index 3270b5d..17c03c0 100644
--- a/library/listbox.tcl
+++ b/library/listbox.tcl
@@ -118,7 +118,7 @@ bind Listbox <Control-Home> {
     %W see 0
     %W selection clear 0 end
     %W selection set 0
-    event generate %W <<ListboxSelect>>
+    tk::FireListboxSelectEvent %W
 }
 bind Listbox <Control-Shift-Home> {
     tk::ListboxDataExtend %W 0
@@ -128,7 +128,7 @@ bind Listbox <Control-End> {
     %W see end
     %W selection clear 0 end
     %W selection set end
-    event generate %W <<ListboxSelect>>
+    tk::FireListboxSelectEvent %W
 }
 bind Listbox <Control-Shift-End> {
     tk::ListboxDataExtend %W [%W index end]
@@ -163,7 +163,7 @@ bind Listbox <<SelectAll>> {
 bind Listbox <<SelectNone>> {
     if {[%W cget -selectmode] ne "browse"} {
 	%W selection clear 0 end
-	event generate %W <<ListboxSelect>>
+        tk::FireListboxSelectEvent %W
     }
 }
 
@@ -256,7 +256,7 @@ proc ::tk::ListboxBeginSelect {w el {focus 1}} {
 	set Priv(listboxSelection) {}
 	set Priv(listboxPrev) $el
     }
-    event generate $w <<ListboxSelect>>
+    tk::FireListboxSelectEvent $w
     # check existence as ListboxSelect may destroy us
     if {$focus && [winfo exists $w] && [$w cget -state] eq "normal"} {
 	focus $w
@@ -284,7 +284,7 @@ proc ::tk::ListboxMotion {w el} {
 	    $w selection clear 0 end
 	    $w selection set $el
 	    set Priv(listboxPrev) $el
-	    event generate $w <<ListboxSelect>>
+	    tk::FireListboxSelectEvent $w
 	}
 	extended {
 	    set i $Priv(listboxPrev)
@@ -315,7 +315,7 @@ proc ::tk::ListboxMotion {w el} {
 		incr i -1
 	    }
 	    set Priv(listboxPrev) $el
-	    event generate $w <<ListboxSelect>>
+	    tk::FireListboxSelectEvent $w
 	}
     }
 }
@@ -366,7 +366,7 @@ proc ::tk::ListboxBeginToggle {w el} {
 	} else {
 	    $w selection set $el
 	}
-	event generate $w <<ListboxSelect>>
+	tk::FireListboxSelectEvent $w
     }
 }
 
@@ -418,7 +418,7 @@ proc ::tk::ListboxUpDown {w amount} {
 	browse {
 	    $w selection clear 0 end
 	    $w selection set active
-	    event generate $w <<ListboxSelect>>
+	    tk::FireListboxSelectEvent $w
 	}
 	extended {
 	    $w selection clear 0 end
@@ -426,7 +426,7 @@ proc ::tk::ListboxUpDown {w amount} {
 	    $w selection anchor active
 	    set Priv(listboxPrev) [$w index active]
 	    set Priv(listboxSelection) {}
-	    event generate $w <<ListboxSelect>>
+	    tk::FireListboxSelectEvent $w
 	}
     }
 }
@@ -514,7 +514,7 @@ proc ::tk::ListboxCancel w {
 	}
 	incr first
     }
-    event generate $w <<ListboxSelect>>
+    tk::FireListboxSelectEvent $w
 }
 
 # ::tk::ListboxSelectAll
@@ -534,5 +534,19 @@ proc ::tk::ListboxSelectAll w {
     } else {
 	$w selection set 0 end
     }
-    event generate $w <<ListboxSelect>>
+    tk::FireListboxSelectEvent $w
+}
+
+# ::tk::FireListboxSelectEvent
+#
+# Fire the <<ListboxSelect>> event if the listbox is not in disabled
+# state.
+#
+# Arguments:
+# w -		The listbox widget.
+
+proc ::tk::FireListboxSelectEvent w {
+    if {[$w cget -state] eq "normal"} {
+        event generate $w <<ListboxSelect>>
+    }
 }
diff --git a/tests/listbox.test b/tests/listbox.test
index e05d574..01a8e7a 100644
--- a/tests/listbox.test
+++ b/tests/listbox.test
@@ -3068,6 +3068,30 @@ test listbox-30.1 {Bug 3607326} -setup {
     unset -nocomplain a
 } -result * -match glob -returnCodes error
 
+test listbox-31.1 {<<ListboxSelect>> event} -setup {
+    destroy .l
+    unset -nocomplain res
+} -body {
+    pack [listbox .l -state normal]
+    update
+    bind .l <<ListboxSelect>> {lappend res [%W curselection]}
+    .l insert end a b c
+    focus -force .l
+    event generate .l <1> -x 5 -y 5  ; # <<ListboxSelect>> fires
+    .l configure -state disabled
+    focus -force .l
+    event generate .l <Control-Home> ; # <<ListboxSelect>> does NOT fire
+    .l configure -state normal
+    focus -force .l
+    event generate .l <Control-End>  ; # <<ListboxSelect>> fires
+    .l selection clear 0 end         ; # <<ListboxSelect>> does NOT fire
+    .l selection set 1 1             ; # <<ListboxSelect>> does NOT fire
+    lappend res [.l curselection]
+} -cleanup {
+    destroy .l
+    unset -nocomplain res
+} -result {0 2 1}
+
 resetGridInfo
 deleteWindows
 option clear