Tkinter 8.4 reference: a
GUI for Python
John W. Shipman
2010-08-29 12:54
Abstract
Describes the Tkinter widget set for constructing graphical user interfaces (GUIs) in the Python
programming language.
This publication is available in Web form1 and also as a PDF document2. Please forward any
comments to tcc-doc@nmt.edu.
Table of Contents
1. What is Tkinter? ....................................................................................................................... 3
2. A minimal application .............................................................................................................. 3
3. Definitions .............................................................................................................................. 4
4. Layout management ................................................................................................................. 5
4.1. The .grid() method .................................................................................................... 5
4.2. Other grid management methods ................................................................................... 6
4.3. Configuring column and row sizes ................................................................................. 7
4.4. Making the root window resizeable ................................................................................ 8
5. Standard attributes ................................................................................................................... 8
5.1. Dimensions ................................................................................................................... 9
5.2. The coordinate system ................................................................................................... 9
5.3. Colors ........................................................................................................................... 9
5.4. Type fonts ................................................................................................................... 10
5.5. Anchors ...................................................................................................................... 11
5.6. Relief styles ................................................................................................................. 12
5.7. Bitmaps ....................................................................................................................... 12
5.8. Cursors ....................................................................................................................... 12
5.9. Images ........................................................................................................................ 14
5.10. Geometry strings ........................................................................................................ 14
5.11. Window names ........................................................................................................... 15
5.12. Cap and join styles ..................................................................................................... 15
5.13. Dash patterns ............................................................................................................. 16
5.14. Matching stipple patterns ............................................................................................ 16
6. The Button widget ................................................................................................................ 17
7. The Canvas widget ................................................................................................................ 19
7.1. Canvas coordinates ...................................................................................................... 20
7.2. The Canvas display list ................................................................................................ 20
7.3. Canvas object IDs ........................................................................................................ 21
7.4. Canvas tags ................................................................................................................ 21
1 http://www.nmt.edu/tcc/help/pubs/tkinter/
2 http://www.nmt.edu/tcc/help/pubs/tkinter/tkinter.pdf
New Mexico Tech Computer Center
Tkinter reference
1
7.5. Canvas tagOrId arguments ...................................................................................... 21
7.6. Methods on Canvas widgets ........................................................................................ 21
7.7. Canvas arc objects ....................................................................................................... 26
7.8. Canvas bitmap objects ................................................................................................. 28
7.9. Canvas image objects .................................................................................................. 29
7.10. Canvas line objects ..................................................................................................... 29
7.11. Canvas oval objects .................................................................................................... 31
7.12. Canvas polygon objects .............................................................................................. 32
7.13. Canvas rectangle objects ............................................................................................. 34
7.14. Canvas text objects ..................................................................................................... 35
7.15. Canvas window objects .............................................................................................. 36
8. The Checkbutton widget ...................................................................................................... 37
9. The Entry widget .................................................................................................................. 40
9.1. Scrolling an Entry widget ............................................................................................ 43
10. The Frame widget ................................................................................................................ 43
11. The Label widget ................................................................................................................ 44
12. The LabelFrame widget ...................................................................................................... 46
13. The Listbox widget ............................................................................................................ 48
13.1. Scrolling a Listbox widget ........................................................................................ 52
14. The Menu widget .................................................................................................................. 52
14.1. Menu item creation (coption) options ......................................................................... 55
14.2. Top-level menus ......................................................................................................... 56
15. The Menubutton widget ...................................................................................................... 57
16. The Message widget ............................................................................................................ 59
17. The OptionMenu widget ....................................................................................................... 60
18. The PanedWindow widget .................................................................................................... 61
18.1. PanedWindow child configuration options ................................................................... 63
19. The Radiobutton widget .................................................................................................... 64
20. The Scale widget ................................................................................................................ 67
21. The Scrollbar widget ........................................................................................................ 70
21.1. The Scrollbar command callback ............................................................................ 72
21.2. Connecting a Scrollbar to another widget ................................................................ 73
22. The Spinbox widget ............................................................................................................ 73
23. The Text widget .................................................................................................................. 78
23.1. Text widget indices ................................................................................................... 80
23.2. Text widget marks .................................................................................................... 81
23.3. Text widget images ................................................................................................... 82
23.4. Text widget windows ............................................................................................... 82
23.5. Text widget tags ....................................................................................................... 82
23.6. Setting tabs in a Text widget ...................................................................................... 83
23.7. The Text widget undo/redo stack .............................................................................. 83
23.8. Methods on Text widgets .......................................................................................... 84
24. Toplevel: Top-level window methods .................................................................................. 91
25. Universal widget methods ..................................................................................................... 93
26. Standardizing appearance ................................................................................................... 101
26.1. How to name a widget class ...................................................................................... 102
26.2. How to name a widget instance ................................................................................. 102
26.3. Resource specification lines ....................................................................................... 102
26.4. Rules for resource matching ...................................................................................... 103
27. Connecting your application logic to the widgets ................................................................... 104
28. Control variables: the values behind the widgets ................................................................... 104
29. Focus: routing keyboard input ............................................................................................. 106
2
Tkinter reference
New Mexico Tech Computer Center
30. Events ................................................................................................................................ 107
30.1. Levels of binding ...................................................................................................... 108
30.2. Event sequences ....................................................................................................... 109
30.3. Event types .............................................................................................................. 109
30.4. Event modifiers ........................................................................................................ 110
30.5. Key names ............................................................................................................... 111
30.6. Writing your handler: The Event class ...................................................................... 113
30.7. The extra arguments trick .......................................................................................... 115
30.8. Virtual events ........................................................................................................... 116
31. Pop-up dialogs .................................................................................................................... 116
31.1. The tkMessageBox dialogs module .......................................................................... 116
31.2. The tkFileDialog module ..................................................................................... 118
31.3. The tkColorChooser module ................................................................................. 119
1. What is Tkinter?
Tkinter is a GUI (graphical user interface) widget set for Python. This document contains only the
commoner features.
This document applies to Python 2.5 and Tkinter 8.4 running in the X Window system under Linux.
Your version may vary.
Pertinent references:
• Fredrik Lundh, who wrote Tkinter, has two versions of his An Introduction to Tkinter: a more complete
1999 version3 and a 2005 version4 that presents a few newer features.
• Python and Tkinter Programming by John Grayson (Manning, 2000, ISBN 1-884777-81-3) is out of print,
but has many useful examples and also discusses an extension package called Pmw: Python megaw-
idgets5.
• Python 2.5 quick reference6: general information about the Python language.
• For an example of a sizeable working application (around 1000 lines of code), see huey: A color and
font selection tool7.
We'll start by looking at the visible part of Tkinter: creating the widgets and arranging them on the
screen. Later we will talk about how to connect the face—the “front panel”—of the application to the
logic behind it.
2. A minimal application
Here is a trivial Tkinter program containing only a Quit button:
#!/usr/local/bin/python
from Tkinter import *
class Application(Frame):
def __init__(self, master=None):
3 http://www.pythonware.com/library/tkinter/introduction/
4 http://effbot.org/tkinterbook/
5 http://pmw.sourceforge.net/
6 http://www.nmt.edu/tcc/help/pubs/python/web/
7 http://www.nmt.edu/tcc/help/lang/python/examples/huey/
New Mexico Tech Computer Center
Tkinter reference
3
123
Frame.__init__(self, master)
self.grid()
self.createWidgets()
def createWidgets(self):
self.quitButton = Button ( self, text='Quit',
command=self.quit )
self.quitButton.grid()
app = Application()
app.master.title("Sample application")
app.mainloop()
This line makes the script self-executing, assuming that your system has the Python interpreter at
path /usr/local/bin/python.
This line imports the entire Tkinter package into your program's namespace.
Your application class must inherit from Tkinter's Frame class.
Calls the constructor for the parent class, Frame.
Necessary to make the application actually appear on the screen.
Creates a button labeled “Quit”.
Places the button on the application.
The main program starts here by instantiating the Application class.
This method call sets the title of the window to “Sample application”.
Starts the application's main loop, waiting for mouse and keyboard events.
3. Definitions
Before we proceed, let's define some of the common terms.
window
This term has different meanings in different contexts, but in general it refers to a rectangular area
somewhere on your display screen.
top-level window
A window that exists independently on your screen. It will be decorated with the standard frame
and controls for your system's desktop manager. You can move it around on your desktop. You
can generally resize it, although your application can prevent this
widget
The generic term for any of the building blocks that make up an application in a graphical user in-
terface. Examples of widgets: buttons, radiobuttons, text fields, frames, and text labels.
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, 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.
4
Tkinter reference
New Mexico Tech Computer Center
4567891012345678910
4. Layout management
Later we will discuss the widgets, the building blocks of your GUI application. How do widgets get
arranged in a window?
Although there are three different “geometry managers” in Tkinter, the author strongly prefers the
.grid() geometry manager for pretty much everything. This manager treats every window or frame
as a table—a gridwork of rows and columns.
• A cell is the area at the intersection of one row and one column.
• The width of each column is the width of the widest cell in that column.
• The height of each row is the height of the largest cell in that row.
• For widgets that do not fill the entire cell, you can specify what happens to the extra space. You can
either leave the extra space outside the widget, or stretch the widget to fit it, in either the horizontal
or vertical dimension.
• You can combine multiple cells into one larger area, a process called spanning.
When you create a widget, it does not appear until you register it with a geometry manager. Hence,
construction and placing of a widget is a two-step process that goes something like this:
self.thing = Constructor(parent, ...)
self.thing.grid(...)
where Constructor is one of the widget classes like Button, Frame, and so on, and parent is the
parent widget in which this child widget is being constructed. All widgets have a .grid() method
that you can use to tell the geometry manager where to put it.
4.1. The .grid() method
To display a widget w on your application screen:
w.grid(option=value, ...)
This method registers a widget w with the grid geometry manager—if you don't do this, the widget will
exist internally, but it will not be visible on the screen.
Here are the options to the .grid() geometry management method:
column
columnspan
in_
ipadx
ipady
padx
The column number where you want the widget gridded, counting from zero. The default
value is zero.
Normally a widget occupies only one cell in the grid. However, you can grab multiple
cells of a row and merge them into one larger cell by setting the columnspan option to
the number of cells. For example, w.grid(row=0, column=2, columnspan=3)
would place widget w in a cell that spans columns 2, 3, and 4 of row 0.
To register w as a child of some widget w2, use in_=w2. The new parent w2 must be a
descendant of the parent widget used when w was created.
Internal x padding. This dimension is added inside the widget inside its left and right
sides.
Internal y padding. This dimension is added inside the widget inside its top and bottom
borders.
External x padding. This dimension is added to the left and right outside the widget.
New Mexico Tech Computer Center
Tkinter reference
5
pady
row
rowspan
sticky
External y padding. This dimension is added above and below the widget.
The row number into which you want to insert the widget, counting from 0. The default
is the next higher-numbered unoccupied row.
Normally a widget occupies only one cell in the grid. You can grab multiple adjacent
cells of a column, however, by setting the rowspan option to the number of cells to grab.
This option can be used in combination with the columnspan option to grab a block of
cells. For example, w.grid(row=3, column=2, rowspan=4, columnspan=5)
would place widget w in an area formed by merging 20 cells, with row numbers 3–6 and
column numbers 2–6.
This option determines how to distribute any extra space within the cell that is not taken
up by the widget at its natural size. See below.
• If you do not provide a sticky attribute, the default behavior is to center the widget in the cell.
• You can position the widget in a corner of the cell by using sticky=NE (top right), SE (bottom right),
SW (bottom left), or NW (top left).
• You can position the widget centered against one side of the cell by using sticky=N (top center), E
(right center), S (bottom center), or W (left center).
• Use sticky=N+S to stretch the widget vertically but leave it centered horizontally.
• Use sticky=E+W to stretch it horizontally but leave it centered vertically.
• Use sticky=N+E+S+W to stretch the widget both horizontally and vertically to fill the cell.
• The other combinations will also work. For example, sticky=N+S+W will stretch the widget vertically
and place it against the west (left) wall.
4.2. Other grid management methods
These grid-related methods are defined on all widgets:
w.grid_bbox ( column=None, row=None, col2=None, row2=None )
Returns a 4-tuple describing the bounding box of some or all of the grid system in widget w. The
first two numbers returned are the x and y coordinates of the upper left corner of the area, and the
second two numbers are the width and height.
If you pass in column and row arguments, the returned bounding box describes the area of the cell
at that column and row. If you also pass in col2 and row2 arguments, the returned bounding box
describes the area of the grid from columns column to col2 inclusive, and from rows row to row2
inclusive.
For example, w.grid_bbox(0, 0, 1, 1) returns the bounding box of four cells, not one.
w.grid_forget()
This method makes widget w disappear from the screen. It still exists, it just isn't visible. You can
use .grid() it to make it appear again, but it won't remember its grid options.
w.grid_info()
Returns a dictionary whose keys are w's option names, with the corresponding values of those options.
w.grid_location ( x, y )
Given a coordinates (x, y) relative to the containing widget, this method returns a tuple (col,
row) describing what cell of w's grid system contains that screen coordinate.
6
Tkinter reference
New Mexico Tech Computer Center
w.grid_propagate()
Normally, all widgets propagate their dimensions, meaning that they adjust to fit the contents.
However, sometimes you want to force a widget to be a certain size, regardless of the size of its
contents. To do this, call w.grid_propagate(0) where w is the widget whose size you want to
force.
w.grid_remove()
This method is like .grid_forget(), but its grid options are remembered, so if you .grid() it
again, it will use the same grid configuration options.
w.grid_size()
Returns a 2-tuple containing the number of columns and the number of rows, respectively, in w's
grid system.
w.grid_slaves ( row=None, column=None )
Returns a list of the widgets managed by widget w. If no arguments are provided, you will get a
list of all the managed widgets. Use the row= argument to select only the widgets in one row, or
the column= argument to select only the widgets in one column.
4.3. Configuring column and row sizes
Unless you take certain measures, the width of a grid column inside a given widget will be equal to the
width of its widest cell, and the height of a grid row will be the height of its tallest cell. The sticky
attribute on a widget controls only where it will be placed if it doesn't completely fill the cell.
If you want to override this automatic sizing of columns and rows, use these methods on the parent
widget w that contains the grid layout:
w.columnconfigure ( N, option=value, ... )
In the grid layout inside widget w, configure column N so that the given option has the given
value. For options, see the table below.
w.rowconfigure ( N, option=value, ... )
In the grid layout inside widget w, configure row N so that the given option has the given value.
For options, see the table below.
Here are the options used for configuring column and row sizes.
minsize
pad
weight
The column or row's minimum size in pixels. If there is nothing in the given column or
row, it will not appear, even if you use this option.
A number of pixels that will be added to the given column or row, over and above the
largest cell in the column or row.
To make a column or row stretchable, use this option and supply a value that gives the
relative weight of this column or row when distributing the extra space. For example, if
a widget w contains a grid layout, these lines will distribute three-fourths of the extra
space to the first column and one-fourth to the second column:
w.columnconfigure(0, weight=3)
w.columnconfigure(1, weight=1)
If this option is not used, the column or row will not stretch.
New Mexico Tech Computer Center
Tkinter reference
7
4.4. Making the root window resizeable
Do you want to let the user resize your entire application window, and distribute the extra space among
its internal widgets? This requires some operations that are not obvious.
It's necessary to use the techniques for row and column size management, described in Section 4.3,
“Configuring column and row sizes” (p. 7), to make your Application widget's grid stretchable.
However, that alone is not sufficient.
Consider the trivial application discussed in Section 2, “A minimal application” (p. 3), which contains
only a Quit button. If you run this application, and resize the window, the button stays the same size,
centered within the window.
Here is a replacement version of the .__createWidgets() method in the minimal application. In
this version, the Quit button always fills all the available space.
def createWidgets(self):
top=self.winfo_toplevel()
top.rowconfigure(0, weight=1)
top.columnconfigure(0, weight=1)
self.rowconfigure(0, weight=1)
self.columnconfigure(0, weight=1)
self.quit = Button ( self, text="Quit", command=self.quit )
self.quit.grid(row=0, column=0,
sticky=N+S+E+W)
The “top level window” is the outermost window on the screen. However, this window is not your
Application window—it is the parent of the Application instance. To get the top-level window,
call the .winfo_toplevel() method on any widget in your application; see Section 25, “Universal
widget methods” (p. 93).
This line makes row 0 of the top level window's grid stretchable.
This line makes column 0 of the top level window's grid stretchable.
Makes row 0 of the Application widget's grid stretchable.
Makes column 0 of the Application widget's grid stretchable.
The argument sticky=N+S+E+W makes the button expand to fill its cell of the grid.
There is one more change that must be made. In the constructor, change the second line as shown:
def __init__(self, master=None):
Frame.__init__(self, master)
self.grid(sticky=N+S+E+W)
self.createWidgets()
The argument sticky=N+S+E+W to self.grid() is necessary so that the Application widget will
expand to fill its cell of the top-level window's grid.
5. Standard attributes
Before we look at the widgets, let's take a look at how some of their common attributes—such as sizes,
colors and fonts—are specified.
• Each widget has a set of options that affect its appearance and behavior—attributes such as fonts,
colors, sizes, text labels, and such.
8
Tkinter reference
New Mexico Tech Computer Center
123456123456