295418 - simplify returning boolean to show tree tooltip (remove gShowTooltip, checkTooltip)

Status: RESOLVED FIXED

(Calendar :: Sunbird Only, defect)

Description

[gekacheka]

User-Agent:       Mozilla/5.0 (Windows; U; Windows NT 5.0; en-US; rv:1.7.8) Gecko/20050511 Firefox/1.0.4
Build Identifier: trunk

The mouseover preview code has historically been careful not to display a
tooltip when not over an event or task in tree, but uses a convoluted technique
involving an unnecessary global variable.  

The original code works by setting a global variable (gShowToolTip) and then
checking for this global variable in function checkTooltip.  The tooltip
onpopupshowing handlers call one function to set the tool tip and then call
checkTooltip to see if it was successful.

The reasons for this convoluted implementation no longer exist (if they ever
did); it would be simpler and easier to understand just to return the boolean
value from the first function.

Reproducible: Always

Steps to Reproduce:

Comment 1

[gekacheka]

Attachment: remove gShowTooltip, checkTooltip, return boolean.

(patch -l -p 2 -i file.patch)

calendar.xul:
  Change tooltip onpopupshowing handlers to return value from first function
changeToolTipTextForEvent, changeToolTipTextForToDo.  
  Remove call to checkTooltip.

unifinder.js, unifindertodo.js:
  Change changeToolTipTextForEvent, changeToolTipTextForToDo to return boolean
value if tooltip content created.

mouseoverPreviews.js:
  remove checkTooltip function.
  remove gShowToolTip and lines that set it.

Comment 2

[gekacheka]

Patch depends on patch to bug 295412.

Comment 3

[gekacheka]

Comment on attachment 184454 [details] [diff] [review]
remove gShowTooltip, checkTooltip, return boolean.

(split from bug 295146 as suggested.  thanks for reviews!)

Comment 4

[Michiel van Leeuwen (email: mvl+moz@)]

Comment on attachment 184454 [details] [diff] [review]
remove gShowTooltip, checkTooltip, return boolean.

r=mvl