tkinter — Python-интерфейс к Tcl/Tk

Как использовать этот раздел

Этот раздел разработан в двух частях: первая (приблизительно) охватывает справочный материал, а вторая может быть использована как удобная справка.

При попытке ответить на вопросы типа «как сделать что-то», часто лучше выяснить, как сделать это в чистом Tk, а затем преобразовать это обратно в соответствующий tkinter вызов. Программисты Python часто могут догадаться о правильной команде Python, посмотрев документацию Tk. Это означает, что для использования Tkinter вам нужно будет немного знать о Tk. Этот документ не может выполнить эту роль, поэтому мы можем только указать вам на лучшие существующие документации. Вот несколько подсказок:

• Авторы настоятельно рекомендуют получить копию страниц справки Tk. В частности, страницы справки в каталоге manN наиболее полезны. Страницы справки man3 описывают интерфейс C с библиотекой Tk и поэтому не очень полезны для авторов сценариев.
• Книга «Tcl и Tk Toolkit» Джона Аустерхаута, опубликованная Addison-Wesley (ISBN 0-201-63337-X), является хорошим введением в Tcl и Tk для новичков. Книга не исчерпывающая, и во многих деталях она ссылается на страницы справки.
• tkinter/__init__.py является последним средством для большинства, но может быть хорошим местом для обращения, когда ничего другого не имеет смысла.

Простая программа Hello World

import tkinter as tk

class Application(tk.Frame):
    def __init__(self, master=None):
        super().__init__(master)
        self.master = master
        self.pack()
        self.create_widgets()

    def create_widgets(self):
        self.hi_there = tk.Button(self)
        self.hi_there["text"] = "Hello World\n(click me)"
        self.hi_there["command"] = self.say_hi
        self.hi_there.pack(side="top")

        self.quit = tk.Button(self, text="QUIT", fg="red",
                              command=self.master.destroy)
        self.quit.pack(side="bottom")

    def say_hi(self):
        print("hi there, everyone!")

root = tk.Tk()
app = Application(master=root)
app.mainloop()

Параметры настройки

Параметры управляют такими аспектами, как цвет и ширина рамки виджета. Параметры можно задать тремя способами:

При создании объекта, используя ключевые аргументы

fred = Button(self, fg="red", bg="blue")

После создания объекта, используя имя параметра как индекс словаря

fred["fg"] = "red"
fred["bg"] = "blue"

Используйте метод config() для обновления нескольких атрибутов после создания объекта

fred.config(fg="red", bg="blue")

Для получения подробного объяснения заданного параметра и его поведения, см. страницы Tk man для соответствующего виджета.

Обратите внимание, что в справочных страницах указаны «ОБЩИЕ ПАРАМЕТРЫ» и «ПАРАМЕТРЫ ВИДЖЕТА». Первые представляют собой список параметров, общих для многих виджетов, а вторые — параметры, специфичные для данного виджета. Общие параметры документированы на странице man options(3).

В данном документе различие между общими и специфичными для виджета параметрами не делается. Некоторые параметры не применяются к некоторым видам виджетов. Реакция конкретного виджета на определенный параметр зависит от класса виджета; кнопки имеют параметр command, метки — нет.

Параметры, поддерживаемые данным виджетом, перечислены в справочных страницах этого виджета, или могут быть запрошены во время выполнения вызовом метода config() без аргументов, или вызовом метода keys() для этого виджета. Возвращаемое значение этих вызовов — словарь, ключом которого является имя параметра как строка (например, 'relief'), а значениями — 5-кортежи.

Некоторые параметры, такие как bg, являются синонимами для общих параметров с длинными именами (bg — сокращение для «background»). Передача метода config() имени сокращенного параметра вернёт 2-кортеж, а не 5-кортеж. 2-кортеж, возвращаемый назад, будет содержать имя синонима и «настоящий» параметр (например, ('bg', 'background')).

Пример:

>>> print(fred.config())
{'relief': ('relief', 'relief', 'Relief', 'raised', 'groove')}

Конечно, распечатанный словарь будет включать все доступные параметры и их значения. Это только пример.

Упаковщик

Упаковщик — это один из механизмов управления геометрией Tk. Менеджеры геометрии используются для указания относительного расположения виджетов в их контейнере — их общем мастере. В отличие от более громоздкого размещателя (который используется реже и не рассматривается здесь), упаковщик принимает указания на качественные отношения — над, слева от, заполнять и т.д. — и сам вычисляет точные координаты расположения.

Размер любого виджета-мастера определяется размером «дочерних виджетов» внутри него. Упаковщик используется для управления тем, где появляются дочерние виджеты внутри родительского виджета, в который они упаковываются. Вы можете упаковывать виджеты в фреймы, а фреймы в другие фреймы, чтобы добиться желаемой компоновки. Кроме того, расположение динамически корректируется для учета изменений конфигурации после упаковки.

Обратите внимание, что виджеты не появляются, пока их геометрия не будет задана с помощью менеджера геометрии. Это распространённая ошибка на ранних этапах работы — пропустить указание геометрии и затем удивляться, что виджет создан, но ничего не отображается. Виджет отобразится только после того, как к нему, например, будет применён метод pack() упаковщика.

Метод pack() можно вызывать с парами «ключевой параметр/значение», которые управляют тем, где виджет должен появиться внутри контейнера и как он должен вести себя при изменении размера основного окна приложения. Вот несколько примеров:

fred.pack()                     # defaults to side = "top"
fred.pack(side="left")
fred.pack(expand=1)

Параметры упаковщика

Для получения более подробной информации об упаковщике и параметрах, которые он может принимать, см. справочные страницы и страницу 183 книги Джона Аустерхаута.

anchor

Тип якорной точки. Указывает, где упаковщик размещает каждый дочерний виджет в своем контейнере.

expand

Булево значение, 0 или 1.

fill

Допустимые значения: 'x', 'y', 'both', 'none'.

ipadx и ipady

Расстояние — обозначение внутренней отступы с каждой стороны дочернего виджета.

padx и pady

Расстояние — обозначение внешней отступы с каждой стороны дочернего виджета.

side

Допустимые значения: 'left', 'right', 'top', 'bottom'.

Связывание переменных виджетов

Текущее значение некоторых виджетов (например, виджетов ввода текста) может быть напрямую связано с переменными приложения, используя специальные параметры. Эти параметры — variable, textvariable, onvalue, offvalue, и value. Эта связь работает в обе стороны: если переменная изменяется по любой причине, виджет, с которым она связана, будет обновлён, чтобы отразить новое значение.

К сожалению, в текущей реализации tkinter невозможно передать произвольную переменную Python виджету через параметр variable или textvariable. Единственными типами переменных, для которых это работает, являются переменные, являющиеся подклассами класса Variable, определённого в tkinter.

Уже определены многие полезные подклассы Variable: StringVar, IntVar, DoubleVar, и BooleanVar. Чтобы прочитать текущее значение такой переменной, вызовите метод get() на ней, а чтобы изменить её значение, вызовите метод set(). Если вы следуете этому протоколу, виджет будет всегда отслеживать значение переменной без дальнейшего вмешательства с вашей стороны.

Например:

import tkinter as tk

class App(tk.Frame):
    def __init__(self, master):
        super().__init__(master)
        self.pack()

        self.entrythingy = tk.Entry()
        self.entrythingy.pack()

        # Create the application variable.
        self.contents = tk.StringVar()
        # Set it to some value.
        self.contents.set("this is a variable")
        # Tell the entry widget to watch this variable.
        self.entrythingy["textvariable"] = self.contents

        # Define a callback for when the user hits return.
        # It prints the current value of the variable.
        self.entrythingy.bind('<Key-Return>',
                             self.print_contents)

    def print_contents(self, event):
        print("Hi. The current entry content is:",
              self.contents.get())

root = tk.Tk()
myapp = App(root)
myapp.mainloop()

Менеджер окон

В Tk есть утилитарная команда wm, для взаимодействия с менеджером окон. Параметры команды wm позволяют управлять такими аспектами, как заголовки, размещение, значки и т.д. В tkinter эти команды реализованы как методы класса Wm. Виджеты Toplevel являются подклассами класса Wm, и поэтому могут непосредственно вызывать методы Wm.

Чтобы получить окно toplevel, содержащее данный виджет, часто можно просто обратиться к мастеру виджета. Конечно, если виджет упакован внутри фрейма, мастер не будет представлять собой окно toplevel. Чтобы получить окно toplevel, содержащее произвольный виджет, можно вызвать метод _root(). Этот метод начинается с символа подчёркивания, чтобы обозначить, что эта функция является частью реализации, а не интерфейсом к функциональности Tk.

Вот несколько примеров типичного использования:

import tkinter as tk

class App(tk.Frame):
    def __init__(self, master=None):
        super().__init__(master)
        self.pack()

# create the application
myapp = App()

#
# here are method calls to the window manager class
#
myapp.master.title("My Do-Nothing Application")
myapp.master.maxsize(1000, 400)

# start the program
myapp.mainloop()

Типы данных опций Tk

anchor

Допустимые значения — точки компаса: "n", "ne", "e", "se", "s", "sw", "w", "nw", а также "center".

bitmap

Существует восемь встроенных, именованных растровых изображений: 'error', 'gray25', 'gray50', 'hourglass', 'info', 'questhead', 'question', 'warning'. Чтобы указать имя файла X растрового изображения, укажите полный путь к файлу, предваряя его @, как в "yes".

boolean

Вы можете передать целые числа 0 или 1 или строки "yes" или "no".

callback

Это любая функция Python, которая не принимает аргументов. Например:

def print_it():
    print("hi there")
fred["command"] = print_it

color

Цвета могут быть заданы как имена X-цветов в файле rgb.txt или как строки, представляющие значения RGB в диапазонах 4 бита: "#RGB", 8 бит: "#RRGGBB", 12 бит: "#RRRGGGBBB", или 16 бит: "#RRRRGGGGBBBB", где R, G, B здесь представляют собой любые допустимые шестнадцатеричные цифры. Подробности см. на странице 160 книги Остерхауса.

cursor

Можно использовать стандартные имена курсоров X из cursorfont.h, без префикса XC_. Например, чтобы получить курсор руки (XC_hand2), используйте строку "hand2". Вы также можете указать свой собственный файл растрового изображения и маски. См. страницу 179 книги Остерхауса.

distance

Расстояния на экране можно указывать в пикселях или абсолютных единицах. Пиксели задаются как числа, а абсолютные расстояния — как строки с заключительным символом, обозначающим единицы измерения: c для сантиметров, i для дюймов, m для миллиметров, p для типографских пунктов. Например, 3,5 дюйма выражается как "3.5i".

font

Tk использует формат имени шрифта в виде списка, например {courier 10 bold}. Размеры шрифтов с положительными числами измеряются в пунктах; размеры с отрицательными числами измеряются в пикселях.

geometry

Это строка вида widthxheight, где ширина и высота измеряются в пикселях для большинства виджетов (в символах для виджетов, отображающих текст). Например: fred["geometry"] = "200x100".

justify

Допустимые значения — строки: "left", "center", "right", и "fill".

region

Это строка с четырьмя элементами, разделенными пробелами, каждый из которых является допустимым расстоянием (см. выше). Например: "2 3 4 5" и "3i 2i 4.5i 2i" и "3c 2c 4c 10.43c" — все допустимые области.

relief

Определяет стиль границы виджета. Допустимые значения: "raised", "sunken", "flat", "groove", и "ridge".

scrollcommand

Это почти всегда метод set() некоторого виджета полосы прокрутки, но может быть любым методом виджета, принимающим один аргумент.

wrap

Должно быть одним из следующих: "none", "char", или "word".

Связывания и события

Метод bind виджета из команды виджета позволяет следить за определёнными событиями и вызывать функцию обратного вызова, когда возникает такой тип события. Формат метода bind:

def bind(self, sequence, func, add=''):

где:

sequence

это строка, обозначающая целевой тип события. (Подробности см. в руководстве bind и на странице 201 книги Джона Остерхауса).

func

это функция Python, принимающая один аргумент, которая должна быть вызвана при возникновении события. В качестве аргумента будет передано событие. (Функции, используемые таким образом, обычно называются обработчиками.)

add

это необязательный параметр, либо '' либо '+'. Передача пустой строки означает, что это связывание должно заменить любые другие связывания, связанные с этим событием. Передача '+' означает, что эта функция должна быть добавлена в список функций, связанных с этим типом события.

Например:

def turn_red(self, event):
    event.widget["activeforeground"] = "red"

self.button.bind("<Enter>", self.turn_red)

Обратите внимание, как в обработаке turn_red() обращается к полю widget события. Это поле содержит виджет, который поймал X-событие. В следующей таблице приведены другие поля событий, к которым вы можете получить доступ, и как они обозначаются в Tk, что может быть полезно при ссылке на справки Tk.

Параметр index

Ряд виджетов требует передачи параметров «index». Они используются для указания конкретного места в виджете Text, конкретных символов в виджете Entry или конкретных пунктов меню в виджете Menu.

Индексы виджетов Entry (index, view index и т. д.)

Виджеты Entry имеют параметры, которые ссылаются на позиции символов в отображаемом тексте. Вы можете использовать эти tkinter функции для доступа к этим особым точкам в виджетах текста:

Индексы виджетов Text

Индексация виджетов Text очень богата и лучше всего описывается в руководстве Tk.

Индексы меню (menu.invoke(), menu.entryconfig() и т. д.)

Некоторые параметры и методы для меню манипулируют конкретными пунктами меню. Всякий раз, когда нужен индекс меню для параметра или параметра, вы можете передать:

• целое число, которое ссылается на числовую позицию пункта в виджете, считая сверху, начиная с 0;
• строку "active", которая ссылается на позицию меню, которая находится в данный момент под курсором;
• строку "last", которая ссылается на последний пункт меню;
• целое число, предваряемое @, как в @6, где целое число интерпретируется как координата y пикселей в системе координат меню;
• строку "none", которая указывает отсутствие пункта меню, чаще всего используемая с menu.activate() для деактивации всех пунктов, и, наконец,
• строку текста, которая сопоставляется с меткой пункта меню по образцу, начиная сверху вниз. Обратите внимание, что этот тип индекса рассматривается после всех остальных, что означает, что соответствия пунктам меню с метками last, active, или none могут быть интерпретированы как указанные литералы вместо них.

Изображения

Изображения разных форматов можно создать с помощью соответствующего подкласса tkinter.Image:

• BitmapImage для изображений в формате XBM.
• PhotoImage для изображений в форматах PGM, PPM, GIF и PNG. Последний поддерживается, начиная с Tk 8.6.

Любой тип изображения создаётся через параметр file или data (есть и другие параметры).

Объект изображения затем можно использовать там, где поддерживается параметр image некоторым виджетом (например, метками, кнопками, меню). В таких случаях Tk не будет сохранять ссылку на изображение. Когда последний Python-ссылка на объект изображения удаляется, данные изображения также удаляются, и Tk отобразит пустой прямоугольник там, где было изображение.