Package param :: Module tk :: Class ToolTip
[hide private]
[frames] | no frames]

Class ToolTip

source code


Provides a ToolTip widget for Tkinter. To apply a ToolTip to any Tkinter widget, simply pass the widget to the ToolTip constructor
Nested Classes [hide private]

Inherited from Tkinter.Misc: getdouble, getint

Instance Methods [hide private]
 
__init__(self, wdgt, msg=None, msgFunc=None, delay=1, follow=True)
Initialize the ToolTip
source code
 
spawn(self, event=None)
Spawn the ToolTip.
source code
 
show(self)
Displays the ToolTip if the time delay has been long enough
source code
 
move(self, event)
Processes motion within the widget.
source code
 
hide(self, event=None)
Hides the ToolTip.
source code

Inherited from Tkinter.BaseWidget: destroy

Inherited from Tkinter.BaseWidget (private): _do, _setup

Inherited from Tkinter.Misc: __contains__, __getitem__, __setitem__, __str__, after, after_cancel, after_idle, bbox, bell, bind, bind_all, bind_class, bindtags, cget, clipboard_append, clipboard_clear, clipboard_get, colormodel, columnconfigure, config, configure, deletecommand, event_add, event_delete, event_generate, event_info, focus, focus_displayof, focus_force, focus_get, focus_lastfor, focus_set, getboolean, getvar, grab_current, grab_release, grab_set, grab_set_global, grab_status, grid_bbox, grid_columnconfigure, grid_location, grid_propagate, grid_rowconfigure, grid_size, grid_slaves, image_names, image_types, keys, lift, lower, mainloop, nametowidget, option_add, option_clear, option_get, option_readfile, pack_propagate, pack_slaves, place_slaves, propagate, quit, register, rowconfigure, selection_clear, selection_get, selection_handle, selection_own, selection_own_get, send, setvar, size, slaves, tk_bisque, tk_focusFollowsMouse, tk_focusNext, tk_focusPrev, tk_menuBar, tk_setPalette, tk_strictMotif, tkraise, unbind, unbind_all, unbind_class, update, update_idletasks, wait_variable, wait_visibility, wait_window, waitvar, winfo_atom, winfo_atomname, winfo_cells, winfo_children, winfo_class, winfo_colormapfull, winfo_containing, winfo_depth, winfo_exists, winfo_fpixels, winfo_geometry, winfo_height, winfo_id, winfo_interps, winfo_ismapped, winfo_manager, winfo_name, winfo_parent, winfo_pathname, winfo_pixels, winfo_pointerx, winfo_pointerxy, winfo_pointery, winfo_reqheight, winfo_reqwidth, winfo_rgb, winfo_rootx, winfo_rooty, winfo_screen, winfo_screencells, winfo_screendepth, winfo_screenheight, winfo_screenmmheight, winfo_screenmmwidth, winfo_screenvisual, winfo_screenwidth, winfo_server, winfo_toplevel, winfo_viewable, winfo_visual, winfo_visualid, winfo_visualsavailable, winfo_vrootheight, winfo_vrootwidth, winfo_vrootx, winfo_vrooty, winfo_width, winfo_x, winfo_y

Inherited from Tkinter.Misc (private): _bind, _configure, _displayof, _getboolean, _getdoubles, _getints, _grid_configure, _nametowidget, _options, _register, _report_exception, _root, _substitute

Inherited from Tkinter.Wm: aspect, attributes, client, colormapwindows, command, deiconify, focusmodel, frame, geometry, grid, group, iconbitmap, iconify, iconmask, iconname, iconposition, iconwindow, maxsize, minsize, overrideredirect, positionfrom, protocol, resizable, sizefrom, state, title, transient, withdraw, wm_aspect, wm_attributes, wm_client, wm_colormapwindows, wm_command, wm_deiconify, wm_focusmodel, wm_frame, wm_geometry, wm_grid, wm_group, wm_iconbitmap, wm_iconify, wm_iconmask, wm_iconname, wm_iconposition, wm_iconwindow, wm_maxsize, wm_minsize, wm_overrideredirect, wm_positionfrom, wm_protocol, wm_resizable, wm_sizefrom, wm_state, wm_title, wm_transient, wm_withdraw

Class Variables [hide private]

Inherited from Tkinter.Misc: _noarg_

Inherited from Tkinter.Misc (private): _subst_format, _subst_format_str, _tclCommands

Method Details [hide private]

__init__(self, wdgt, msg=None, msgFunc=None, delay=1, follow=True)
(Constructor)

source code 

Initialize the ToolTip

Arguments:
wdgt: The widget this ToolTip is assigned to msg: A static string message assigned to the ToolTip msgFunc: A function that retrieves a string to use as the ToolTip text delay: The delay in seconds before the ToolTip appears(may be float) follow: If True, the ToolTip follows motion, otherwise hides
Overrides: Tkinter.BaseWidget.__init__

spawn(self, event=None)

source code 

Spawn the ToolTip. This simply makes the ToolTip eligible for display. Usually this is caused by entering the widget

Arguments:
event: The event that called this funciton

move(self, event)

source code 

Processes motion within the widget.

Arguments:
event: The event that called this function

hide(self, event=None)

source code 

Hides the ToolTip. Usually this is caused by leaving the widget

Arguments:
event: The event that called this function