How to use combobox widget to display a drop-down list with autocomplete functionality in Tkinter Python?

by Abdul Rawoof A R Updated: Jul 11, 2023

Solution Kit

A Tkinter Combobox is a widget in the Tkinter library of Python. It combines the functionalities of an entry field and a dropdown list. It allows selecting an option from a predefined list of values or entering a custom value. The Combobox uses a graphical user interface (GUI) element in desktop applications.

There are several comboboxes you can use, including text, checkbox, and list boxes. Here's a brief explanation of each type:

Text Combobox:

The text combobox is also known as a dropdown or a simple combobox. It allows the user to select an option from a predefined list. A list of options is displayed when the combobox is clicked or activated. Then the user can choose one option by clicking on it. The selected option is then displayed in the combobox. This is the most common type of combobox used in Tkinter.

Checkbox Combobox:

A checkbox combobox is a specialized text version where the options are checkboxes. The user can select many options by checking the corresponding checkboxes. This combobox type is useful when allowing users to select many choices from a list.

Listbox Combobox:

The listbox combobox is also known as a dropdown list or a list combobox. It displays a list of options in a dropdown format. But, unlike the text combobox, the listbox combobox displays all the options simultaneously. It does without requiring the user to click or activate the dropdown. The user selects one or more options from the list using the mouse or keyboard.

When it comes to populating combobox, the methods depend on your framework. But I can provide you with some general methods that are used to populate a combobox. These methods include using the set() and get() methods. Let's explore them:

Using the set() and get() methods:

set(): This method sets the current value of the combobox. You can use it to set a default or initial value for the combobox.
get(): This method retrieves the currently selected value from the combobox. You can use it to retrieve the selected value for further processing.

Adding items manually:

You can manually add items to the combobox using the addItem() or add() method. You provide the items one by one as parameters to the method.

Populating from a list or array:

You can populate the combobox by providing a list or array of items using a specific method or property.

Populating from a data source:

If you have a data source like a database or an API, you can retrieve the data and populate the combobox.

Using data binding:

You can bind the combobox to a data source in some frameworks or libraries. Any changes in the data source will reflect in the combobox.

The tkinter.ttk module offers access to the Tk-themed widget set included in Tk 8.5 and greater. The basic idea is to separate the code-implementing behavior from its appearance. This has the advantage of using the new widgets, giving platforms a better look and feel.

But, the replacement widgets are only partially compatible. The ttk package, a unique modification of Python Tkinter, introduces this extra component. The tkinter module is available in Python standard library. It has to be imported while writing a program in Python to generate a GUI. Methods on a ttk include all those described in Section 46, Methods common to all ttk widgets. Also, all the methods on the Tkinter widget are described in Section 10, The widget, plus.

The Tkinter Combobox is a UI widget available in the Tkinter library. It serves the purpose of selecting values from a dropdown list. The difference is that widget options for styling are no longer present in Ttk widgets. We start this code by importing the module in the same Python file as tk and importing the ttk class of it.

Here is an example of using the combobox widget to display a dropdown list. Using the autocomplete functionality in Tkinter Python:

Fig: Preview of the output that you will get on running this code from your IDE.

Code

In this solution, we are using Tkinter library.

Python Tkinter Autocomplete combobox with LIKE search?

PythonLines of Code : 64License : Strong Copyleft (CC BY-SA 4.0)

Dependent Libraries :

 if self.get().lower() in element.lower():

 if element.lower().startswith(self.get().lower()):

#!/usr/bin/env python3

import tkinter as tk

def on_keyrelease(event):

    # get text from entry
    value = event.widget.get()
    value = value.strip().lower()

    # get data from test_list
    if value == '':
        data = test_list
    else:
        data = []
        for item in test_list:
            if value in item.lower():
                data.append(item)                

    # update data in listbox
    listbox_update(data)


def listbox_update(data):
    # delete previous data
    listbox.delete(0, 'end')

    # sorting data 
    data = sorted(data, key=str.lower)

    # put new data
    for item in data:
        listbox.insert('end', item)


def on_select(event):
    # display element selected on list
    print('(event) previous:', event.widget.get('active'))
    print('(event)  current:', event.widget.get(event.widget.curselection()))
    print('---')


# --- main ---

test_list = ('apple', 'banana', 'Cranberry', 'dogwood', 'alpha', 'Acorn', 'Anise', 'Strawberry' )

root = tk.Tk()

entry = tk.Entry(root)
entry.pack()
entry.bind('<KeyRelease>', on_keyrelease)

listbox = tk.Listbox(root)
listbox.pack()
#listbox.bind('<Double-Button-1>', on_select)
listbox.bind('<<ListboxSelect>>', on_select)
listbox_update(test_list)

root.mainloop()

Instructions

Follow the steps carefully to get the output easily.

Install PyCharm Community Edition on your computer.
Open terminal and install the required libraries with following commands.
Install Tkinter - pip install tkinter.
Create a new Python file(eg: test.py).
Copy the snippet using the 'copy' button and paste it into that file(remove first three lines of code after pasting).
Run the file using run button.

I hope you found this useful. I have added the link to dependent libraries, version information in the following sections.

I found this code snippet by searching for 'python tkinter autocomplete combobox' in kandi. You can try any such use case!

Environment Tested

I tested this solution in the following versions. Be mindful of changes when working with other versions.

The solution is created in PyCharm 2022.3.3.
The solution is tested on Python 3.9.7.
Tkinter version 1.0.7.

Using this solution, we are able to use the Combobox widget to display a drop-down list with autocomplete functionality in Tkinter Python with simple steps. This process also facilities an easy way to use, hassle-free method to create a hands-on working version of code which would help us to use the Combobox widget to display a drop-down list with autocomplete functionality in Tkinter Python.

Dependent Library

Tkinter-Designerby ParthJadhav

Python

5885

Version:v1.0.7

License: Permissive (BSD-3-Clause)

An easy and fast way to create a Python GUI 🐍

Support

Quality

Security

License

Reuse

Tkinter-Designerby ParthJadhav

Python 5885 Version:v1.0.7 License: Permissive (BSD-3-Clause)

An easy and fast way to create a Python GUI 🐍

Support

Quality

Security

License

Reuse

You can also search for any dependent libraries on kandi like 'Tkinter'.

FAQ:

1. What is tkinter import ttk, and how does it help create Combobox Tkinter?

In Tkinter, ttk stands for "themed Tkinter". It is a module that provides themed widget classes. It enhances the appearance of the standard Tkinter widgets. It is an extension module built on top of the tkinter module.
The ttk module includes a class called Combobox. It is an enhanced version of the standard Tkinter Entry widget. It allows the user to select from a dropdown list of predefined values. The Combobox widget combines the functionality of an Entry and a Listbox widget.
You should import both modules to create a Combobox widget using Tkinter and ttk. It uses the Combobox class from the ttk module.

2. What are the different types of Ttk widgets available in Combobox Tkinter?

Here are the different types of Ttk widgets available for use in a Combobox in Tkinter:

TCombobox.
"TCombobox" with "read-only" attribute.
"TCombobox" with "values" attribute.
"TCombobox" with autocompletion.

3. How do combobox widgets differ from other GUI elements (e.g., buttons)?

A combobox widget is also known as a dropdown list or a combo box. It is a graphical user interface (GUI) element that combines the functionality of a text box and a list box. It allows selecting an option from a predefined list of choices. The main difference between combobox widgets lies in their purpose and behavior.

4. What are the pros and cons of using a dropdown list?

Advantages of using a dropdown list:

Compact and space-efficient.
Clear selection indication.
Convenient for small option sets.
Restrictive selection.

Disadvantages of using a dropdown list:

Limited visibility of options.
Scrolling with large option sets.
Limited customization.
Lack of multiple selections.

5. How can I retrieve the selected option from my combobox widget?

The method to retrieve the selected item from a combobox widget depends on the framework. You can retrieve the selected option using JavaScript and jQuery.

Support

For any support on kandi solution kits, please use the chat
For further learning resources, visit the Open Weaver Community learning page.

See similar Kits and Libraries

Open Weaver – Develop Applications Faster with Open Source

Terms
Privacy policy

How to use combobox widget to display a drop-down list with autocomplete functionality in Tkinter Python?

Text Combobox:

Checkbox Combobox:

Listbox Combobox:

Using the set() and get() methods:

Adding items manually:

Populating from a list or array:

Populating from a data source:

Using data binding:

Code

Instructions

Environment Tested

Dependent Library

FAQ:

Support

Open Weaver – Develop Applications Faster with Open Source

kandi

Community and Support

Company

Follow