Tkinter · Lablypedia

The name Tkinter comes from Tk interface. Tkinter was written by Steen Lumholt and Guido van Rossum, then later revised by Fredrik Lundh.

Tkinter is free software released under a Python license.

Description

As with most other modern Tk bindings, Tkinter is implemented as a Python wrapper around a complete Tcl interpreter embedded in the Python interpreter. Tkinter calls are translated into Tcl commands, which are fed to this embedded interpreter, thus making it possible to mix Python and Tcl in a single application. The official Python release uses Tcl/Tk 8.6 (rather than the more up-to-date 9.0).

There are several popular GUI library alternatives available, such as Kivy, Pygame, Pyglet, PyGObject, PyQt, PySide, and wxPython.

Definitions

<span id="mwQQ"></span><span class="kn" id="mwQg">from</span><span class="w" id="mwQw"> </span><span class="nn" id="mwRA">tkinter</span><span class="w" id="mwRQ"> </span><span class="kn" id="mwRg">import</span> <span class="o" id="mwRw">*</span> <span class="k" id="mwSA">def</span><span class="w" id="mwSQ"> </span><span class="nf" id="mwSg">calculate</span><span class="p" id="mwSw">():</span> <span class="n" id="mwTA">price</span> <span class="o" id="mwTQ">=</span> <span class="nb" id="mwTg">float</span><span class="p" id="mwTw">(</span><span class="n" id="mwUA">entry_price</span><span class="o" id="mwUQ">.</span><span class="n" id="mwUg">get</span><span class="p" id="mwUw">())</span> <span class="n" id="mwVA">qty</span> <span class="o" id="mwVQ">=</span> <span class="nb" id="mwVg">float</span><span class="p" id="mwVw">(</span><span class="n" id="mwWA">entry_qty</span><span class="o" id="mwWQ">.</span><span class="n" id="mwWg">get</span><span class="p" id="mwWw">())</span> <span class="n" id="mwXA">total</span> <span class="o" id="mwXQ">=</span> <span class="n" id="mwXg">price</span> <span class="o" id="mwXw">*</span> <span class="n" id="mwYA">qty</span> <span class="n" id="mwYQ">label_result</span><span class="o" id="mwYg">.</span><span class="n" id="mwYw">config</span><span class="p" id="mwZA">(</span><span class="n" id="mwZQ">text</span><span class="o" id="mwZg">=</span><span class="s2" id="mwZw">"Total: "</span> <span class="o" id="mwaA">+</span> <span class="nb" id="mwaQ">str</span><span class="p" id="mwag">(</span><span class="n" id="mwaw">total</span><span class="p" id="mwbA">))</span> <span class="n" id="mwbQ">app</span> <span class="o" id="mwbg">=</span> <span class="n" id="mwbw">Tk</span><span class="p" id="mwcA">()</span> <span class="n" id="mwcQ">app</span><span class="o" id="mwcg">.</span><span class="n" id="mwcw">title</span><span class="p" id="mwdA">(</span><span class="s2" id="mwdQ">"Facturation App"</span><span class="p" id="mwdg">)</span> <span class="n" id="mwdw">Label</span><span class="p" id="mweA">(</span><span class="n" id="mweQ">app</span><span class="p" id="mweg">,</span> <span class="n" id="mwew">text</span><span class="o" id="mwfA">=</span><span class="s2" id="mwfQ">"Prix"</span><span class="p" id="mwfg">)</span><span class="o" id="mwfw">.</span><span class="n" id="mwgA">pack</span><span class="p" id="mwgQ">()</span> <span class="n" id="mwgg">entry_price</span> <span class="o" id="mwgw">=</span> <span class="n" id="mwhA">Entry</span><span class="p" id="mwhQ">(</span><span class="n" id="mwhg">app</span><span class="p" id="mwhw">)</span> <span class="n" id="mwiA">entry_price</span><span class="o" id="mwiQ">.</span><span class="n" id="mwig">pack</span><span class="p" id="mwiw">()</span> <span class="n" id="mwjA">Label</span><span class="p" id="mwjQ">(</span><span class="n" id="mwjg">app</span><span class="p" id="mwjw">,</span> <span class="n" id="mwkA">text</span><span class="o" id="mwkQ">=</span><span class="s2" id="mwkg">"Quantité"</span><span class="p" id="mwkw">)</span><span class="o" id="mwlA">.</span><span class="n" id="mwlQ">pack</span><span class="p" id="mwlg">()</span> <span class="n" id="mwlw">entry_qty</span> <span class="o" id="mwmA">=</span> <span class="n" id="mwmQ">Entry</span><span class="p" id="mwmg">(</span><span class="n" id="mwmw">app</span><span class="p" id="mwnA">)</span> <span class="n" id="mwnQ">entry_qty</span><span class="o" id="mwng">.</span><span class="n" id="mwnw">pack</span><span class="p" id="mwoA">()</span> <span class="n" id="mwoQ">Button</span><span class="p" id="mwog">(</span><span class="n" id="mwow">app</span><span class="p" id="mwpA">,</span> <span class="n" id="mwpQ">text</span><span class="o" id="mwpg">=</span><span class="s2" id="mwpw">"Calculer"</span><span class="p" id="mwqA">,</span> <span class="n" id="mwqQ">command</span><span class="o" id="mwqg">=</span><span class="n" id="mwqw">calculate</span><span class="p" id="mwrA">)</span><span class="o" id="mwrQ">.</span><span class="n" id="mwrg">pack</span><span class="p" id="mwrw">()</span> <span class="n" id="mwsA">label_result</span> <span class="o" id="mwsQ">=</span> <span class="n" id="mwsg">Label</span><span class="p" id="mwsw">(</span><span class="n" id="mwtA">app</span><span class="p" id="mwtQ">,</span> <span class="n" id="mwtg">text</span><span class="o" id="mwtw">=</span><span class="s2" id="mwuA">""</span><span class="p" id="mwuQ">)</span> <span class="n" id="mwug">label_result</span><span class="o" id="mwuw">.</span><span class="n" id="mwvA">pack</span><span class="p" id="mwvQ">()</span> <span class="n" id="mwvg">app</span><span class="o" id="mwvw">.</span><span class="n" id="mwwA">mainloop</span><span class="p" id="mwwQ">()</span>

The generic term for any of the building blocks that make up an application in a graphical user interface.

Core widgets:
- Containers:
  - frame
  - labelframe
  - toplevel
  - paned window.
- Buttons:
  - button
  - radiobutton
  - checkbutton (checkbox)
  - menubutton.
- Text widgets:
  - label,
  - message
  - text
- Entry widgets:
  - scale
  - scrollbar
  - listbox
  - slider
  - spinbox
  - entry (singleline)
  - optionmenu
  - text (multiline)
- Canvas (vector and pixel graphics)

Tkinter provides three modules that allow pop-up dialogs to be displayed: tk.messagebox (confirmation, information, warning and error dialogs), tk.filedialog (single file, multiple file and directory selection dialogs) and tk.colorchooser (colour picker).

Python 2.7 and Python 3.1 incorporate the "themed Tk" ("ttk") functionality of Tk 8.5. This allows Tk widgets to be easily themed to look like the native desktop environment in which the application is running, thereby addressing a long-standing criticism of Tk (and hence of Tkinter). Some widgets are exclusive to ttk, such as the combobox, progressbar, treeview, notebook, separator and sizegrip.

Frame

In Tkinter, the Frame widget is the basic unit of organization for complex layouts. A frame is a rectangular area that can contain other widgets.

Child and parent

When any widget is created, a parent–child relationship is created. For example, if you place a text label inside a frame, the frame is the parent of the label.

One more chapter is free with a Lably account.

Minimal application

Below is a minimal Python 3 Tkinter application with one widget:

<span id="mw_g"></span><span class="linenos" data-line="1" id="mw_w"></span><span class="ch" id="mwAQA">#!/usr/bin/env python3</span> <span class="linenos" data-line="2" id="mwAQE"></span><span class="kn" id="mwAQI">from</span><span class="w" id="mwAQM"> </span><span class="nn" id="mwAQQ">tkinter</span><span class="w" id="mwAQU"> </span><span class="kn" id="mwAQY">import</span> <span class="o" id="mwAQc">*</span> <span class="linenos" data-line="3" id="mwAQg"></span><span class="n" id="mwAQk">root</span> <span class="o" id="mwAQo">=</span> <span class="n" id="mwAQs">Tk</span><span class="p" id="mwAQw">()</span> <span class="c1" id="mwAQ0"># Create the root (base) window </span> <span class="linenos" data-line="4" id="mwAQ4"></span><span class="n" id="mwAQ8">w</span> <span class="o" id="mwARA">=</span> <span class="n" id="mwARE">Label</span><span class="p" id="mwARI">(</span><span class="n" id="mwARM">root</span><span class="p" id="mwARQ">,</span> <span class="n" id="mwARU">text</span><span class="o" id="mwARY">=</span><span class="s2" id="mwARc">"Hello, world!"</span><span class="p" id="mwARg">)</span> <span class="c1" id="mwARk"># Create a label with words</span> <span class="linenos" data-line="5" id="mwARo"></span><span class="n" id="mwARs">w</span><span class="o" id="mwARw">.</span><span class="n" id="mwAR0">pack</span><span class="p" id="mwAR4">()</span> <span class="c1" id="mwAR8"># Put the label into the window</span> <span class="linenos" data-line="6" id="mwASA"></span><span class="n" id="mwASE">root</span><span class="o" id="mwASI">.</span><span class="n" id="mwASM">mainloop</span><span class="p" id="mwASQ">()</span> <span class="c1" id="mwASU"># Start the event loop</span>

For Python 2, the only difference is the word "tkinter" in the import command will be capitalized to "Tkinter".

Process

There are four stages to creating a widget

Create: Create it within a frame
Configure: Change the widget's attributes.
Pack: Pack it into position so it becomes visible. Developers also have the option to use .grid() (row=int, column=int to define rows and columns to position the widget, defaults to 0) and .place() (relx=int or decimal, rely=int or decimal, define coordinates in the frame, or window).
Bind: Bind it to a function or event.

These are often compressed, and the order can vary.

Simple application

Using the object-oriented paradigm in Python, a simple program would be (requires Tcl version 8.6, which is not used by Python on MacOS by default):

<span id="mwAUQ"></span><span class="linenos" data-line="1" id="mwAUU"></span><span class="ch" id="mwAUY">#!/usr/bin/env python3</span> <span class="linenos" data-line="2" id="mwAUc"></span><span class="kn" id="mwAUg">import</span><span class="w" id="mwAUk"> </span><span class="nn" id="mwAUo">tkinter</span><span class="w" id="mwAUs"> </span><span class="k" id="mwAUw">as</span><span class="w" id="mwAU0"> </span><span class="nn" id="mwAU4">tk</span> <span class="linenos" data-line="3" id="mwAU8"></span> <span class="linenos" data-line="4" id="mwAVA"></span> <span class="linenos" data-line="5" id="mwAVE"></span><span class="k" id="mwAVI">class</span><span class="w" id="mwAVM"> </span><span class="nc" id="mwAVQ">Application</span><span class="p" id="mwAVU">(</span><span class="n" id="mwAVY">tk</span><span class="o" id="mwAVc">.</span><span class="n" id="mwAVg">Frame</span><span class="p" id="mwAVk">):</span> <span class="linenos" data-line="6" id="mwAVo"></span><span class="w" id="mwAVs"> </span><span class="sd" id="mwAVw">"""Application holds state for the whole app."""</span> <span class="linenos" data-line="7" id="mwAV0"></span> <span class="k" id="mwAV4">def</span><span class="w" id="mwAV8"> </span><span class="fm" id="mwAWA">__init__</span><span class="p" id="mwAWE">(</span><span class="bp" id="mwAWI">self</span><span class="p" id="mwAWM">,</span> <span class="n" id="mwAWQ">root</span><span class="o" id="mwAWU">=</span><span class="kc" id="mwAWY">None</span><span class="p" id="mwAWc">):</span> <span class="linenos" data-line="8" id="mwAWg"></span> <span class="n" id="mwAWk">tk</span><span class="o" id="mwAWo">.</span><span class="n" id="mwAWs">Frame</span><span class="o" id="mwAWw">.</span><span class="fm" id="mwAW0">__init__</span><span class="p" id="mwAW4">(</span><span class="bp" id="mwAW8">self</span><span class="p" id="mwAXA">,</span> <span class="n" id="mwAXE">root</span><span class="p" id="mwAXI">)</span> <span class="linenos" data-line="9" id="mwAXM"></span> <span class="bp" id="mwAXQ">self</span><span class="o" id="mwAXU">.</span><span class="n" id="mwAXY">grid</span><span class="p" id="mwAXc">()</span> <span class="linenos" data-line="10" id="mwAXg"></span> <span class="bp" id="mwAXk">self</span><span class="o" id="mwAXo">.</span><span class="n" id="mwAXs">createWidgets</span><span class="p" id="mwAXw">()</span> <span class="linenos" data-line="11" id="mwAX0"></span> <span class="linenos" data-line="12" id="mwAX4"></span> <span class="k" id="mwAX8">def</span><span class="w" id="mwAYA"> </span><span class="nf" id="mwAYE">createWidgets</span><span class="p" id="mwAYI">(</span><span class="bp" id="mwAYM">self</span><span class="p" id="mwAYQ">):</span> <span class="linenos" data-line="13" id="mwAYU"></span> <span class="bp" id="mwAYY">self</span><span class="o" id="mwAYc">.</span><span class="n" id="mwAYg">medialLabel</span> <span class="o" id="mwAYk">=</span> <span class="n" id="mwAYo">tk</span><span class="o" id="mwAYs">.</span><span class="n" id="mwAYw">Label</span><span class="p" id="mwAY0">(</span><span class="bp" id="mwAY4">self</span><span class="p" id="mwAY8">,</span> <span class="n" id="mwAZA">text</span><span class="o" id="mwAZE">=</span><span class="s2" id="mwAZI">"Hello World"</span><span class="p" id="mwAZM">)</span> <span class="linenos" data-line="14" id="mwAZQ"></span> <span class="bp" id="mwAZU">self</span><span class="o" id="mwAZY">.</span><span class="n" id="mwAZc">medialLabel</span><span class="o" id="mwAZg">.</span><span class="n" id="mwAZk">config</span><span class="p" id="mwAZo">(</span><span class="n" id="mwAZs">bg</span><span class="o" id="mwAZw">=</span><span class="s2" id="mwAZ0">"#00ffff"</span><span class="p" id="mwAZ4">)</span> <span class="linenos" data-line="15" id="mwAZ8"></span> <span class="bp" id="mwAaA">self</span><span class="o" id="mwAaE">.</span><span class="n" id="mwAaI">medialLabel</span><span class="o" id="mwAaM">.</span><span class="n" id="mwAaQ">grid</span><span class="p" id="mwAaU">()</span> <span class="linenos" data-line="16" id="mwAaY"></span> <span class="bp" id="mwAac">self</span><span class="o" id="mwAag">.</span><span class="n" id="mwAak">quitButton</span> <span class="o" id="mwAao">=</span> <span class="n" id="mwAas">tk</span><span class="o" id="mwAaw">.</span><span class="n" id="mwAa0">Button</span><span class="p" id="mwAa4">(</span><span class="bp" id="mwAa8">self</span><span class="p" id="mwAbA">,</span> <span class="n" id="mwAbE">text</span><span class="o" id="mwAbI">=</span><span class="s2" id="mwAbM">"Quit"</span><span class="p" id="mwAbQ">,</span> <span class="n" id="mwAbU">command</span><span class="o" id="mwAbY">=</span><span class="bp" id="mwAbc">self</span><span class="o" id="mwAbg">.</span><span class="n" id="mwAbk">quit</span><span class="p" id="mwAbo">)</span> <span class="linenos" data-line="17" id="mwAbs"></span> <span class="bp" id="mwAbw">self</span><span class="o" id="mwAb0">.</span><span class="n" id="mwAb4">quitButton</span><span class="o" id="mwAb8">.</span><span class="n" id="mwAcA">grid</span><span class="p" id="mwAcE">()</span> <span class="linenos" data-line="18" id="mwAcI"></span> <span class="linenos" data-line="19" id="mwAcM"></span> <span class="linenos" data-line="20" id="mwAcQ"></span><span class="n" id="mwAcU">app</span> <span class="o" id="mwAcY">=</span> <span class="n" id="mwAcc">Application</span><span class="p" id="mwAcg">()</span> <span class="linenos" data-line="21" id="mwAck"></span><span class="n" id="mwAco">app</span><span class="o" id="mwAcs">.</span><span class="n" id="mwAcw">root</span> <span class="o" id="mwAc0">=</span> <span class="n" id="mwAc4">tk</span><span class="o" id="mwAc8">.</span><span class="n" id="mwAdA">Tk</span><span class="p" id="mwAdE">()</span> <span class="linenos" data-line="22" id="mwAdI"></span><span class="n" id="mwAdM">app</span><span class="o" id="mwAdQ">.</span><span class="n" id="mwAdU">root</span><span class="o" id="mwAdY">.</span><span class="n" id="mwAdc">title</span><span class="p" id="mwAdg">(</span><span class="s2" id="mwAdk">"Sample application"</span><span class="p" id="mwAdo">)</span> <span class="linenos" data-line="23" id="mwAds"></span><span class="n" id="mwAdw">app</span><span class="o" id="mwAd0">.</span><span class="n" id="mwAd4">mainloop</span><span class="p" id="mwAd8">()</span>

line 1: Hashbang directive to the program launcher, allowing the selection of an appropriate interpreter executable, when self-executing.
line 2: Imports the tkinter module into your program's namespace, but renames it as tk.
line 5: The application class inherits from Tkinter's Frame class.
line 7: Defines the function that sets up the Frame.
line 8: Calls the constructor for the parent class, Frame.
line 12: Defining the widgets.
line 13: Creates a label, named MedialLabel with the text "Hello World".
line 14: Sets the MedialLabel background colour to cyan.
line 15: Places the label on the application so it is visible using the grid geometry manager method.
line 16: Creates a button labeled “Quit”.
line 17: Places the button on the application. Grid, place and pack are all methods of making the widget visible.
line 20: The main program starts here by instantiating the Application class.
line 21: Creates main window app.root as a Tk object.
line 22: This method call sets the title of the window to “Sample application”.
line 23: Starts the application's main loop, waiting for mouse and keyboard events.