Tkinter :: Listbox :: Class Listbox
[hide private]
[frames] | no frames]

Class Listbox

source code

  Misc --+        
         |        
BaseWidget --+    
             |    
      Pack --+    
             |    
     Place --+    
             |    
      Grid --+    
             |    
        Widget --+
                 |
                Listbox

Listbox widget which can display a list of strings.

Nested Classes [hide private]

Inherited from Misc: getdouble, getint


Instance Methods [hide private]
  __init__(self, master=None, cnf={}, **kw)
Construct a listbox widget with the parent MASTER.
  activate(self, index)
Activate item identified by INDEX.
  bbox(self, *args)
Return a tuple of X1,Y1,X2,Y2 coordinates for a rectangle which encloses the item identified by index in ARGS.
  curselection(self)
Return list of indices of currently selected item.
  delete(self, first, last=None)
Delete items from FIRST to LAST (not included).
  get(self, first, last=None)
Get list of items from FIRST to LAST (not included).
  index(self, index)
Return index of item identified with INDEX.
  insert(self, index, *elements)
Insert ELEMENTS at INDEX.
  itemcget(self, index, option)
Return the resource value for an ITEM and an OPTION.
  itemconfig(self, index, cnf=None, **kw)
Configure resources of an ITEM.
  itemconfigure(self, index, cnf=None, **kw)
Configure resources of an ITEM.
  nearest(self, y)
Get index of item which is nearest to y coordinate Y.
  scan_dragto(self, x, y)
Adjust the view of the listbox to 10 times the difference between X and Y and the coordinates given in scan_mark.
  scan_mark(self, x, y)
Remember the current X, Y coordinates.
  see(self, index)
Scroll such that INDEX is visible.
  select_anchor(self, index)
Set the fixed end oft the selection to INDEX.
  select_clear(self, first, last=None)
Clear the selection from FIRST to LAST (not included).
  select_includes(self, index)
Return 1 if INDEX is part of the selection.
  select_set(self, first, last=None)
Set the selection from FIRST to LAST (not included) without changing the currently selected elements.
  selection_anchor(self, index)
Set the fixed end oft the selection to INDEX.
  selection_clear(self, first, last=None)
Clear the selection from FIRST to LAST (not included).
  selection_includes(self, index)
Return 1 if INDEX is part of the selection.
  selection_set(self, first, last=None)
Set the selection from FIRST to LAST (not included) without changing the currently selected elements.
  size(self)
Return the number of elements in the listbox.
  xview(self, *what)
Query and change horizontal position of the view.
  xview_moveto(self, fraction)
Adjust the view in the window so that FRACTION of the total width of the entry is off-screen to the left.
  xview_scroll(self, number, what)
Shift the x-view according to NUMBER which is measured in "units" or "pages" (WHAT).
  yview(self, *what)
Query and change vertical position of the view.
  yview_moveto(self, fraction)
Adjust the view in the window so that FRACTION of the total width of the entry is off-screen to the top.
  yview_scroll(self, number, what)
Shift the y-view according to NUMBER which is measured in "units" or "pages" (WHAT).

Inherited from BaseWidget: destroy

Inherited from BaseWidget (private): _do, _setup

Inherited from Misc: __getitem__, __setitem__, __str__, after, after_cancel, after_idle, bell, bind, bind_all, bind_class, bindtags, cget, clipboard_append, clipboard_clear, 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_get, selection_handle, selection_own, selection_own_get, send, setvar, 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 Pack: forget, info, pack, pack_configure, pack_forget, pack_info

Inherited from Place: place, place_configure, place_forget, place_info

Inherited from Grid: grid, grid_configure, grid_forget, grid_info, grid_remove, location


Class Variables [hide private]

Inherited from Misc: _noarg_

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


Method Details [hide private]

__init__(self, master=None, cnf={}, **kw)
(Constructor)

source code 

Construct a listbox widget with the parent MASTER.

Valid resource names: background, bd, bg, borderwidth, cursor, exportselection, fg, font, foreground, height, highlightbackground, highlightcolor, highlightthickness, relief, selectbackground, selectborderwidth, selectforeground, selectmode, setgrid, takefocus, width, xscrollcommand, yscrollcommand, listvariable.
Overrides: BaseWidget.__init__

activate(self, index)

source code 
Activate item identified by INDEX.

bbox(self, *args)

source code 
Return a tuple of X1,Y1,X2,Y2 coordinates for a rectangle which encloses the item identified by index in ARGS.
Overrides: Misc.grid_bbox

curselection(self)

source code 
Return list of indices of currently selected item.

delete(self, first, last=None)

source code 
Delete items from FIRST to LAST (not included).

get(self, first, last=None)

source code 
Get list of items from FIRST to LAST (not included).

index(self, index)

source code 
Return index of item identified with INDEX.

insert(self, index, *elements)

source code 
Insert ELEMENTS at INDEX.

itemcget(self, index, option)

source code 
Return the resource value for an ITEM and an OPTION.

itemconfig(self, index, cnf=None, **kw)

source code 

Configure resources of an ITEM.

The values for resources are specified as keyword arguments. To get an overview about the allowed keyword arguments call the method without arguments. Valid resource names: background, bg, foreground, fg, selectbackground, selectforeground.

itemconfigure(self, index, cnf=None, **kw)

source code 

Configure resources of an ITEM.

The values for resources are specified as keyword arguments. To get an overview about the allowed keyword arguments call the method without arguments. Valid resource names: background, bg, foreground, fg, selectbackground, selectforeground.

nearest(self, y)

source code 
Get index of item which is nearest to y coordinate Y.

scan_dragto(self, x, y)

source code 
Adjust the view of the listbox to 10 times the difference between X and Y and the coordinates given in scan_mark.

scan_mark(self, x, y)

source code 
Remember the current X, Y coordinates.

see(self, index)

source code 
Scroll such that INDEX is visible.

select_anchor(self, index)

source code 
Set the fixed end oft the selection to INDEX.

select_clear(self, first, last=None)

source code 
Clear the selection from FIRST to LAST (not included).

select_includes(self, index)

source code 
Return 1 if INDEX is part of the selection.

select_set(self, first, last=None)

source code 
Set the selection from FIRST to LAST (not included) without changing the currently selected elements.

selection_anchor(self, index)

source code 
Set the fixed end oft the selection to INDEX.

selection_clear(self, first, last=None)

source code 
Clear the selection from FIRST to LAST (not included).
Overrides: Misc.selection_clear

selection_includes(self, index)

source code 
Return 1 if INDEX is part of the selection.

selection_set(self, first, last=None)

source code 
Set the selection from FIRST to LAST (not included) without changing the currently selected elements.

size(self)

source code 
Return the number of elements in the listbox.
Overrides: Misc.grid_size

xview(self, *what)

source code 
Query and change horizontal position of the view.

xview_moveto(self, fraction)

source code 
Adjust the view in the window so that FRACTION of the total width of the entry is off-screen to the left.

xview_scroll(self, number, what)

source code 
Shift the x-view according to NUMBER which is measured in "units" or "pages" (WHAT).

yview(self, *what)

source code 
Query and change vertical position of the view.

yview_moveto(self, fraction)

source code 
Adjust the view in the window so that FRACTION of the total width of the entry is off-screen to the top.

yview_scroll(self, number, what)

source code 
Shift the y-view according to NUMBER which is measured in "units" or "pages" (WHAT).