Mercurial > repos > rliterman > csp2

annotate CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/lib/python3.8/idlelib/tooltip.py @ 69:33d812a61356

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload commit 2e9511a184a1ca667c7be0c6321a36dc4e3d116d
author jpayne
date Tue, 18 Mar 2025 17:55:14 -0400
parents
children
rev   line source
jpayne@69 1 """Tools for displaying tool-tips.
jpayne@69 2
jpayne@69 3 This includes:
jpayne@69 4 * an abstract base-class for different kinds of tooltips
jpayne@69 5 * a simple text-only Tooltip class
jpayne@69 6 """
jpayne@69 7 from tkinter import *
jpayne@69 8
jpayne@69 9
jpayne@69 10 class TooltipBase(object):
jpayne@69 11 """abstract base class for tooltips"""
jpayne@69 12
jpayne@69 13 def __init__(self, anchor_widget):
jpayne@69 14 """Create a tooltip.
jpayne@69 15
jpayne@69 16 anchor_widget: the widget next to which the tooltip will be shown
jpayne@69 17
jpayne@69 18 Note that a widget will only be shown when showtip() is called.
jpayne@69 19 """
jpayne@69 20 self.anchor_widget = anchor_widget
jpayne@69 21 self.tipwindow = None
jpayne@69 22
jpayne@69 23 def __del__(self):
jpayne@69 24 self.hidetip()
jpayne@69 25
jpayne@69 26 def showtip(self):
jpayne@69 27 """display the tooltip"""
jpayne@69 28 if self.tipwindow:
jpayne@69 29 return
jpayne@69 30 self.tipwindow = tw = Toplevel(self.anchor_widget)
jpayne@69 31 # show no border on the top level window
jpayne@69 32 tw.wm_overrideredirect(1)
jpayne@69 33 try:
jpayne@69 34 # This command is only needed and available on Tk >= 8.4.0 for OSX.
jpayne@69 35 # Without it, call tips intrude on the typing process by grabbing
jpayne@69 36 # the focus.
jpayne@69 37 tw.tk.call("::tk::unsupported::MacWindowStyle", "style", tw._w,
jpayne@69 38 "help", "noActivates")
jpayne@69 39 except TclError:
jpayne@69 40 pass
jpayne@69 41
jpayne@69 42 self.position_window()
jpayne@69 43 self.showcontents()
jpayne@69 44 self.tipwindow.update_idletasks() # Needed on MacOS -- see #34275.
jpayne@69 45 self.tipwindow.lift() # work around bug in Tk 8.5.18+ (issue #24570)
jpayne@69 46
jpayne@69 47 def position_window(self):
jpayne@69 48 """(re)-set the tooltip's screen position"""
jpayne@69 49 x, y = self.get_position()
jpayne@69 50 root_x = self.anchor_widget.winfo_rootx() + x
jpayne@69 51 root_y = self.anchor_widget.winfo_rooty() + y
jpayne@69 52 self.tipwindow.wm_geometry("+%d+%d" % (root_x, root_y))
jpayne@69 53
jpayne@69 54 def get_position(self):
jpayne@69 55 """choose a screen position for the tooltip"""
jpayne@69 56 # The tip window must be completely outside the anchor widget;
jpayne@69 57 # otherwise when the mouse enters the tip window we get
jpayne@69 58 # a leave event and it disappears, and then we get an enter
jpayne@69 59 # event and it reappears, and so on forever :-(
jpayne@69 60 #
jpayne@69 61 # Note: This is a simplistic implementation; sub-classes will likely
jpayne@69 62 # want to override this.
jpayne@69 63 return 20, self.anchor_widget.winfo_height() + 1
jpayne@69 64
jpayne@69 65 def showcontents(self):
jpayne@69 66 """content display hook for sub-classes"""
jpayne@69 67 # See ToolTip for an example
jpayne@69 68 raise NotImplementedError
jpayne@69 69
jpayne@69 70 def hidetip(self):
jpayne@69 71 """hide the tooltip"""
jpayne@69 72 # Note: This is called by __del__, so careful when overriding/extending
jpayne@69 73 tw = self.tipwindow
jpayne@69 74 self.tipwindow = None
jpayne@69 75 if tw:
jpayne@69 76 try:
jpayne@69 77 tw.destroy()
jpayne@69 78 except TclError: # pragma: no cover
jpayne@69 79 pass
jpayne@69 80
jpayne@69 81
jpayne@69 82 class OnHoverTooltipBase(TooltipBase):
jpayne@69 83 """abstract base class for tooltips, with delayed on-hover display"""
jpayne@69 84
jpayne@69 85 def __init__(self, anchor_widget, hover_delay=1000):
jpayne@69 86 """Create a tooltip with a mouse hover delay.
jpayne@69 87
jpayne@69 88 anchor_widget: the widget next to which the tooltip will be shown
jpayne@69 89 hover_delay: time to delay before showing the tooltip, in milliseconds
jpayne@69 90
jpayne@69 91 Note that a widget will only be shown when showtip() is called,
jpayne@69 92 e.g. after hovering over the anchor widget with the mouse for enough
jpayne@69 93 time.
jpayne@69 94 """
jpayne@69 95 super(OnHoverTooltipBase, self).__init__(anchor_widget)
jpayne@69 96 self.hover_delay = hover_delay
jpayne@69 97
jpayne@69 98 self._after_id = None
jpayne@69 99 self._id1 = self.anchor_widget.bind("<Enter>", self._show_event)
jpayne@69 100 self._id2 = self.anchor_widget.bind("<Leave>", self._hide_event)
jpayne@69 101 self._id3 = self.anchor_widget.bind("<Button>", self._hide_event)
jpayne@69 102
jpayne@69 103 def __del__(self):
jpayne@69 104 try:
jpayne@69 105 self.anchor_widget.unbind("<Enter>", self._id1)
jpayne@69 106 self.anchor_widget.unbind("<Leave>", self._id2) # pragma: no cover
jpayne@69 107 self.anchor_widget.unbind("<Button>", self._id3) # pragma: no cover
jpayne@69 108 except TclError:
jpayne@69 109 pass
jpayne@69 110 super(OnHoverTooltipBase, self).__del__()
jpayne@69 111
jpayne@69 112 def _show_event(self, event=None):
jpayne@69 113 """event handler to display the tooltip"""
jpayne@69 114 if self.hover_delay:
jpayne@69 115 self.schedule()
jpayne@69 116 else:
jpayne@69 117 self.showtip()
jpayne@69 118
jpayne@69 119 def _hide_event(self, event=None):
jpayne@69 120 """event handler to hide the tooltip"""
jpayne@69 121 self.hidetip()
jpayne@69 122
jpayne@69 123 def schedule(self):
jpayne@69 124 """schedule the future display of the tooltip"""
jpayne@69 125 self.unschedule()
jpayne@69 126 self._after_id = self.anchor_widget.after(self.hover_delay,
jpayne@69 127 self.showtip)
jpayne@69 128
jpayne@69 129 def unschedule(self):
jpayne@69 130 """cancel the future display of the tooltip"""
jpayne@69 131 after_id = self._after_id
jpayne@69 132 self._after_id = None
jpayne@69 133 if after_id:
jpayne@69 134 self.anchor_widget.after_cancel(after_id)
jpayne@69 135
jpayne@69 136 def hidetip(self):
jpayne@69 137 """hide the tooltip"""
jpayne@69 138 try:
jpayne@69 139 self.unschedule()
jpayne@69 140 except TclError: # pragma: no cover
jpayne@69 141 pass
jpayne@69 142 super(OnHoverTooltipBase, self).hidetip()
jpayne@69 143
jpayne@69 144
jpayne@69 145 class Hovertip(OnHoverTooltipBase):
jpayne@69 146 "A tooltip that pops up when a mouse hovers over an anchor widget."
jpayne@69 147 def __init__(self, anchor_widget, text, hover_delay=1000):
jpayne@69 148 """Create a text tooltip with a mouse hover delay.
jpayne@69 149
jpayne@69 150 anchor_widget: the widget next to which the tooltip will be shown
jpayne@69 151 hover_delay: time to delay before showing the tooltip, in milliseconds
jpayne@69 152
jpayne@69 153 Note that a widget will only be shown when showtip() is called,
jpayne@69 154 e.g. after hovering over the anchor widget with the mouse for enough
jpayne@69 155 time.
jpayne@69 156 """
jpayne@69 157 super(Hovertip, self).__init__(anchor_widget, hover_delay=hover_delay)
jpayne@69 158 self.text = text
jpayne@69 159
jpayne@69 160 def showcontents(self):
jpayne@69 161 label = Label(self.tipwindow, text=self.text, justify=LEFT,
jpayne@69 162 background="#ffffe0", relief=SOLID, borderwidth=1)
jpayne@69 163 label.pack()
jpayne@69 164
jpayne@69 165
jpayne@69 166 def _tooltip(parent): # htest #
jpayne@69 167 top = Toplevel(parent)
jpayne@69 168 top.title("Test tooltip")
jpayne@69 169 x, y = map(int, parent.geometry().split('+')[1:])
jpayne@69 170 top.geometry("+%d+%d" % (x, y + 150))
jpayne@69 171 label = Label(top, text="Place your mouse over buttons")
jpayne@69 172 label.pack()
jpayne@69 173 button1 = Button(top, text="Button 1 -- 1/2 second hover delay")
jpayne@69 174 button1.pack()
jpayne@69 175 Hovertip(button1, "This is tooltip text for button1.", hover_delay=500)
jpayne@69 176 button2 = Button(top, text="Button 2 -- no hover delay")
jpayne@69 177 button2.pack()
jpayne@69 178 Hovertip(button2, "This is tooltip\ntext for button2.", hover_delay=None)
jpayne@69 179
jpayne@69 180
jpayne@69 181 if __name__ == '__main__':
jpayne@69 182 from unittest import main
jpayne@69 183 main('idlelib.idle_test.test_tooltip', verbosity=2, exit=False)
jpayne@69 184
jpayne@69 185 from idlelib.idle_test.htest import run
jpayne@69 186 run(_tooltip)