Listbox

Listbox documentation

A List Box. Provide a list of values for the user to choose one or more of. Returns a list of selected rows when a window.read() is executed.

Listbox(
    values,
    default_values = None,
    select_mode = None,
    change_submits = False,
    enable_events = False,
    bind_return_key = False,
    size = (None, None),
    s = (None, None),
    disabled = False,
    justification = None,
    auto_size_text = None,
    font = None,
    no_scrollbar = False,
    horizontal_scroll = False,
    setting = None,
    background_color = None,
    text_color = None,
    highlight_background_color = None,
    highlight_text_color = None,
    sbar_trough_color = None,
    sbar_background_color = None,
    sbar_arrow_color = None,
    sbar_width = None,
    sbar_arrow_width = None,
    sbar_frame_color = None,
    sbar_relief = None,
    key = None,
    k = None,
    pad = None,
    p = None,
    tooltip = None,
    expand_x = False,
    expand_y = False,
    right_click_menu = None,
    visible = True,
    metadata = None
)

Parameter Descriptions

Name	Type	Default	Description
auto_size_text	bool	None	True if element should be the same size as the contents
background_color	str	None	color of background
bind_return_key	bool	False	If True, then the return key will cause a the Listbox to generate an event when return key is pressed
change_submits	bool	False	DO NOT USE. Only listed for backwards compat - Use enable_events instead
default_values	List[Any]	None	which values should be initially selected
disabled	bool	False	set disable state for element
enable_events	bool	False	Turns on the element specific events. Listbox generates events when an item is clicked
expand_x	bool	False	If True the element will automatically expand in the X direction to fill available space
expand_y	bool	False	If True the element will automatically expand in the Y direction to fill available space
font	(str or (str, int[, str]) or None)	None	specifies the font family, size, etc. Tuple or Single string format 'name size styles'. Styles: italic * roman bold normal underline overstrike
highlight_background_color	str	None	color of the background when an item is selected. Defaults to normal text color (a reverse look)
highlight_text_color	str	None	color of the text when an item is selected. Defaults to the normal background color (a rerverse look)
horizontal_scroll	bool	False	Controls if a horizontal scrollbar should be shown. If True a horizontal scrollbar will be shown in addition to vertical
justification	str	None	justification for items in listbox. Valid choices - left, right, center. Default is left. NOTE - on some older versions of tkinter, not available
k	str or int or tuple or object	None	Same as the Key. You can use either k or key. Which ever is set will be used.
key	str or int or tuple or object	None	Used with window.find_element and with return values to uniquely identify this element
metadata	Any	None	User metadata that can be set to ANYTHING
no_scrollbar	bool	False	Controls if a scrollbar should be shown. If True, no scrollbar will be shown
p	(int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) or int	None	Same as pad parameter. It's an alias. If EITHER of them are set, then the one that's set will be used. If BOTH are set, pad will be used
pad	(int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) or int	None	Amount of padding to put around element in pixels (left/right, top/bottom) or ((left, right), (top, bottom)) or an int. If an int, then it's converted into a tuple (int, int)
right_click_menu	List[List[ List[str] or str ]]	None	A list of lists of Menu items to show when this element is right clicked. See user docs for exact format.
s	(int, int) or (None, None) or int	(None, None)	Same as size parameter. It's an alias. If EITHER of them are set, then the one that's set will be used. If BOTH are set, size will be used
sbar_arrow_color	str	None	Scrollbar color of the arrow at the ends of the scrollbar (it looks like a button). Switches to background color when mouse is over
sbar_arrow_width	int	None	Scrollbar width of the arrow on the scrollbar. It will potentially impact the overall width of the scrollbar
sbar_background_color	str	None	Scrollbar color of the background of the arrow buttons at the ends AND the color of the "thumb" (the thing you grab and slide). Switches to arrow color when mouse is over
sbar_frame_color	str	None	Scrollbar Color of frame around scrollbar (available only on some ttk themes)
sbar_relief	str	None	Scrollbar relief that will be used for the "thumb" of the scrollbar (the thing you grab that slides). Should be a constant that is defined at starting with "RELIEF_" - RELIEF_RAISED, RELIEF_SUNKEN, RELIEF_FLAT, RELIEF_RIDGE, RELIEF_GROOVE, RELIEF_SOLID
sbar_trough_color	str	None	Scrollbar color of the trough
sbar_width	int	None	Scrollbar width in pixels
select_mode	[enum]	None	Select modes are used to determine if only 1 item can be selected or multiple and how they can be selected. Valid choices begin with "LISTBOX_SELECT_MODE_" and include: LISTBOX_SELECT_MODE_SINGLE LISTBOX_SELECT_MODE_MULTIPLE LISTBOX_SELECT_MODE_BROWSE LISTBOX_SELECT_MODE_EXTENDED
setting	Any	None	If not None, then this element will be saved in a settings file using the key for the element
size	(int, int) or (int, None) or int	(None, None)	w=characters-wide, h=rows-high. If an int instead of a tuple is supplied, then height is auto-set to 1
text_color	str	None	color of the text
tooltip	str	None	text, that will appear when mouse hovers over the element
values	List[Any] or Tuple[Any]		list of values to display. Can be any type including mixed types as long as they have str method
visible	bool	True	set visibility state of the element

Class Properties

 key
 metadata
 visible
 widget

key

Returns key for the element. This is a READONLY property. Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists)

key

Parameter Descriptions

Name	Type	Default	Description
RETURN	Any		The window's Key

metadata

Metadata is an Element property that you can use at any time to hold any value

metadata

Parameter Descriptions

Name	Type	Default	Description
RETURN	Any		the current metadata value

visible

Returns visibility state for the element. This is a READONLY property

visible

Parameter Descriptions

Name	Type	Default	Description
RETURN	bool		Visibility state for element

widget

Returns tkinter widget for the element. This is a READONLY property. The implementation is that the Widget member variable is returned. This is a backward compatible addition

widget

Parameter Descriptions

Name	Type	Default	Description
RETURN	(tkinter.Widget)		The element's underlying tkinter widget

Class Methods

 def bind
 def block_focus
 def expand
 def get
 def get_indexes
 def get_list_values
 def get_next_focus
 def get_previous_focus
 def get_size
 def grab_anywhere_exclude
 def grab_anywhere_include
 def hide_row
 def remove_tooltip
 def save_element_screenshot_to_disk
 def select_index
 def set_cursor
 def set_focus
 def set_index_color
 def set_right_click_menu
 def set_size
 def set_tooltip
 def set_value
 def set_vscroll_position
 def unbind
 def unhide_row
 def update

bind

Used to add tkinter events to an Element. The tkinter specific data is in the Element's member variable user_bind_event

bind(
    bind_string,
    key_modifier,
    propagate = True
)

Parameter Descriptions

Name	Type	Default	Description
bind_string	str		The string tkinter expected in its bind function
key_modifier	str		Additional data to be added to the element's key when event is returned
propagate	bool	True	If True then tkinter will be told to propagate the event to the element

block_focus

Enable or disable the element from getting focus by using the keyboard. If the block parameter is True, then this element will not be given focus by using the keyboard to go from one element to another. You CAN click on the element and utilize it.

block_focus(
    block = True
)

Parameter Descriptions

Name	Type	Default	Description
block	bool	True	if True the element will not get focus via the keyboard

expand

Causes the Element to expand to fill available space in the X and Y directions. Can specify which or both directions

expand(
    expand_x = False,
    expand_y = False,
    expand_row = True
)

Parameter Descriptions

Name	Type	Default	Description
expand_row	bool	True	If True the row containing the element will also expand. Without this your element is "trapped" within the row
expand_x	bool	False	If True Element will expand in the Horizontal directions
expand_y	bool	False	If True Element will expand in the Vertical directions

get

Returns the list of items currently selected in this listbox. It should be identical to the value you would receive when performing a window.read() call.

get()

Parameter Descriptions

Name	Type	Default	Description
RETURN	List[Any]		The list of currently selected items. The actual items are returned, not the indexes

get_indexes

Returns the items currently selected as a list of indexes

get_indexes()

Parameter Descriptions

Name	Type	Default	Description
RETURN	List[int]		A list of offsets into values that is currently selected

get_list_values

Returns list of Values provided by the user in the user's format

get_list_values()

Parameter Descriptions

Name	Type	Default	Description
RETURN	List[Any]		List of values. Can be any / mixed types -> []

get_next_focus

Gets the next element that should get focus after this element.

get_next_focus()

Parameter Descriptions

Name	Type	Default	Description
RETURN	Element		Element that will get focus after this one

get_previous_focus

Gets the element that should get focus previous to this element.

get_previous_focus()

Parameter Descriptions

Name	Type	Default	Description
RETURN	Element		Element that should get the focus before this one

get_size

Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method.

get_size()

Parameter Descriptions

Name	Type	Default	Description
RETURN	(int, int)		width and height of the element

grab_anywhere_exclude

Excludes this element from being used by the grab_anywhere feature Handy for elements like a Graph element when dragging is enabled. You want the Graph element to get the drag events instead of the window dragging.

grab_anywhere_exclude()

grab_anywhere_include

Includes this element in the grab_anywhere feature This will allow you to make a Multline element drag a window for example

grab_anywhere_include()

hide_row

Hide the entire row an Element is located on. Use this if you must have all space removed when you are hiding an element, including the row container

hide_row()

remove_tooltip

Removes a previiously created tooltip for an element

remove_tooltip()

save_element_screenshot_to_disk

Saves an image of the PySimpleGUI window provided into the filename provided

save_element_screenshot_to_disk(
    filename = None
)

Parameter Descriptions

Name	Type	Default	Description
RETURN	(PIL.ImageGrab or None)		A PIL ImageGrab object that can be saved or manipulated

select_index

Selects an index while providing capability to setting the selected color for the index to specific text/background color

select_index(
    index,
    highlight_text_color = None,
    highlight_background_color = None
)

Parameter Descriptions

Name	Type	Default	Description
highlight_background_color	str	None	color of the background when this item is selected
highlight_text_color	str	None	color of the text when this item is selected.
index	int		specifies which item to change. index starts at 0 and goes to length of values list minus one

set_cursor

Sets the cursor for the current Element. "Cursor" is used in 2 different ways in this call. For the parameter "cursor" it's actually the mouse pointer. If you do not want any mouse pointer, then use the string "none" For the parameter "cursor_color" it's the color of the beam used when typing into an input element

set_cursor(
    cursor = None,
    cursor_color = None
)

Parameter Descriptions

Name	Type	Default	Description
cursor	str	None	The tkinter cursor name
cursor_color	str	None	color to set the "cursor" to

set_focus

Sets the current focus to be on this element

set_focus(
    force = False
)

Parameter Descriptions

Name	Type	Default	Description
force	bool	False	if True will call focus_force otherwise calls focus_set

set_index_color

Sets the color of a specific item without selecting it

set_index_color(
    index,
    text_color = None,
    background_color = None,
    highlight_text_color = None,
    highlight_background_color = None
)

Parameter Descriptions

Name	Type	Default	Description
background_color	str	None	color of the background for this item
highlight_background_color	str	None	color of the background when this item is selected
highlight_text_color	str	None	color of the text when this item is selected.
index	int		specifies which item to change. index starts at 0 and goes to length of values list minus one
text_color	str	None	color of the text for this item

set_right_click_menu

Sets a right click menu for an element. If a menu is already set for the element, it will call the tkinter destroy method to remove it

set_right_click_menu(
    menu = None
)

Parameter Descriptions

Name	Type	Default	Description
menu	List[List[ List[str] or str ]]	None	A list of lists of Menu items to show when this element is right clicked. See user docs for exact format.

set_size

Changes the size of an element to a specific size. It's possible to specify None for one of sizes so that only 1 of the element's dimensions are changed.

set_size(
    size = (None, None)
)

Parameter Descriptions

Name	Type	Default	Description
size	(int, int)	(None, None)	The size in characters, rows typically. In some cases they are pixels

set_tooltip

Called by application to change the tooltip text for an Element. Normally invoked using the Element Object such as: window.Element('key').SetToolTip('New tip').

set_tooltip(
    tooltip_text
)

Parameter Descriptions

Name	Type	Default	Description
tooltip_text	str or None		the text to show in tooltip. If None then no tip will be shown

set_value

Set listbox highlighted choices

set_value(
    values
)

Parameter Descriptions

Name	Type	Default	Description
values	List[Any] or Tuple[Any]		new values to choose based on previously set values

set_vscroll_position

Attempts to set the vertical scroll postition for an element's Widget

set_vscroll_position(
    percent_from_top
)

Parameter Descriptions

Name	Type	Default	Description
percent_from_top	float		From 0 to 1.0, the percentage from the top to move scrollbar to

unbind

Removes a previously bound tkinter event from an Element.

unbind(
    bind_string
)

Parameter Descriptions

Name	Type	Default	Description
bind_string	str		The string tkinter expected in its bind function

unhide_row

Unhides (makes visible again) the row container that the Element is located on. Note that it will re-appear at the bottom of the window / container, most likely.

unhide_row()

update

Changes some of the settings for the Listbox Element. Must call Window.Read or Window.Finalize prior Changes will not be visible in your window until you call window.read or window.refresh.

If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper" function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there when made visible.

update(
    values = None,
    disabled = None,
    set_to_index = None,
    scroll_to_index = None,
    select_mode = None,
    visible = None
)

Parameter Descriptions

Name	Type	Default	Description
disabled	bool	None	disable or enable state of the element
scroll_to_index	int	None	scroll the listbox so that this index is the first shown
select_mode	str	None	changes the select mode according to tkinter's listbox widget
set_to_index	int or list or tuple	None	highlights the item(s) indicated. If parm is an int one entry will be set. If is a list, then each entry in list is highlighted
values	List[Any]	None	new list of choices to be shown to user
visible	bool	None	control visibility of element