tkinter – интерфейс Python к Tcl/Tk¶tkinter – Python interface to Tcl/Tk

Программа «Hello World»¶A Hello World program

Начнём с разбора приложения «Hello World» на Tkinter. Это не самая минимальная версия, которую можно написать, но в ней достаточно деталей, чтобы проиллюстрировать некоторые ключевые концепции, которые необходимо знать.

from tkinter import *
from tkinter import ttk
root = Tk()
frm = ttk.Frame(root, padding=10)
frm.grid()
ttk.Label(frm, text="Hello World!").grid(column=0, row=0)
ttk.Button(frm, text="Quit", command=root.destroy).grid(column=1, row=0)
root.mainloop()

После импортов следующая строка создаёт экземпляр класса Tk, который инициализирует Tk и создаёт связанный с ним интерпретатор Tcl. Она также создаёт главное окно, известное как корневое окно, которое служит основным окном приложения.

Следующая строка создаёт виджет Frame, который в данном случае будет содержать метку и кнопку, которые мы создадим далее. Frame помещается внутрь корневого окна.

Следующая строка создаёт виджет Label с текстовой строкой. Метод grid() используется для указания относительного расположения (позиции) метки внутри содержащего её виджета Frame, аналогично тому, как работают таблицы в HTML.

Затем создаётся виджет Button, который размещается справа от метки. При нажатии он вызывает метод destroy() корневого окна.

Наконец, метод mainloop() выводит всё на экран и реагирует на ввод пользователя до завершения программы.

Важные концепции Tk¶Important Tk concepts

Даже эта простая программа иллюстрирует следующие ключевые концепции Tk:

виджеты

Пользовательский интерфейс Tkinter состоит из отдельных виджетов. Каждый виджет представлен объектом Python, создаваемым из классов, таких как ttk.Frame, ttk.Label и ttk.Button.

иерархия виджетов

Виджеты организованы в иерархию. Метка и кнопка были размещены внутри фрейма, который, в свою очередь, находился внутри корневого окна. При создании каждого дочернего виджета его родительский виджет передаётся первым аргументом конструктору виджета.

параметры конфигурации

Виджеты имеют параметры конфигурации, которые изменяют их внешний вид и поведение, например текст, отображаемый в метке или кнопке. Разные классы виджетов имеют разные наборы параметров.

управление геометрией

Виджеты не добавляются в интерфейс автоматически при их создании. Менеджер геометрии, такой как grid, управляет тем, где они размещаются в интерфейсе.

цикл событий

Tkinter реагирует на ввод пользователя, изменения в программе и даже обновляет экран только при активном выполнении цикла событий. Если программа не выполняет цикл событий, интерфейс не будет обновляться.

Понимание того, как Tkinter оборачивает Tcl/Tk¶Understanding how Tkinter wraps Tcl/Tk

Когда ваше приложение использует классы и методы Tkinter, внутри Tkinter собирает строки, представляющие команды Tcl/Tk, и выполняет их в интерпретаторе Tcl, прикреплённом к экземпляру Tk вашего приложения.

Будь то попытка разобраться в справочной документации, поиск нужного метода или параметра, адаптация существующего кода или отладка приложения Tkinter, бывают моменты, когда полезно понимать, как выглядят эти базовые команды Tcl/Tk.

Для иллюстрации ниже приведён эквивалент на Tcl/Tk основной части скрипта Tkinter, показанного выше.

ttk::frame .frm -padding 10
grid .frm
grid [ttk::label .frm.lbl -text "Hello World!"] -column 0 -row 0
grid [ttk::button .frm.btn -text "Quit" -command "destroy ."] -column 1 -row 0

Синтаксис Tcl похож на многие оболочки: первое слово – это команда, за которой следуют её аргументы, разделённые пробелами. Не вдаваясь в подробности, обратите внимание на следующее:

• Команды для создания виджетов (например, ttk::frame) соответствуют классам виджетов в Tkinter.

• Параметры виджетов Tcl (например, -text) соответствуют именованным аргументам в Tkinter.

• В Tcl виджеты идентифицируются по пути (например, .frm.btn), тогда как Tkinter использует не имена, а ссылки на объекты.

• Положение виджета в иерархии закодировано в его (иерархическом) пути, который использует . (точку) в качестве разделителя. Путь корневого окна – это просто . (точка). В Tkinter иерархия определяется не путём, а указанием родительского виджета при создании каждого дочернего виджета.

• Операции, которые реализованы как отдельные команды в Tcl (например, grid или destroy), представлены как методы объектов виджетов Tkinter. Как вы скоро увидите, в других случаях Tcl использует то, что выглядит как вызовы методов объектов виджетов, что более точно отражает подход Tkinter.

Как сделать…? Какой параметр…?¶How do I…? What option does…?

Если вы не уверены, как сделать что-то в Tkinter, и не можете сразу найти это в используемом учебнике или справочной документации, есть несколько стратегий, которые могут помочь.

Во-первых, помните, что детали работы отдельных виджетов могут различаться в разных версиях как Tkinter, так и Tcl/Tk. При поиске документации убедитесь, что она соответствует версиям Python и Tcl/Tk, установленным в вашей системе.

При поиске способа использования API полезно знать точное имя класса, параметра или метода, которые вы используете. Интроспекция, будь то в интерактивной оболочке Python или с помощью print(), может помочь определить, что вам нужно.

Чтобы узнать, какие параметры конфигурации доступны для любого виджета, вызовите его метод configure(), который возвращает словарь с различной информацией о каждом объекте, включая его значения по умолчанию и текущие значения. Используйте keys(), чтобы получить только имена каждого параметра.

btn = ttk.Button(frm, ...)
print(btn.configure().keys())

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

print(set(btn.configure().keys()) - set(frm.configure().keys()))

Аналогично, можно найти доступные методы объекта виджета с помощью стандартной функции dir(). Если попробовать, окажется, что существует более 200 общих методов виджетов, поэтому снова полезно определить методы, специфичные для класса виджета.

print(dir(btn))
print(set(dir(btn)) - set(dir(frm)))

Навигация по справочному руководству Tcl/Tk¶Navigating the Tcl/Tk reference manual

Как уже отмечалось, официальное справочное руководство по командам Tk (страницы man) часто является наиболее точным описанием того, что делают конкретные операции с виджетами. Даже если вы знаете имя нужного параметра или метода, вам всё равно может потребоваться поискать в нескольких местах.

Хотя все операции в Tkinter реализованы как вызовы методов объектов виджетов, многие операции Tcl/Tk представлены в виде команд, которые принимают путь к виджету в качестве первого параметра, за которым следуют необязательные параметры, например

destroy .
grid .frm.btn -column 0 -row 0

Другие же больше похожи на методы, вызываемые для объекта виджета (на самом деле, при создании виджета в Tcl/Tk создаётся команда Tcl с именем пути к виджету, первым параметром которой является имя вызываемого метода).

.frm.btn invoke
.frm.lbl configure -text "Goodbye"

В официальной справочной документации Tcl/Tk большинство операций, похожих на вызовы методов, можно найти на man-странице конкретного виджета (например, метод invoke() есть на man-странице ttk::button), тогда как функции, принимающие виджет в качестве параметра, часто имеют собственную man-страницу (например, grid).

Многие общие параметры и методы можно найти на man-страницах options или ttk::widget, тогда как остальные находятся на man-странице конкретного класса виджета.

Многие методы Tkinter имеют составные имена, например, winfo_x(), winfo_height(), winfo_viewable(). Документацию по всем ним можно найти на man-странице winfo.

Настройка параметров¶Setting options

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

При создании объекта – с помощью именованных аргументов

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

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

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

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

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

Полное объяснение конкретного параметра и его поведения можно найти на man-страницах Tk для соответствующего виджета.

Обратите внимание, что man-страницы перечисляют «СТАНДАРТНЫЕ ПАРАМЕТРЫ» и «ПАРАМЕТРЫ, СПЕЦИФИЧНЫЕ ДЛЯ ВИДЖЕТА» для каждого виджета. Первое – список параметров, общих для многих виджетов, второе – параметры, свойственные конкретному виджету. Стандартные параметры задокументированы на man-странице options(3).

В этом документе не делается различий между стандартными и специфичными для виджета параметрами. Некоторые параметры не применимы к некоторым типам виджетов. Реагирует ли данный виджет на определённый параметр, зависит от класса виджета: кнопки имеют параметр command, а метки – нет.

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

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

Пример:

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

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

Упаковщик¶The packer

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

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

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

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

fred.pack()                     # по умолчанию side = "top"
fred.pack(side="left")
fred.pack(expand=1)

Опции упаковщика¶Packer options

За более подробной информацией об упаковщике и его опциях обращайтесь к man-страницам и странице 183 книги Джона Оустерхаута.

привязка

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

расширение

логическое значение, 0 или 1.

заполнение

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

ipadx и ipady

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

padx и pady

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

сторона

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

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

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

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

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

Сохраняйте ссылку на переменную всё время, пока виджет её использует, например, храня её в виде атрибута (см. Variable).

Например:

import tkinter as tk

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

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

        # Создайте переменную приложения.
        self.contents = tk.StringVar()
        # Установите её в некоторое значение.
        self.contents.set("this is a variable")
        # Укажите виджету ввода отслеживать эту переменную.
        self.entrythingy["textvariable"] = self.contents

        # Определите колбэк для события нажатия Return.
        # Он выводит текущее значение переменной.
        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()

Менеджер окон¶The window manager

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

Чтобы получить окно верхнего уровня, содержащее данный виджет, можно просто обратиться к master виджета. Конечно, если виджет был упакован внутри рамки, master не будет представлять окно верхнего уровня. Чтобы получить окно верхнего уровня, содержащее произвольный виджет, можно вызвать метод winfo_toplevel(). Также существует метод _root(); его имя начинается с подчёркивания, чтобы показать, что эта функция является частью реализации, а не интерфейсом к функциональности Tk. Он возвращает корневое окно приложения, а не ближайшее охватывающее окно верхнего уровня.

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

import tkinter as tk

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

# создайте приложение
myapp = App()

#
# здесь вызовы методов класса оконного менеджера
#
myapp.master.title("My Do-Nothing Application")
myapp.master.maxsize(1000, 400)

# запустите программу
myapp.mainloop()

Типы данных опций Tk¶Tk option data types

привязка

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

битовая карта

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

булевый

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

колбэк

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

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

цвет

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

курсор

Имя курсора мыши, отображаемого при наведении указателя на виджет. Tk предоставляет портативный набор имён курсоров, доступных на всех платформах (например, "arrow", "watch", "cross" или "hand2"); также можно использовать стандартные имена X-курсоров из cursorfont.h, без префикса XC_ (так XC_hand2 становится "hand2"). Полный список имён, включая платформозависимые, приведён на странице cursors(3tk) руководства. Можно также указать собственные файлы растрового изображения и маски. В Windows можно напрямую использовать файл курсора (.cur или .ani), указав его путь с префиксом @, как в "@C:/cursors/bart.ani".

расстояние

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

шрифт

Tk использует описание шрифта, например {courier 10 bold}; в tkinter это наиболее естественно передавать как кортеж из (family, size, *styles) (или как эквивалентную строку "Courier 10 bold"). Положительные размеры шрифта измеряются в пунктах; отрицательные – в пикселях.

геометрия

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

выравнивание

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

регион

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

рельеф

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

команда прокрутки

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

перенос

Должно быть одним из: "none", "char" или "word".

Привязки и события¶Bindings and events

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

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

где:

последовательность

– это строка, обозначающая целевой тип события. Физические события используют форму <modifier-modifier-type-detail> (например, "<Enter>" или "<Control-Button-1>"); определённые приложением виртуальные события используют двойные угловые скобки, как в "<<Paste>>". (Подробнее см. на странице bind(3tk) руководства и на стр. 201 книги Джона Оустерхаута Tcl and the Tk Toolkit (2nd edition).)

функция

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

добавить

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

Например:

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

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

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

Параметр add выше влияет только на привязки, задаваемые вами. Каждый виджет также наследует привязки класса, реализующие его стандартное поведение – например, виджет Text привязывает Control-t для транспозиции двух символов. Они описаны в разделе привязок страницы руководства Tk для данного виджета (например, text(3tk) или entry(3tk)).

Привязки класса обрабатываются отдельно от ваших собственных, поэтому привязка события самостоятельно не заменяет поведение по умолчанию; выполняются обе. Чтобы подавить нежелательную привязку по умолчанию, привяжите событие к виджету и верните строку "break" из вашего колбэка.

Параметр index¶The index parameter

Ряд виджетов требует передачи параметров «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 могут быть интерпретированы как указанные выше литералы.

Изображения¶Images

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

• BitmapImage для изображений в формате XBM.

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

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

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

Базовые и примесные классы¶Base and mixin classes

class tkinter.Misc¶

Класс Misc – это примесь, наследуемая классом Tk и, через BaseWidget, каждым виджетом. Он предоставляет обширный набор методов, общих для всех объектов Tk: запрос информации об окне, управление привязками событий и циклом событий, управление фокусом клавиатуры и захватом указателя, доступ к выделению, буферу обмена и базе данных опций, а также различные служебные и интроспекционные сервисы. Поскольку они наследуются, эти методы доступны на каждом виджете и на объекте приложения Tk, и документированы здесь один раз, а не повторяются для каждого виджета.

cget(key)¶

Возвращает текущее значение опции конфигурации с именем key для данного виджета в виде строки. Выражение widget[key] эквивалентно и может использоваться вместо этого.

configure(cnf=None, **kw)¶

Запрашивает или изменяет опции конфигурации виджета. Без аргументов возвращает словарь, сопоставляющий каждому доступному имени опции кортеж с её описанием (имя, X ресурсное имя, X ресурсный класс, значение по умолчанию и текущее значение). Если указано одно имя опции в виде строки, возвращает кортеж только для этой опции. Если указаны одно или несколько ключевых аргументов, или передан словарь в качестве cnf, устанавливает каждую именованную опцию в соответствующее значение; выражение widget[key] = value устанавливает одну опцию таким же образом.

config() является псевдонимом configure().

keys()¶

Возвращает список имён всех опций конфигурации данного виджета.

getboolean(s)¶

Интерпретирует строку s как логическое значение Tcl и возвращает соответствующее bool. Tcl принимает такие значения, как '1', '0', 'yes', 'no', 'true' и 'false'. Вызывает ValueError, если s не является допустимым логическим значением.

getdouble(s)¶

Интерпретирует строку s как число с плавающей запятой Tcl и возвращает его в виде float. Вызывает ValueError, если s не является допустимым числом.

Добавлено в версии 3.5.

getint(s)¶

Интерпретирует строку s как целое число Tcl и возвращает его как int. Вызывает ValueError, если s не является допустимым целым числом.

getvar(name)¶

Возвращает значение глобальной переменной Tcl с именем name.

setvar(name, value)¶

Устанавливает глобальную переменную Tcl с именем name в значение value.

Методы getvar() и setvar() предоставляют прямой доступ к переменным Tcl. В большинстве кода вместо них используется подкласс Variable, такой как StringVar или IntVar, который оборачивает переменную Tcl и преобразует её значение в тип Python и обратно.

register(func, subst=None, needcleanup=1)¶

Регистрирует вызываемый объект Python func как команду Tcl и возвращает имя новой команды в виде строки. Всякий раз, когда Tcl вызывает эту команду, вызывается func; если указан subst, он сначала применяется к аргументам команды. Это механизм, используемый внутри для преобразования обратных вызовов Python в имена команд, передаваемые опциям Tk, таким как command. Если needcleanup не равно false, команда автоматически удаляется при уничтожении виджета.

Изменено в версии 3.13: Аргументы, передаваемые в func, больше не преобразуются в строки.

deletecommand(name)¶

Удаляет Tcl-команду с именем name, например ту, что была возвращена ранее вызовом register().

nametowidget(name)¶

Возвращает экземпляр виджета, соответствующий Tk-пути name.

send(interp, cmd, *args)¶

Отправляет Tcl-команду cmd с переданными аргументами args интерпретатору Tcl, зарегистрированному под именем interp, и возвращает результат. Доступно не на всех платформах.

destroy()¶

Уничтожает данный виджет и все его дочерние виджеты, удаляя связанные с ними Tcl-команды.

tkraise(aboveThis=None)¶

Поднимает данный виджет в стеке порядка, чтобы он отображался поверх своих соседей. Если указан aboveThis, виджет перемещается непосредственно над этим элементом в стеке порядка.

lift() является псевдонимом tkraise().

lower(belowThis=None)¶

Опускает данный виджет в стеке порядка, чтобы он отображался под своими соседями. Если указан belowThis, виджет перемещается непосредственно под этим элементом в стеке порядка.

tkraise()/lift() и lower() переопределяются в виджете Canvas, где они вместо этого переупорядочивают элементы canvas.

image_names()¶

Возвращает имена всех изображений, которые на данный момент существуют в интерпретаторе Tcl.

Это переопределяется в виджете Text, где image_names() вместо этого возвращает имена его встроенных изображений.

image_types()¶

Возвращает доступные типы изображений, такие как 'photo' и 'bitmap'.

grid_anchor(anchor=None)¶

Устанавливает привязку (anchor), которая определяет положение сетки внутри контейнера, когда контейнер больше сетки и ни одна строка или столбец не имеют ненулевого веса. anchor – одна из стандартных строк привязки, например 'nw' (по умолчанию) или 'center'. Вызов без аргументов не даёт эффекта.

anchor() является псевдонимом grid_anchor().

Добавлено в версии 3.3.

grid_bbox(column=None, row=None, col2=None, row2=None)¶

Возвращает ограничивающий прямоугольник (в пикселях) области сетки, размещённой внутри данного контейнера, в виде кортежа из 4 элементов (xoffset, yoffset, width, height). Без аргументов возвращается ограничивающий прямоугольник всей сетки. Если указаны column и row, прямоугольник охватывает ячейку с номером строки и столбца 0 до этой ячейки; если также указаны col2 и row2, то он охватывает область от ячейки (column, row) до ячейки (col2, row2).

bbox() – это псевдоним grid_bbox(), за исключением Canvas, Listbox, Spinbox, Text, ttk.Entry и ttk.Treeview, которые предоставляют собственный метод bbox().

grid_columnconfigure(index, cnf={}, **kw)¶

Запрашивает или задаёт свойства столбца (или столбцов) index сетки, управляемой этим контейнером. index может быть номером столбца; при задании параметров это также может быть список номеров столбцов, строка 'all' для воздействия на каждый столбец, или дочерний виджет, у которого затрагиваются занимаемые столбцы. Поддерживаемые параметры:

minsize

Минимальный размер столбца в пикселях.

weight

Целое число, определяющее, какая доля дополнительного пространства выделяется столбцу. Вес 0 оставляет столбец запрошенного размера, а столбец с весом два увеличивается вдвое быстрее столбца с весом один.

uniform

Имя единой группы. Столбцы с одинаковым непустым именем группы сохраняют размеры, строго пропорциональные их весам.

pad

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

С одним именем опции возвращает её значение; без аргументов возвращает словарь всех опций.

columnconfigure() является псевдонимом grid_columnconfigure().

grid_rowconfigure(index, cnf={}, **kw)¶

Запрашивает или задаёт свойства строки (или строк) index сетки, управляемой этим контейнером. index интерпретируется так же, как для grid_columnconfigure(), а поддерживаемые опции (minsize, weight, uniform и pad) те же, но применяются к строке, а не к столбцу.

rowconfigure() является псевдонимом grid_rowconfigure().

grid_location(x, y)¶

Возвращает (column, row) ячейки сетки, содержащей пиксель в позиции (x, y), заданной в пикселях относительно этого контейнера. Для позиций выше или левее сетки возвращается -1 для соответствующей координаты.

grid_propagate()¶

grid_propagate(flag)

Включает или отключает распространение геометрии для этого контейнера, когда он управляет своими дочерними элементами с помощью менеджера геометрии grid. Когда flag равен true, контейнер изменяет свой размер, чтобы соответствовать запрошенным размерам дочерних элементов; когда false, его размер остаётся под вашим контролем. При вызове без аргументов возвращает текущую настройку в виде булева значения.

grid_size()¶

Возвращает размер сетки, управляемой этим контейнером, в виде кортежа (columns, rows).

size() – это псевдоним grid_size(), за исключением виджета Listbox, который предоставляет собственный метод size().

grid_slaves(row=None, column=None)¶

Возвращает список дочерних виджетов, управляемых в сетке этого контейнера, начиная с последнего добавленного. Если указаны row или column, возвращаются только дочерние элементы в этой строке или столбце.

pack_propagate()¶

pack_propagate(flag)

Включает или отключает распространение геометрии для этого контейнера, когда он управляет своими дочерними элементами с помощью менеджера геометрии pack. Когда flag равен true, контейнер изменяет свой размер, чтобы соответствовать запрошенным размерам дочерних элементов; когда false, его размер остаётся под вашим контролем. При вызове без аргументов возвращает текущую настройку в виде булева значения.

propagate() является псевдонимом pack_propagate().

pack_slaves()¶

Возвращает список дочерних виджетов, управляемых этим контейнером с помощью менеджера геометрии pack, в порядке упаковки.

slaves() является псевдонимом pack_slaves().

place_slaves()¶

Возвращает список дочерних виджетов, управляемых этим контейнером с помощью менеджера геометрии place.

Методы с префиксами bind и unbind связывают шаблоны событий с колбэками и удаляют эти связи.

bind(sequence=None, func=None, add=None)¶

Привязывает шаблон события sequence на этом виджете к вызываемому объекту func.

sequence – это шаблон события, например '<Button-1>' (щелчок мыши) или '<KeyPress-a>', и, возможно, объединение нескольких таких шаблонов, которые должны произойти один за другим. При наступлении события func вызывается с экземпляром Event, описывающим его, в качестве единственного аргумента; если func возвращает строку 'break', дальнейшие привязки для этого события не вызываются.

Если add равен true, func добавляется к любым функциям, уже привязанным к sequence; в противном случае он заменяет их. Привязка применяется только к этому виджету.

bind() возвращает строковый идентификатор (funcid), который впоследствии можно передать в unbind(), чтобы удалить привязку без утечки связанной команды Tcl.

Если func опущен, вернуть привязку, связанную с sequence; если также опущен sequence, вернуть список всех последовательностей, для которых существуют привязки на этом виджете.

bind_class(className, sequence=None, func=None, add=None)¶

Как bind(), но привязывает func к тегу привязки className, а не к отдельному виджету, так что привязка применяется к каждому виджету, имеющему этот тег. className обычно является именем класса виджета, например 'Button', в этом случае привязка влияет на все виджеты этого класса. Набор тегов привязки для виджета можно просмотреть и изменить с помощью bindtags().

Остальные аргументы и возвращаемое значение такие же, как для bind().

bind_all(sequence=None, func=None, add=None)¶

Как bind(), но привязывает func к специальному тегу привязки 'all', так что привязка применяется к каждому виджету в приложении.

Остальные аргументы и возвращаемое значение такие же, как для bind().

unbind(sequence, funcid=None)¶

Удаляет привязки для шаблона события sequence на этом виджете.

Если указан funcid, удаляется только функция, идентифицируемая им (значение, возвращённое предыдущим вызовом bind()), а связанная с ней команда Tcl удаляется. В противном случае уничтожаются все привязки для sequence, и он остаётся непривязанным.

Изменено в версии 3.13: Если указан funcid, отвязывается только этот колбэк; остальные колбэки, привязанные к sequence, сохраняются.

unbind_class(className, sequence)¶

Удаляет все привязки для шаблона события sequence из тега привязки className. См. bind_class().

unbind_all(sequence)¶

Удаляет все привязки для шаблона события sequence из специального тега привязки 'all'. См. bind_all().

bindtags(tagList=None)¶

Если tagList опущен, возвращает кортеж тегов привязки, связанных с этим виджетом. Когда в виджете происходит событие, оно применяется к каждому из тегов привязки виджета по порядку, и для каждого тега выполняется наиболее подходящая привязка. По умолчанию виджет имеет четыре тега привязки: собственное имя пути, его класс виджета, имя пути ближайшего предка верхнего уровня и 'all', именно в таком порядке.

Если указан tagList, он должен быть последовательностью строк; теги привязки виджета устанавливаются равными его элементам, что определяет порядок, в котором вычисляются привязки.

Методы с префиксом event_ определяют виртуальные события и генерируют события программно.

event_add(virtual, *sequences)¶

Связывает виртуальное событие virtual, имя которого имеет форму '<<Paste>>', с каждым из физических шаблонов событий, заданных sequences, так что виртуальное событие срабатывает всякий раз, когда происходит любое из них. Если virtual уже определён, новые последовательности добавляются к уже существующим.

event_delete(virtual, *sequences)¶

Удаляет каждую из sequences из тех, что связаны с виртуальным событием virtual. Последовательности, которые в данный момент не связаны с virtual, игнорируются. Если sequences не указаны, удаляются все физические последовательности событий, так что virtual больше не срабатывает.

event_generate(sequence, **kw)¶

Генерирует событие sequence на этом виджете и обеспечивает его обработку так, как если бы оно поступило от оконной системы. sequence должен быть одиночным шаблоном события, например '<Button-1>' или '<<Paste>>', а не объединением нескольких. Именованные аргументы задают дополнительные поля события, например x и y для положения указателя, или when для управления моментом обработки события; полный список приведён на странице руководства Tk event.

event_info(virtual=None)¶

Если virtual опущен, возвращает кортеж всех виртуальных событий, которые в настоящее время определены. Если указан virtual, возвращает кортеж физических последовательностей событий, связанных с ним в настоящее время, или пустой кортеж, если он не определён.

Методы с префиксом after планируют выполнение колбэков после задержки или когда приложение находится в состоянии простоя.

after(ms, func=None, *args)¶

Планирует вызов вызываемого объекта func через ms миллисекунд, передавая ему args в качестве позиционных аргументов. Возвращает идентификатор, который можно передать в after_cancel() для отмены вызова.

Если func опущен, вместо этого приостановить выполнение на ms миллисекунд, не обрабатывая события в течение этого времени, и вернуть None.

Изменено в версии 3.10: func теперь может быть любым вызываемым объектом, а не только функцией.

after_cancel(id)¶

Отменяет колбэк, ранее запланированный с помощью after() или after_idle(). id должен быть идентификатором, возвращённым одним из этих методов; передача значения, не являющегося таким идентификатором, вызывает ValueError. Если колбэк уже выполнен или отменён, это не оказывает эффекта.

Изменено в версии 3.7: Передача None (или любого ложного значения) в качестве id теперь вызывает ValueError.

after_idle(func, *args)¶

Планирует вызов вызываемого объекта func с передачей ему args в тот момент, когда основной цикл Tk в следующий раз перейдёт в состояние бездействия, то есть когда у него не будет других событий для обработки. Возвращает идентификатор, который можно передать в after_cancel() для отмены вызова.

after_info(id=None)¶

Если id опущен, возвращает кортеж идентификаторов всех колбэков, текущих запланированных с помощью after() и after_idle() для данного интерпретатора.

Если id указан, он должен идентифицировать колбэк, который ещё не выполнен или не отменён, и возвращаемое значение представляет собой кортеж (script, type), где script ссылается на вызываемую функцию, а type – это либо 'idle', либо 'timer'. Вызывается TclError, если id не существует.

Добавлено в версии 3.13.

mainloop(n=0)¶

Входит в цикл событий Tk, который обрабатывает события до тех пор, пока все окна не будут уничтожены. Обычно вызывается один раз, на корневом окне, для запуска приложения.

quit()¶

Завершает интерпретатор Tcl, в результате чего mainloop() возвращает управление.

update()¶

Входит в цикл событий до тех пор, пока все ожидающие события, включая бездействующие колбэки, не будут обработаны. Это обновляет отображение и обрабатывает любые события, которые уже находятся в очереди, после чего возвращает управление.

update_idletasks()¶

Входит в цикл событий до тех пор, пока не будут вызваны все ожидающие бездействующие колбэки. Это обновляет отображение окон, например после изменения геометрии, но не обрабатывает события, вызванные пользователем.

wait_variable(name)¶

Ожидает, пока переменная Tcl name не будет изменена, продолжая при этом обрабатывать события, чтобы приложение оставалось отзывчивым. name обычно является экземпляром Variable, таким как IntVar или StringVar.

waitvar() является псевдонимом wait_variable().

wait_window(window=None)¶

Ожидает, пока window не будет уничтожено, продолжая при этом обрабатывать события. Если window опущен, используется данный виджет. Обычно используется для ожидания завершения взаимодействия пользователя с диалоговым окном.

wait_visibility(window=None)¶

Ожидает, пока состояние видимости window не изменится, например, когда оно впервые появляется на экране, продолжая при этом обрабатывать события. Если window опущен, используется данный виджет. Обычно используется для ожидания, пока новое окно не станет видимым, прежде чем выполнять с ним какие-либо действия.

Методы с префиксом focus_ управляют фокусом ввода с клавиатуры.

focus()¶

Направляет фокус ввода с клавиатуры для дисплея данного виджета на этот виджет. Если приложение в данный момент не имеет фокуса ввода на дисплее этого виджета, виджет запоминается как окно фокуса для своего верхнего уровня, и фокус будет перенаправлен на него в следующий раз, когда оконный менеджер передаст фокус верхнему уровню. focus() – это псевдоним focus_set(), за исключением виджетов Canvas и ttk.Treeview, которые предоставляют собственный метод focus().

focus_force()¶

Направляет фокус ввода с клавиатуры на этот виджет, даже если приложение в данный момент не имеет фокуса ввода для дисплея виджета. Этот метод следует использовать с осторожностью, если вообще использовать; обычно приложению следует дожидаться, пока оконный менеджер сам передаст ему фокус, а не захватывать его.

focus_get()¶

Возвращает виджет, который в данный момент имеет фокус клавиатуры в приложении, или None, если ни один виджет в приложении не имеет фокуса. Используйте focus_displayof() для корректной работы с несколькими дисплеями.

focus_displayof()¶

Возвращает виджет, который в данный момент имеет фокус клавиатуры на дисплее, где расположен этот виджет, или None, если ни один виджет в приложении не имеет фокуса на этом дисплее.

focus_lastfor()¶

Возвращает последний виджет, который имел фокус клавиатуры среди всех виджетов на том же верхнем уровне, что и этот виджет; это виджет, который получит фокус в следующий раз, когда оконный менеджер передаст фокус этому верхнему уровню. Если ни один виджет на этом верхнем уровне никогда не имел фокуса, или если последний виджет с фокусом был удалён, возвращается сам верхний уровень.

tk_focusFollowsMouse()¶

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

tk_focusNext()¶

Возвращает следующий виджет после данного в порядке обхода клавиатуры, или None, если такого нет. Порядок обхода: сначала следующий дочерний элемент, затем рекурсивно дочерние элементы этого дочернего элемента, а затем следующий родственный элемент, расположенный выше в порядке наложения. Виджет пропускается, если его опция takefocus имеет значение 0. Этот метод используется в привязках по умолчанию для клавиши Tab.

tk_focusPrev()¶

Возвращает предыдущий виджет перед данным в порядке обхода клавиатуры, или None, если такого нет. См. tk_focusNext() для описания порядка. Этот метод используется в привязках по умолчанию для клавиши Shift-Tab.

Методы с префиксом grab_ устанавливают и запрашивают захват ввода, который направляет все события ввода на один виджет.

grab_set()¶

Устанавливает локальный захват на этот виджет. Захват ограничивает события указателя этим виджетом и его потомками: пока указатель находится вне поддерева виджета, нажатия и отпускания кнопок, а также перемещения указателя передаются виджету захвата, а окна за пределами поддерева становятся нечувствительными до освобождения захвата. Локальный захват влияет только на приложение, которое его установило. Любой предыдущий захват, установленный этим приложением на дисплее виджета, автоматически освобождается. Установка захвата – обычный способ сделать диалог модальным: пока захват активен, пользователь не может взаимодействовать с другими окнами приложения.

grab_set_global()¶

Устанавливает глобальный захват на этот виджет. Глобальный захват подобен локальному захвату, устанавливаемому методом grab_set(), но он блокирует все остальные приложения на экране, так что только поддерево этого виджета чувствительно к событиям указателя, а также захватывает клавиатуру. Следует соблюдать осторожность: глобальный захват может легко сделать дисплей неработоспособным, поскольку другие приложения перестают получать события до его освобождения.

grab_release()¶

Освобождает захват на этот виджет, если он установлен; в противном случае ничего не делает.

grab_current()¶

Возвращает виджет, который в данный момент удерживает захват в этом приложении для дисплея данного виджета, или None, если такого виджета нет.

grab_status()¶

Возвращает None, если на данный момент на этом виджете не установлен захват, "local", если установлен локальный захват, или "global", если установлен глобальный захват.

Методы с префиксом selection_ извлекают и управляют X-выделением.

selection_clear(**kw)¶

Очищает X-выделение, так чтобы ни одно окно больше не владело им. Очищаемое выделение задаётся именованным аргументом selection, именем атома, таким как 'PRIMARY' или 'CLIPBOARD'; по умолчанию используется PRIMARY. Именованный аргумент displayof задаёт виджет, определяющий дисплей, на котором следует выполнять операцию; по умолчанию используется этот виджет.

Это переопределяется виджетами Entry, Listbox и Spinbox, где selection_clear() вместо этого очищает собственное выделение виджета.

selection_get(**kw)¶

Возвращает содержимое текущего X-выделения. Именованный аргумент selection задаёт имя выделения; по умолчанию используется PRIMARY. Именованный аргумент type указывает форму, в которой должны быть возвращены данные (нужный целевой тип преобразования) – имя атома, такое как 'STRING' или 'FILE_NAME'; по умолчанию используется STRING, за исключением X11, где сначала пробуется UTF8_STRING, а в качестве запасного варианта применяется STRING. Именованный аргумент displayof задаёт виджет, определяющий дисплей, с которого следует получить выделение; по умолчанию используется этот виджет.

selection_handle(command, **kw)¶

Регистрирует command как обработчик для предоставления X-выделения, которым владеет этот виджет, когда другое приложение запрашивает его. При извлечении выделения command вызывается с двумя аргументами: начальным смещением символа и максимальным количеством возвращаемых символов; он должен вернуть не более этого количества символов выделения, начиная с указанного смещения; для очень длинных выделений он вызывается многократно с увеличивающимися смещениями. Именованный аргумент selection задаёт имя выделения (по умолчанию PRIMARY), а именованный аргумент type указывает форму выделения, которую предоставляет обработчик (например, 'STRING' или 'FILE_NAME', по умолчанию STRING).

selection_own(**kw)¶

Делает этот виджет владельцем X-выделения на его дисплее. Предыдущий владелец, если он был, уведомляется о потере выделения. Именованный аргумент selection задаёт имя выделения; по умолчанию используется PRIMARY.

selection_own_get(**kw)¶

Возвращает виджет в этом приложении, которому принадлежит выделение X на дисплее, содержащем этот виджет, или None, если ни один виджет в этом приложении не владеет выделением. Именованный аргумент selection задаёт название выделения; значение по умолчанию – PRIMARY. Именованный аргумент displayof задаёт виджет, определяющий запрашиваемый дисплей; значение по умолчанию – этот виджет.

Методы с префиксом clipboard_ управляют буфером обмена.

clipboard_append(string, **kw)¶

Добавляет string в буфер обмена Tk и заявляет права владения буфером обмена на дисплее этого виджета. Перед добавлением буфер обмена следует очистить с помощью clipboard_clear(); все добавления должны быть завершены до возврата в цикл событий, чтобы буфер обмена обновился атомарно. Именованный аргумент type задаёт форму данных – имя атома, например 'STRING' или 'FILE_NAME' (по умолчанию STRING), а именованный аргумент format задаёт представление, используемое для передачи (по умолчанию STRING). Именованный аргумент displayof задаёт виджет, определяющий целевой дисплей; значение по умолчанию – этот виджет. Содержимое можно получить с помощью clipboard_get() или selection_get().

clipboard_clear(**kw)¶

Заявляет права владения буфером обмена на дисплее этого виджета и удаляет предыдущее содержимое. Именованный аргумент displayof задаёт виджет, определяющий целевой дисплей; значение по умолчанию – этот виджет.

clipboard_get(**kw)¶

Извлекает данные из буфера обмена на дисплее этого виджета. Именованный аргумент type задаёт форму, в которой должны быть возвращены данные – имя атома, например 'STRING' или 'FILE_NAME'; по умолчанию STRING, за исключением X11, где сначала пробуется UTF8_STRING, а STRING используется как запасной вариант. Именованный аргумент displayof задаёт виджет, определяющий дисплей; значение по умолчанию – корневое окно приложения. Это эквивалентно selection_get(selection='CLIPBOARD').

Методы с префиксом option_ запрашивают и изменяют базу данных опций Tk.

option_add(pattern, value, priority=None)¶

Добавляет опцию в базу данных опций Tk, связывающую value с pattern. pattern состоит из имён и/или классов, разделённых звёздочками или точками, в обычном формате X. priority – целое число от 0 до 100 или одно из символических имён 'widgetDefault' (20), 'startupFile' (40), 'userDefault' (60) или 'interactive' (80); по умолчанию interactive.

option_clear()¶

Очищает базу данных опций Tk. Опции по умолчанию из свойства RESOURCE_MANAGER или файла .Xdefaults автоматически перезагружаются при следующем добавлении или удалении опции из базы.

option_get(name, className)¶

Возвращает значение опции из базы данных опций Tk, соответствующей этому виджету по name и className, или пустую строку, если соответствующей записи нет. Если совпадает несколько записей, возвращается та, у которой наивысший приоритет, а среди записей с равным приоритетом – добавленная последней.

option_readfile(fileName, priority=None)¶

Читает файл с именем fileName, который должен иметь стандартный формат базы данных ресурсов X, например .Xdefaults, и добавляет все указанные в нём опции в базу данных опций Tk. priority интерпретируется так же, как для option_add(), и по умолчанию равен interactive.

bell(displayof=0)¶

Воспроизводит звонок на дисплее этого виджета, используя текущие настройки звонка дисплея, и сбрасывает хранитель экрана для экрана. Если displayof задан как виджет, звонок воспроизводится на дисплее этого виджета.

tk_setPalette(background, /)¶

tk_setPalette(*args, **kw)

Устанавливает новую цветовую схему для всех элементов виджетов Tk. Существующие виджеты обновляются, а база данных опций изменяется так, чтобы будущие виджеты использовали новые цвета. Если передан один цветовой аргумент, он считается обычным цветом фона, на основе которого вычисляется полная палитра. В качестве альтернативы аргументы могут быть заданы как пары name/value, задающие отдельные опции в базе данных опций. Распознаваемые имена опций: activeBackground, activeForeground, background, disabledForeground, foreground, highlightBackground, highlightColor, insertBackground, selectColor, selectBackground, selectForeground и troughColor; для любых неуказанных опций вычисляются разумные значения по умолчанию.

tk_bisque()¶

Восстанавливает цвета приложения к светлой коричневой (bisque) цветовой схеме, использовавшейся в Tk 3.6 и более ранних версиях. Предусмотрено для обратной совместимости.

tk_strictMotif(boolean=None)¶

Запрашивает или устанавливает, должен ли внешний вид Tk строго соответствовать Motif. Значение boolean, равное true, включает строгое соответствие Motif (например, отсутствие изменения цвета при наведении мыши на ползунок). Возвращает результирующую настройку.

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

tk_busy_hold(**kw)¶

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

Единственная поддерживаемая опция конфигурации – cursor, курсор, отображаемый пока виджет занят; он может принимать любое из значений, принимаемых configure().

busy_hold(), busy() и tk_busy() являются псевдонимами tk_busy_hold().

Добавлено в версии 3.13.

tk_busy_configure(cnf=None, **kw)¶

Запрос или изменение параметров конфигурации занятого окна. Виджет должен быть предварительно переведён в состояние «занят» с помощью tk_busy_hold(). Без аргументов возвращает словарь со всеми доступными опциями; если cnf – имя опции, возвращает кортеж с её описанием. В противном случае устанавливает указанные опции в заданные значения. Опции могут принимать любые значения, поддерживаемые tk_busy_hold().

База данных опций обращается по имени или классу виджета. Например, если виджет Frame с именем frame должен быть сделан занятым, для него можно указать курсор ожидания с помощью любого из вызовов:

w.option_add('*frame.busyCursor', 'gumby')
w.option_add('*Frame.BusyCursor', 'gumby')

busy_configure(), busy_config() и tk_busy_config() – это псевдонимы tk_busy_configure().

Добавлено в версии 3.13.

tk_busy_cget(option)¶

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

busy_cget() является псевдонимом tk_busy_cget().

Добавлено в версии 3.13.

tk_busy_forget()¶

Переводит виджет из состояния «занят» обратно, освобождая ресурсы (включая прозрачное окно), выделенные при его занятости. Виджет снова начнёт получать события пользователя. Эти ресурсы также освобождаются при уничтожении виджета.

busy_forget() является псевдонимом tk_busy_forget().

Добавлено в версии 3.13.

tk_busy_status()¶

Возвращает True, если виджет в данный момент занят, иначе False.

busy_status() является псевдонимом tk_busy_status().

Добавлено в версии 3.13.

tk_busy_current(pattern=None)¶

Возвращает список виджетов, которые в данный момент заняты. Если указан pattern, возвращаются только занятые виджеты, чьи имена путей соответствуют шаблону.

busy_current() является псевдонимом tk_busy_current().

Добавлено в версии 3.13.

Методы с префиксом winfo_ получают информацию об окнах, управляемых Tk.

winfo_atom(name, displayof=0)¶

Возвращает целочисленный идентификатор атома с именем name, создавая новый атом, если такого не существует. Если указан displayof, атом ищется на экране этого окна; в противном случае – на экране главного окна приложения.

winfo_atomname(id, displayof=0)¶

Возвращает текстовое имя атома с целочисленным идентификатором id. Это обратная операция к winfo_atom(). Если указан displayof, идентификатор ищется на экране этого окна; в противном случае – на экране главного окна приложения.

winfo_cells()¶

Возвращает количество ячеек в цветовой карте (colormap) виджета.

winfo_children()¶

Возвращает список виджетов, являющихся дочерними по отношению к данному виджету, в порядке стека от нижнего к верхнему. Окна верхнего уровня возвращаются как дочерние своих логических родителей.

winfo_class()¶

Возвращает имя класса виджета.

winfo_colormapfull()¶

Возвращает True, если известно, что цветовая карта виджета заполнена, иначе False.

winfo_containing(rootX, rootY, displayof=0)¶

Возвращает виджет, содержащий точку с координатами rootX и rootY, или None, если ни одно окно в приложении не содержит эту точку. Координаты задаются в экранных единицах в системе координат корневого окна. Если указан displayof, координаты относятся к экрану, содержащему это окно; в противном случае – к экрану главного окна приложения.

winfo_depth()¶

Возвращает глубину цвета виджета, то есть количество бит на пиксель.

winfo_exists()¶

Возвращает 1, если виджет существует, и 0 в противном случае.

winfo_fpixels(number)¶

Возвращает число с плавающей запятой, показывающее количество пикселей в виджете, соответствующее экранному расстоянию number (например, "2.0c" или "1i"). Результат может быть дробным; для округлённого целого значения используйте winfo_pixels().

winfo_geometry()¶

Возвращает геометрию виджета в формате widthxheight+x+y. Все размеры указаны в пикселях. Смещение может быть отрицательным; см. geometry().

winfo_height()¶

Возвращает высоту виджета в пикселях. При первом создании окна его высота равна 1 пикселю; впоследствии она изменяется менеджером геометрии. См. также winfo_reqheight().

winfo_id()¶

Возвращает низкоуровневый платформенно-зависимый идентификатор виджета. В Unix это идентификатор X-окна, а в Windows – дескриптор окна.

winfo_interps(displayof=0)¶

Возвращает кортеж имён всех интерпретаторов Tcl, зарегистрированных в данный момент для конкретного дисплея. Если указан displayof, возвращаемое значение относится к дисплею этого окна; в противном случае – к дисплею главного окна приложения.

winfo_ismapped()¶

Возвращает 1, если виджет в данный момент отображён, и 0 в противном случае.

winfo_manager()¶

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

winfo_name()¶

Возвращает имя виджета внутри его родительского элемента, в отличие от полного путевого имени.

winfo_parent()¶

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

winfo_pathname(id, displayof=0)¶

Возвращает путевое имя окна, идентификатор которого равен id. Если указан displayof, идентификатор ищется на дисплее этого окна; в противном случае – на дисплее главного окна приложения.

winfo_pixels(number)¶

Возвращает количество пикселей в виджете, соответствующее экранному расстоянию number (например, "2.0c" или "1i"). Результат округляется до ближайшего целого; для получения дробного результата используйте winfo_fpixels().

winfo_pointerx()¶

Возвращает координату x указателя в пикселях относительно корневого окна экрана (или виртуального корня, если он используется). Возвращает -1, если указатель находится не на том же экране, что и виджет.

winfo_pointerxy()¶

Возвращает координаты указателя в виде кортежа (x, y) в пикселях относительно корневого окна экрана (или виртуального корня, если он используется). Обе координаты равны -1, если указатель находится не на том же экране, что и виджет.

winfo_pointery()¶

Возвращает координату y указателя в пикселях относительно корневого окна экрана (или виртуального корня, если он используется). Возвращает -1, если указатель находится не на том же экране, что и виджет.

winfo_reqheight()¶

Возвращает запрошенную высоту виджета в пикселях. Это значение используется менеджером геометрии виджета для вычисления его геометрии.

winfo_reqwidth()¶

Возвращает запрошенную ширину виджета в пикселях. Это значение используется менеджером геометрии виджета для вычисления его геометрии.

winfo_rgb(color)¶

Возвращает кортеж (r, g, b) из интенсивностей красного, зелёного и синего в диапазоне от 0 до 65535, соответствующих color в виджете. color может быть задан в любой форме, допустимой для параметра цвета.

winfo_rootx()¶

Возвращает координату x в корневом окне экрана для верхнего левого угла границы виджета (или самого виджета, если у него нет границы).

winfo_rooty()¶

Возвращает координату y в корневом окне экрана для верхнего левого угла границы виджета (или самого виджета, если у него нет границы).

winfo_screen()¶

Возвращает имя экрана, связанного с виджетом, в форме displayName.screenIndex.

winfo_screencells()¶

Возвращает количество ячеек в цветовой карте по умолчанию для экрана виджета.

winfo_screendepth()¶

Возвращает глубину корневого окна экрана виджета, то есть количество бит на пиксель.

winfo_screenheight()¶

Возвращает высоту экрана виджета в пикселях.

winfo_screenmmheight()¶

Возвращает высоту экрана виджета в миллиметрах.

winfo_screenmmwidth()¶

Возвращает ширину экрана виджета в миллиметрах.

winfo_screenvisual()¶

Возвращает класс визуализации по умолчанию для экрана виджета: "directcolor", "grayscale", "pseudocolor", "staticcolor", "staticgray", или "truecolor".

winfo_screenwidth()¶

Возвращает ширину экрана виджета в пикселях.

winfo_server()¶

Возвращает строку с информацией о сервере дисплея виджета. Точный формат этой строки может различаться в зависимости от платформы.

winfo_toplevel()¶

Возвращает окно верхнего уровня иерархии, содержащее виджет. В стандартном Tk это всегда виджет Toplevel.

winfo_viewable()¶

Возвращает 1, если виджет и все его предки вплоть до ближайшего окна верхнего уровня отображены, и 0 в противном случае.

winfo_visual()¶

Возвращает класс визуализации для виджета: "directcolor", "grayscale", "pseudocolor", "staticcolor", "staticgray", или "truecolor".

winfo_visualid()¶

Возвращает X-идентификатор визуального представления виджета.

winfo_visualsavailable(includeids=False)¶

Возвращает список доступных для экрана виджета визуальных представлений. Каждый элемент состоит из класса визуального представления (см. winfo_visual()) и целочисленной глубины. Если includeids равно true, также включается X-идентификатор визуального представления.

winfo_vrootheight()¶

Возвращает высоту виртуального корневого окна, связанного с виджетом, если таковое существует; в противном случае возвращает высоту экрана виджета.

winfo_vrootwidth()¶

Возвращает ширину виртуального корневого окна, связанного с виджетом, если таковое существует; в противном случае возвращает ширину экрана виджета.

winfo_vrootx()¶

Возвращает смещение x виртуального корневого окна, связанного с виджетом, относительно корневого окна его экрана. Обычно равно нулю или отрицательное, и равно 0, если виртуальное корневое окно отсутствует.

winfo_vrooty()¶

Возвращает смещение y виртуального корневого окна, связанного с виджетом, относительно корневого окна его экрана. Обычно равно нулю или отрицательное, и равно 0, если виртуальное корневое окно отсутствует.

winfo_width()¶

Возвращает ширину виджета в пикселях. При первом создании окна его ширина равна 1 пикселю; впоследствии она изменяется менеджером геометрии. См. также winfo_reqwidth().

winfo_x()¶

Возвращает x-координату верхнего левого угла рамки виджета (или самого виджета, если у него нет рамки) в родительском контейнере.

winfo_y()¶

Возвращает y-координату верхнего левого угла рамки виджета (или самого виджета, если у него нет рамки) в родительском контейнере.

info_patchlevel()¶

Возвращает уровень патча Tcl/Tk в виде именованного кортежа с теми же пятью полями, что и sys.version_info: major, minor, micro, releaselevel и serial. releaselevel принимает значения 'alpha', 'beta' или 'final'. При преобразовании в строку получается версия в обычной записи Tcl/Tk, например '9.0.3' для финального релиза или '9.1b2' для предварительной версии.

Добавлено в версии 3.12.

class tkinter.Wm¶

Миксин Wm предоставляет доступ к оконному менеджеру, позволяя приложению управлять такими вещами, как заголовок, геометрия и значок окна верхнего уровня, способ его изменения размера, а также реакция на протоколы оконного менеджера. Он встраивается в Tk и Toplevel, поэтому его методы доступны для любого окна верхнего уровня. Каждый метод имеет два эквивалентных написания: короткое имя и имя с префиксом wm_ (например, title() и wm_title()).

aspect(minNumer=None, minDenom=None, maxNumer=None, maxDenom=None)¶

Ограничивает соотношение сторон (отношение ширины к высоте) окна. Если указаны все четыре аргумента, оконный менеджер поддерживает соотношение между minNumer/minDenom и maxNumer/maxDenom; передача пустых строк снимает все существующие ограничения. Без аргументов возвращает кортеж из четырёх текущих значений или пустую строку, если ограничение соотношения не действует. wm_aspect() – это псевдоним aspect().

attributes(*args, return_python_dict=False, **kwargs)¶

Запрашивает или задаёт платформо-зависимые атрибуты окна. Без аргументов возвращает платформо-зависимые флаги и их значения; передайте return_python_dict равным true, чтобы получить их в виде словаря. Одно имя опции, например 'alpha', возвращает значение этой опции, а опции задаются с помощью именованных аргументов (alpha=0.5).

Доступные атрибуты различаются в зависимости от платформы. Все платформы поддерживают:

alpha

Непрозрачность окна от 0.0 (полностью прозрачно) до 1.0 (непрозрачно). Если прозрачность не поддерживается, значение остаётся 1.0.

внешний вид

Определяет, отображается ли окно в тёмном режиме в Windows и macOS: 'auto', 'light' или 'dark' (не действует на X11).

полноэкранный

Определяет, развёрнуто ли окно на весь экран и не имеет ли границ.

поверх всех окон

Определяет, отображается ли окно поверх всех остальных окон.

Windows также поддерживает:

отключён

Определяет, находится ли окно в отключённом состоянии.

окно инструментов

Определяет, использует ли окно стиль инструментального окна.

прозрачный цвет

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

macOS также поддерживает:

класс

Определяет, является ли базовое окно Aqua nswindow или nspanel; это можно установить только до создания окна.

изменён

Состояние изменения, отображаемое кнопкой закрытия окна и значком-заместителем.

уведомить

Определяет, подпрыгивает ли значок приложения в доке, чтобы привлечь внимание.

маска стиля

Маска стиля базового окна Aqua, задаваемая в виде списка имён битов, таких как titled или resizable.

идентификатор вкладок

Идентификатор группы вкладок, к которой принадлежит окно.

режим вкладок

Определяет, может ли окно быть открыто как вкладка: 'auto', 'preferred' или 'disallowed'.

путь заголовка

Путь к файлу, представленному значком-заместителем окна.

прозрачный

Определяет, является ли область содержимого прозрачной и отключена ли тень окна.

X11 также поддерживает:

тип

Тип окна или список типов в порядке предпочтения, который менеджер окон должен использовать для интерпретации окна, например 'dialog' или 'splash'.

увеличен

Определяет, развёрнуто ли окно на весь экран.

Примечание

Tk 8.6 добавил атрибут type, а Tk 9.0 добавил атрибуты appearance, class, stylemask, tabbingid и tabbingmode.

В X11 изменения применяются асинхронно, поэтому запрошенное значение может ещё не отражать самый последний запрос. wm_attributes() является псевдонимом attributes().

Изменено в версии 3.13: Теперь отдельный атрибут можно запросить по имени без начального -, а атрибуты можно задавать с помощью именованных аргументов. Был добавлен параметр return_python_dict.

Устарело с версии 3.13: Установка атрибута путём передачи имени опции (с начальным -) и её значения в виде двух позиционных аргументов, как в w.attributes('-alpha', 0.5), устарела; вместо этого используйте именованные аргументы.

client(name=None)¶

Сохраняет name (должно быть именем хоста, на котором выполняется приложение) в свойстве WM_CLIENT_MACHINE окна для использования оконным менеджером или менеджером сессий. Пустая строка удаляет это свойство. Без аргументов возвращает последнее установленное имя или пустую строку. wm_client() – это псевдоним client().

colormapwindows(*wlist)¶

Управляет свойством WM_COLORMAP_WINDOWS, которое сообщает оконному менеджеру об окнах, имеющих частные цветовые карты. Если задан wlist, перезаписывает свойство этими окнами (их порядок – это приоритет для установки цветовых карт). Без аргументов возвращает список окон, указанных в данный момент в свойстве. wm_colormapwindows() – это псевдоним colormapwindows().

command(value=None)¶

Сохраняет value в свойстве WM_COMMAND окна для использования оконным менеджером или менеджером сессий; это должен быть список слов команды, использованной для запуска приложения. Пустая строка удаляет свойство. Без аргументов возвращает последнее установленное значение или пустую строку. wm_command() – это псевдоним command().

deiconify()¶

Отображает окно в обычной (не свёрнутой) форме, отображая его на экране. Если окно ещё ни разу не отображалось, это гарантирует, что при первом отображении оно появится уже развёрнутым. В Windows окно также поднимается и получает фокус. wm_deiconify() – это псевдоним deiconify().

focusmodel(model=None)¶

Устанавливает или запрашивает модель фокуса для окна. model может быть 'active' (окно заявляет о получении фокуса ввода для себя или своих потомков, даже когда фокус находится в другом приложении) или 'passive' (окно полагается на оконный менеджер, чтобы тот дал ему фокус). Без аргумента возвращает текущую модель. По умолчанию используется 'passive', что предполагает команда focus(). wm_focusmodel() – это псевдоним focusmodel().

forget(window)¶

Скрывает window с экрана, так что оно больше не управляется оконным менеджером. Затем Toplevel обрабатывается как Frame, хотя его конфигурация -menu запоминается, и меню снова появляется, если виджет снова становится управляемым. wm_forget() – это псевдоним forget().

Не путать с Pack.forget().

Добавлено в версии 3.3.

frame()¶

Возвращает платформенно-зависимый идентификатор окна для самого внешнего декоративного фрейма, содержащего окно, если оконный менеджер поместил его в такой фрейм; в противном случае возвращает идентификатор самого окна. wm_frame() – это псевдоним frame().

geometry(newGeometry=None)¶

Устанавливает или запрашивает геометрию окна. newGeometry имеет форму =widthxheight+x+y, где любая из =, widthxheight и позиция +x+y может быть опущена. width и height задаются в пикселях (или в единицах сетки для окна с сеткой); позиция, перед которой стоит +, отсчитывается от левого или верхнего края экрана, а позиция, перед которой стоит -, – от правого или нижнего края. Смещение может быть отрицательным, как в '200x100+-9+-8', когда край окна выходит за соответствующий край экрана. Пустая строка отменяет любую заданную пользователем геометрию, позволяя окну вернуться к своему естественному размеру. Без аргумента возвращает текущую геометрию в виде строки вида '200x200+10+10'. wm_geometry() – это псевдоним geometry().

grid(baseWidth=None, baseHeight=None, widthInc=None, heightInc=None)¶

Управляет окном как окном с сеткой и определяет соотношение между единицами сетки и пикселями. baseWidth и baseHeight – это количество единиц сетки для внутреннего запрошенного размера окна, а widthInc и heightInc – это размеры в пикселях горизонтальной и вертикальной единицы сетки. Пустые строки отключают управление сеткой. Без аргументов возвращает кортеж из четырёх текущих значений или пустую строку, если окно не использует сетку. wm_grid() – это псевдоним grid().

Не путать с менеджером геометрии grid Grid.grid().

group(pathName=None)¶

Устанавливает или запрашивает лидера группы связанных окон. pathName задаёт путь к лидеру группы; оконный менеджер может, например, скрыть все окна в группе, когда лидер сворачивается. Пустая строка удаляет окно из любой группы. Без аргумента возвращает путь к текущему лидеру группы или пустую строку. wm_group() – это псевдоним group().

iconbitmap(bitmap=None, default=None)¶

Устанавливает или запрашивает битовую карту, используемую оконным менеджером для значка окна. bitmap задаёт битовую карту в одной из стандартных форм, принимаемых Tk; пустая строка отменяет текущую битовую карту значка. Без аргумента возвращает имя текущей битовой карты значка или пустую строку. В Windows аргумент default задаёт значок (например, файл .ico), применяемый ко всем окнам верхнего уровня, у которых нет собственного значка. wm_iconbitmap() – это псевдоним iconbitmap().

iconify()¶

Сворачивает окно. Если окно ещё не было отображено в первый раз, обеспечивает его отображение в свёрнутом состоянии при последующем отображении. wm_iconify() – это псевдоним iconify().

iconmask(bitmap=None)¶

Устанавливает или запрашивает битовую карту, используемую в качестве маски для значка (см. iconbitmap()). Если маска равна нулю, значок не отображается; если единице, показываются соответствующие биты битовой карты значка. Пустая строка отменяет текущую маску. Без аргумента возвращает имя текущей маски значка или пустую строку. wm_iconmask() – это псевдоним iconmask().

iconname(newName=None)¶

Устанавливает или запрашивает имя, отображаемое оконным менеджером внутри значка окна. Без аргумента возвращает текущее имя значка или пустую строку, если ничего не было установлено (в этом случае оконный менеджер обычно отображает заголовок окна). wm_iconname() – это псевдоним iconname().

iconphoto(default=False, *images)¶

Устанавливает значок заголовка окна из одного или нескольких объектов PhotoImage, переданных в images. Можно передать несколько изображений разных размеров (например, 16×16 и 32×32), чтобы оконный менеджер мог выбрать подходящее. Данные изображения берутся как снимок на момент вызова; последующие изменения изображений не учитываются. Если default равно true, значок также применяется ко всем будущим окнам верхнего уровня. В macOS используется только первое изображение. wm_iconphoto() – псевдоним iconphoto().

Добавлено в версии 3.3.

iconposition(x=None, y=None)¶

Устанавливает или запрашивает подсказку оконному менеджеру о том, где должен располагаться значок окна. Пустые строки отменяют имеющуюся подсказку. Без аргументов возвращает кортеж из двух текущих значений или пустую строку, если подсказка не задана. wm_iconposition() – псевдоним iconposition().

iconwindow(pathName=None)¶

Устанавливает или запрашивает окно, используемое в качестве значка окна. Когда окно свёрнуто, pathName отображается как его значок и снова скрывается при восстановлении. Пустая строка отменяет привязку. Без аргументов возвращает путь текущего окна-значка или пустую строку. Не все оконные менеджеры поддерживают окна-значки, и эта концепция бессмысленна на платформах, отличных от X11. wm_iconwindow() – псевдоним iconwindow().

manage(widget)¶

Делает widget самостоятельным окном верхнего уровня, оформленным оконным менеджером с заголовком и т.д. Могут использоваться только виджеты Frame, LabelFrame и Toplevel (версии из tkinter.ttk не принимаются); передача любого другого типа виджета вызывает ошибку. wm_manage() – псевдоним manage().

Добавлено в версии 3.3.

maxsize(width=None, height=None)¶

Устанавливает или запрашивает максимально допустимые размеры окна в пикселях (или в единицах сетки для окна с сеткой). Оконный менеджер ограничивает окно размерами не больше width и height. Без аргументов возвращает кортеж текущих максимальной ширины и высоты. Максимальный размер по умолчанию равен размеру экрана. wm_maxsize() – псевдоним maxsize().

minsize(width=None, height=None)¶

Устанавливает или запрашивает минимально допустимые размеры окна в пикселях (или в единицах сетки для окна с сеткой). Оконный менеджер ограничивает окно размерами не меньше width и height. Без аргументов возвращает кортеж текущих минимальной ширины и высоты. Минимальный размер по умолчанию – один пиксель по каждому измерению. wm_minsize() – псевдоним minsize().

overrideredirect(boolean=None)¶

Устанавливает или запрашивает флаг override-redirect для окна. Когда этот флаг установлен, оконный менеджер игнорирует окно: оно не помещается в декоративную рамку, и пользователь не может управлять им через обычные элементы управления оконного менеджера. Без аргументов возвращает булево значение, указывающее, установлен ли флаг. Флаг надёжно соблюдается только при первом отображении окна или при повторном отображении из состояния withdrawn. wm_overrideredirect() – псевдоним overrideredirect().

positionfrom(who=None)¶

Устанавливает или запрашивает источник текущего положения окна. who может быть 'program' или 'user', указывает, было ли положение запрошено программой или пользователем; пустая строка отменяет текущий источник. Без аргументов возвращает текущий источник или пустую строку, если источник не установлен. Tk автоматически устанавливает источник в 'user' при вызове geometry(), если только явно не установлен 'program'. wm_positionfrom() – псевдоним positionfrom().

protocol(name=None, func=None)¶

Регистрирует func в качестве обработчика протокола оконного менеджера name, атома, такого как 'WM_DELETE_WINDOW', 'WM_SAVE_YOURSELF' или 'WM_TAKE_FOCUS'; после этого func вызывается при каждом получении сообщения этого протокола от оконного менеджера. Tk устанавливает обработчик по умолчанию для WM_DELETE_WINDOW, который уничтожает окно; этот метод может его заменить. Если func – пустая строка, обработчик удаляется. Только с name возвращает имя зарегистрированной команды-обработчика или пустую строку, если обработчик не установлен (обработчик по умолчанию для WM_DELETE_WINDOW не сообщается); без аргументов возвращает кортеж протоколов, для которых в данный момент есть обработчики. wm_protocol() – псевдоним protocol().

resizable(width=None, height=None)¶

Управляет возможностью интерактивного изменения размера окна пользователем. width и height – булевы значения, определяющие, можно ли изменять ширину и высоту окна. Без аргументов возвращает кортеж из двух значений 0/1, указывающих, можно ли изменять каждый размер в данный момент. По умолчанию размер окна можно изменять по обоим измерениям. wm_resizable() – псевдоним resizable().

sizefrom(who=None)¶

Устанавливает или запрашивает источник текущего размера окна. who может быть 'program' или 'user', указывает, был ли размер запрошен программой или пользователем; пустая строка отменяет текущий источник. Без аргументов возвращает текущий источник или пустую строку, если источник не установлен. wm_sizefrom() – псевдоним sizefrom().

state(newstate=None)¶

Устанавливает или запрашивает состояние окна. Без аргументов возвращает текущее состояние: одно из 'normal', 'iconic', 'withdrawn', 'icon' или, только в Windows и macOS, 'zoomed'. 'iconic' относится к свёрнутому окну, тогда как 'icon' – к окну, служащему значком для другого окна (см. iconwindow()); состояние 'icon' не может быть установлено. wm_state() – псевдоним state().

Не путать с ttk.Widget.state.

title(string=None)¶

Устанавливает или запрашивает заголовок окна, который оконный менеджер должен отображать в строке заголовка. Без аргументов возвращает текущий заголовок. По умолчанию заголовок равен имени окна. wm_title() – псевдоним title().

transient(master=None)¶

Помечает окно как временное (например, выпадающее меню или диалог), работающее от имени master, пути к другому окну верхнего уровня. Пустая строка снимает статус временного окна. Без аргументов возвращает путь текущего владельца или пустую строку. Временное окно отражает изменения состояния своего владельца и может оформляться оконным менеджером иначе; ошибка – сделать окно временным для самого себя. wm_transient() – псевдоним transient().

withdraw()¶

Убирает окно с экрана, скрывая его и заставляя оконный менеджер забыть о нём. Если окно никогда не отображалось, оно отображается в состоянии withdrawn. Иногда необходимо скрыть окно и снова отобразить его (например, с помощью deiconify()), чтобы некоторые оконные менеджеры заметили изменения атрибутов окна. wm_withdraw() – псевдоним withdraw().

class tkinter.Pack¶

Менеджер геометрии, который размещает виджеты, прижимая их к сторонам контейнера. Миксин Pack наследуется всеми виджетами (через Widget) и предоставляет методы для управления виджетом с помощью менеджера геометрии pack. См. также паковщик.

Примечание

Pack, Place и Grid определяют короткие имена методов forget(), info(), slaves(), content() и propagate(). Для виджета эти простые имена разрешаются в версии менеджера pack, поскольку Pack и Misc предшествуют Place и Grid в порядке разрешения методов, независимо от того, какой менеджер фактически управляет виджетом; а configure()/config() настраивают параметры виджета, а не его геометрию. Используйте явные методы pack_*, grid_* и place_* (и pack, grid, place для настройки геометрии), чтобы воздействовать на конкретный менеджер геометрии.

pack_configure(cnf={}, **kw)¶

pack(cnf={}, **kw)¶

Упаковывает виджет внутри его контейнера, позиционируя его относительно уже упакованных там соседних виджетов. Поддерживаемые параметры:

side

К какой стороне контейнера прижимать виджет: 'top' (по умолчанию), 'bottom', 'left' или 'right'.

fill

Следует ли растягивать виджет, чтобы заполнить его участок: 'none' (по умолчанию), 'x', 'y' или 'both'.

expand

Следует ли виджету расширяться, чтобы занять лишнее пространство в его контейнере (логическое значение, по умолчанию false).

anchor

Где позиционировать виджет в его участке, когда участок больше виджета: привязка, например 'n' или 'sw' (по умолчанию 'center').

ipadx, ipady

Внутренний отступ, добавляемый слева и справа (ipadx) или сверху и снизу (ipady) от виджета, задаётся в экранных единицах (по умолчанию 0).

padx, pady

Внешний отступ, оставляемый слева и справа (padx) или сверху и снизу (pady) от виджета, задаётся в экранных единицах или как пара значений для каждой из двух сторон (по умолчанию 0).

after

Упаковывает виджет после указанного виджета в порядке упаковки, используя тот же контейнер.

before

Упаковывает виджет перед указанным виджетом в порядке упаковки, используя тот же контейнер.

in_

Контейнер, в который упаковывать виджет; по умолчанию – родительский виджет.

pack(), configure() и config() являются псевдонимами pack_configure().

pack_forget()¶

Убирает виджет и удаляет его из порядка упаковки, забывая его параметры упаковки. Позже его можно снова упаковать с помощью pack_configure(). forget() является псевдонимом pack_forget(), за исключением PanedWindow, ttk.Notebook и ttk.PanedWindow, которые предоставляют собственный метод forget().

Не путать с Wm.forget().

pack_info()¶

Возвращает словарь текущих параметров упаковки виджета. info() является псевдонимом pack_info().

pack_propagate()¶

pack_propagate(flag)

То же, что и Misc.pack_propagate(), рассматривая этот виджет как контейнер: включить или отключить распространение геометрии. propagate() является псевдонимом pack_propagate().

pack_slaves()¶

То же, что и Misc.pack_slaves(): возвращает список виджетов, упакованных в этот виджет. slaves() – псевдоним pack_slaves().

class tkinter.Place¶

Менеджер геометрии, размещающий виджеты в явных позициях и размерах внутри их контейнера. Примесь Place наследуется всеми виджетами (через Widget).

place_configure(cnf={}, **kw)¶

place(cnf={}, **kw)¶

Размещает виджет внутри его контейнера в абсолютной или относительной позиции. Поддерживаемые опции:

x, y

Абсолютные горизонтальная и вертикальная позиции опорной точки виджета как экранное расстояние (по умолчанию 0).

relx, rely

Горизонтальная и вертикальная позиции опорной точки виджета как доля ширины и высоты контейнера, где 0.0 – это левый или верхний край, а 1.0 – правый или нижний край. Если указаны как абсолютная, так и относительная опции, их значения суммируются.

anchor

Какая точка виджета размещается в заданной позиции: опорная точка, например 'n' или 'se' (по умолчанию 'nw').

width, height

Абсолютные ширина и высота виджета как экранное расстояние. По умолчанию используется запрошенный размер виджета.

relwidth, relheight

Ширина и высота виджета как доля ширины и высоты контейнера. Если указаны как абсолютная, так и относительная опции, их значения суммируются.

bordermode

Как граница контейнера влияет на размещение: 'inside' (по умолчанию) измеряет область внутри границы, 'outside' измеряет область, включая границу, а 'ignore' использует официальную область X.

in_

Контейнер, относительно которого размещается виджет; он должен быть родителем виджета или потомком родителя, по умолчанию – родитель.

place(), configure() и config() являются псевдонимами place_configure().

place_forget()¶

Скрыть виджет и удалить его из размещения, забыв его опции размещения.

place_info()¶

Возвращает словарь текущих опций размещения виджета.

place_slaves()¶

То же, что и Misc.place_slaves(): возвращает список виджетов, размещённых в этом виджете.

class tkinter.Grid¶

Менеджер геометрии, располагающий виджеты в двумерной сетке строк и столбцов внутри их контейнера. Примесь Grid наследуется всеми виджетами (через Widget).

grid_configure(cnf={}, **kw)¶

grid(cnf={}, **kw)¶

Помещает виджет в ячейку сетки его контейнера.

Не путать с Wm.grid().

Поддерживаемые параметры:

строка, столбец

Строка и столбец ячейки, в которую помещается виджет, с отсчётом от 0. Столбец по умолчанию равен столбцу, следующему за последним виджетом, помещённым в том же вызове grid_configure() (или 0), а строка по умолчанию равна следующей пустой строке.

rowspan, columnspan

Количество строк и столбцов, которое должен охватывать виджет (по умолчанию 1).

sticky

Определяет расположение или растяжение виджета, когда его ячейка больше самого виджета: строка, содержащая ноль или более символов из 'n', 's', 'e' и 'w', указывающих стороны ячейки, к которым прикрепляется виджет. Указание одновременно 'n' и 's' (или 'e' и 'w') растягивает виджет на всю высоту (или ширину) ячейки. По умолчанию '' – виджет центрируется в ячейке с сохранением запрошенного размера.

ipadx, ipady

Внутренний отступ, добавляемый слева и справа (ipadx) или сверху и снизу (ipady) от виджета, задаётся в экранных единицах (по умолчанию 0).

padx, pady

Внешний отступ, оставляемый слева и справа (padx) или сверху и снизу (pady) от виджета, задаётся в экранных единицах или как пара значений для каждой из двух сторон (по умолчанию 0).

in_

Контейнер, в сетку которого помещается виджет; по умолчанию – родительский виджет.

grid(), configure() и config() являются псевдонимами grid_configure().

grid_forget()¶

Скрывает виджет и удаляет его из сетки, забывая его параметры сетки.

grid_remove()¶

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

grid_info()¶

Возвращает словарь текущих параметров сетки виджета.

grid_bbox(column=None, row=None, col2=None, row2=None)¶

То же, что и Misc.grid_bbox(). bbox() – псевдоним grid_bbox(), за исключением Canvas, Listbox, Spinbox, Text, ttk.Entry и ttk.Treeview, которые предоставляют собственный метод bbox().

grid_columnconfigure(index, cnf={}, **kw)¶

То же, что Misc.grid_columnconfigure(): запрашивает или задаёт параметры столбца сетки (такие как weight, minsize, pad и uniform). columnconfigure() – псевдоним grid_columnconfigure().

grid_rowconfigure(index, cnf={}, **kw)¶

То же, что Misc.grid_rowconfigure(): запрашивает или задаёт параметры строки сетки. rowconfigure() – псевдоним grid_rowconfigure().

grid_location(x, y)¶

То же, что Misc.grid_location(): возвращает (column, row) ячейки, которая содержит пиксель с координатами x, y. location() – псевдоним grid_location().

grid_size()¶

То же, что Misc.grid_size(): возвращает кортеж (columns, rows), содержащий размеры сетки. size() – псевдоним grid_size(), за исключением виджета Listbox, который предоставляет собственный метод size().

grid_propagate()¶

grid_propagate(flag)

То же, что и Misc.grid_propagate().

grid_slaves(row=None, column=None)¶

То же, что и Misc.grid_slaves(): возвращает виджеты, управляемые сеткой, с возможностью ограничения по строке и/или столбцу.

class tkinter.XView¶

Примесь, предоставляющая интерфейс горизонтальной прокрутки, общий для виджетов, таких как Entry, Canvas, Listbox, Text и Spinbox. Метод xview() виджета регистрируется как команда горизонтального Scrollbar.

xview(*args)¶

Запрашивает или изменяет горизонтальное положение вида. Без аргументов возвращает кортеж (first, last) из двух дробей от 0 до 1, указывающих долю документа, которая в данный момент видна. В противном случае аргументы передаются команде виджета Tk xview и обычно генерируются полосой прокрутки; xview_moveto() и xview_scroll() предоставляют более удобный интерфейс.

xview_moveto(fraction)¶

Настраивает вид так, чтобы fraction от общей ширины документа находилось слева за экраном. fraction – число от 0 до 1.

xview_scroll(number, what)¶

Сдвигает вид влево или вправо на число единиц. what может быть 'units' или 'pages'; отрицательное число прокручивает влево, положительное – вправо.

class tkinter.YView¶

Примесь, предоставляющая интерфейс вертикальной прокрутки, общий для виджетов, таких как Canvas, Listbox и Text. Метод yview() виджета регистрируется как команда вертикального Scrollbar.

yview(*args)¶

Запрашивает или изменяет вертикальное положение вида. Без аргументов возвращает кортеж (first, last) из двух дробей от 0 до 1, указывающих долю документа, которая в данный момент видна. В противном случае аргументы передаются команде виджета Tk yview, обычно генерируемой полосой прокрутки; yview_moveto() и yview_scroll() предоставляют более удобный интерфейс.

yview_moveto(fraction)¶

Настраивает вид так, чтобы fraction от общей высоты документа находилось над верхней границей экрана. fraction – число от 0 до 1.

yview_scroll(number, what)¶

Сдвигает вид вверх или вниз на число единиц. what может быть 'units' или 'pages'; отрицательное число прокручивает вверх, положительное – вниз.

class tkinter.BaseWidget(master, widgetName, cnf={}, kw={}, extra=())¶

Внутренний базовый класс для всех виджетов. Наследует от Misc и добавляет механизм, который создаёт нижележащий Tk-виджет; прикладной код обычно использует Widget или конкретный класс виджета, а не создаёт экземпляр BaseWidget напрямую.

destroy()¶

Уничтожает этот виджет и все его дочерние элементы, удаляя соответствующие Tk-виджеты и связанные команды Tcl.

class tkinter.Widget(master, widgetName, cnf={}, kw={}, extra=())¶

Внутренний базовый класс для стандартных виджетов. Объединяет BaseWidget с примесями менеджеров геометрии Pack, Place и Grid, так что любой виджет может управляться любым из трёх менеджеров геометрии. Конкретные классы виджетов (Button, Label и так далее) наследуют от Widget.

Виджеты верхнего уровня¶Toplevel widgets

class tkinter.Tk(screenName=None, baseName=None, className='Tk', useTk=True, sync=False, use=None)¶

Создаёт виджет верхнего уровня Tk, который обычно является главным окном приложения, и инициализирует для него интерпретатор Tcl. Каждый экземпляр имеет свой собственный связанный интерпретатор Tcl. Наследует от Misc и Wm.

Чтобы создать интерпретатор Tcl без инициализации подсистемы Tk, используйте фабричную функцию Tcl().

Класс Tk обычно создаётся со значениями по умолчанию. Однако в настоящее время распознаются следующие именованные аргументы:

screenName

При указании (в виде строки) устанавливает переменную окружения DISPLAY. (только X11)

baseName

Имя файла профиля. По умолчанию baseName берётся из имени программы (sys.argv[0]).

className

Имя класса виджета. Используется как файл профиля, а также как имя, с которым вызывается Tcl (argv0 в interp).

useTk

Если True, инициализировать подсистему Tk. Функция tkinter.Tcl() устанавливает это в False.

sync

Если True, выполнять все команды X-сервера синхронно, чтобы ошибки сообщались немедленно. Может использоваться для отладки. (только X11)

use

Задаёт id окна, в которое встраивается приложение, вместо того чтобы создавать его как независимое окно верхнего уровня. id должен быть указан так же, как значение опции -use для виджетов верхнего уровня (то есть иметь форму, подобную возвращаемой winfo_id()).

Обратите внимание, что на некоторых платформах это будет работать корректно только если id ссылается на Tk-фрейм или окно верхнего уровня, у которых включена опция -container.

Tk читает и интерпретирует файлы профилей с именами .className.tcl и .baseName.tcl в интерпретатор Tcl и вызывает exec() для содержимого .className.py и .baseName.py. Путь к файлам профилей задаётся переменной окружения HOME или, если она не определена, то os.curdir.

Примечание

В Windows создание интерпретатора Tcl (путём создания экземпляра Tk или вызова Tcl()) устанавливает переменную окружения HOME для процесса, если она ещё не установлена, в %HOMEDRIVE%%HOMEPATH% (или USERPROFILE, или c:\). Это делается Tcl и может повлиять на другой код, который читает HOME.

tk¶

Объект приложения Tk, созданный созданием экземпляра Tk. Он предоставляет доступ к интерпретатору Tcl. Каждый виджет, прикреплённый к тому же экземпляру Tk, имеет одинаковое значение для своего атрибута tk.

master¶

Объект виджета, содержащий данный виджет. Для Tk master является None, потому что это главное окно. Термины master и parent похожи и иногда используются как взаимозаменяемые имена аргументов; однако вызов winfo_parent() возвращает строку с именем виджета, тогда как master возвращает объект. parent/child отражает древовидную связь, а master (или container)/content отражает структуру контейнера.

children¶

Непосредственные потомки этого виджета в виде dict с именами дочерних виджетов в качестве ключей и объектами экземпляров потомков в качестве значений.

destroy()¶

Уничтожить этот виджет и все дочерние виджеты, а для главного окна – завершить соединение с нижележащим интерпретатором Tcl.

loadtk()¶

Завершить загрузку и инициализацию подсистемы Tk. Это необходимо только в том случае, если интерпретатор был создан без Tk (например, через Tcl()); он вызывается автоматически, когда useTk равно true.

readprofile(baseName, className)¶

Прочитать и выполнить (source) пользовательские файлы профилей .className.tcl и .baseName.tcl в интерпретатор Tcl, и выполнить соответствующие файлы .className.py и .baseName.py. Это вызывается во время инициализации; см. описание конструктора выше.

report_callback_exception(exc, val, tb)¶

Сообщить об исключении в колбэке. Вызывается, когда исключение распространяется из колбэка Tkinter; exc, val и tb – это тип исключения, значение и трассировка, возвращаемые sys.exc_info(). Реализация по умолчанию выводит трассировку в sys.stderr. Может быть переопределена для настройки обработки ошибок, например для отображения трассировки в диалоговом окне.

class tkinter.Toplevel(master=None, cnf={}, **kw)¶

Виджет Toplevel – это окно верхнего уровня, похожее на Frame, за исключением того, что его X-родителем является корневое окно экрана, а не его логический родитель. Его основное назначение – служить контейнером для диалоговых окон и других наборов виджетов; его видимые особенности – это только фон и необязательная 3D-рамка. Из заметных опций: menu, которая устанавливает Menu в качестве строки меню окна. Наследуется от BaseWidget и Wm, поэтому окно верхнего уровня управляется оконным менеджером. Полный список опций см. в руководстве по Tk toplevel.

Классы виджетов¶Widget classes

class tkinter.Button(master=None, cnf={}, **kw)¶

Виджет Button отображает текстовую строку, растровое изображение или картинку и вызывает команду при нажатии (по клику кнопкой мыши 1 на кнопке или, когда кнопка в фокусе, по нажатию пробела). Наследует от Widget. В дополнение к стандартным опциям виджета, кнопка принимает опции, описанные на странице руководства Tk button, такие как command (колбэк, вызываемый при нажатии кнопки), textvariable, state и default.

invoke()¶

Вызывает команду, связанную с кнопкой, если она есть, и возвращает её результат, или пустую строку, если команда не задана. Игнорируется, если состояние кнопки disabled.

flash()¶

Мигает кнопкой, перерисовывая её несколько раз, чередуя активный и нормальный цвета. После мигания кнопка остаётся в том же нормальном или активном состоянии, что и при вызове метода. Игнорируется, если состояние кнопки disabled.

class tkinter.Canvas(master=None, cnf={}, **kw)¶

Виджет Canvas реализует структурированную графику. Он отображает любое количество элементов, таких как дуги, линии, овалы, многоугольники, прямоугольники, текст, растровые изображения, картинки и встроенные окна, которые можно рисовать, перемещать, менять их цвет и привязывать к событиям. Наследует от Widget, XView и YView, поэтому представление можно прокручивать по горизонтали и вертикали с помощью xview() и yview(). Обратитесь к странице руководства Tk canvas для полного списка опций виджета и элементов.

Каждый элемент имеет уникальный целочисленный id, присваиваемый при создании, и ноль или более строковых тегов. Тег – это произвольная строка, которая не должна иметь вид целого числа; один и тот же тег могут разделять несколько элементов, что делает теги удобными для группировки элементов. Специальный тег 'all' соответствует каждому элементу на холсте, а 'current' – верхнему элементу под указателем мыши. Большинство методов принимают аргумент tagOrId, который может быть целочисленным id, именующим один элемент, или тегом, именующим ноль или более элементов; как описано на странице руководства Tk canvas, тег также может быть логическим выражением из тегов, объединённых операторами &&, ||, ^, ! и скобками. Когда метод, работающий с одним элементом, получает tagOrId, соответствующий нескольким элементам, он обычно использует самый нижний подходящий элемент в списке отображения.

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

create_arc(*args, **kw)¶

create_bitmap(*args, **kw)¶

create_image(*args, **kw)¶

create_line(*args, **kw)¶

create_oval(*args, **kw)¶

create_polygon(*args, **kw)¶

create_rectangle(*args, **kw)¶

create_text(*args, **kw)¶

create_window(*args, **kw)¶

Создаёт новый элемент соответствующего типа и возвращает его целочисленный id. Каждый метод вызывается как create_TYPE(coord..., **options): первые позиционные аргументы задают координаты, определяющие элемент (отдельные числа, единая последовательность чисел или пары координат), а ключевые аргументы устанавливают специфичные для элемента опции. Координаты и расстояния на экране могут быть заданы числами (интерпретируются как пиксели) или строками с суффиксом единицы измерения ('m', 'c', 'i' или 'p' для миллиметров, сантиметров, дюймов или типографских пунктов), но всегда хранятся и возвращаются в пикселях.

Типы элементов: arc (область в форме дуги, являющаяся частью овала, задаваемая двумя диагонально противоположными углами x1, y1, x2, y2 ограничивающего прямоугольника); bitmap (двухцветное растровое изображение, расположенное в точке x, y); image (изображение Tk, расположенное в точке x, y); line (линия или кривая через точки x1, y1, ..., xn, yn); oval (окружность или эллипс, вписанный в прямоугольник x1, y1, x2, y2); polygon (замкнутый многоугольник через точки x1, y1, ..., xn, yn); rectangle (прямоугольник с углами x1, y1, x2, y2); text (текстовая строка, расположенная в точке x, y); и window (дочерний виджет, встроенный в холст в точке x, y, задаваемый опцией window).

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

Стандартные опции элементов:

fill

Цвет, используемый для заливки внутренней части элемента, или для рисования элемента line или символов элемента text. Пустая строка (значение по умолчанию для всех типов, кроме line и text) оставляет элемент незаполненным.

outline

Цвет, используемый для рисования контура элемента. Пустая строка означает отсутствие контура.

width

Ширина контура, по умолчанию 1.0. Не действует, если outline пусто.

dash

Штриховой узор для контура, задаваемый либо как последовательность длин сегментов в пикселях, либо как строка из символов '.', ',', '-', '_' и пробела. Пустой узор (по умолчанию) рисует сплошной контур.

dashoffset

Начальное смещение в пикселях в узоре dash. Игнорируется, если узор dash отсутствует.

stipple

Битовая карта, используемая как трафаретный узор при заливке элемента. Полноценно поддерживается только на X11.

outlinestipple

Битовая карта, используемая как трафаретный узор при рисовании контура. Не действует, если outline пуст.

offset, outlineoffset

Смещение узоров заливки и контура, задаваемое как 'x,y' или как сторона, например 'n', 'se' или 'center'. Смещения трафарета поддерживаются только на X11.

state

Переопределяет состояние холста для этого элемента; одно из 'normal', 'disabled' или 'hidden'.

tags

Один тег или последовательность тегов для привязки к элементу, заменяя все существующие теги.

У многих из этих опций есть варианты active… и disabled… (например, activefill, disabledfill, activewidth, disableddash, activeoutline, disabledstipple), которые переопределяют основную опцию, когда элемент является активным (под указателем мыши) или находится в отключённом состоянии.

Следующие типы элементов поддерживают дополнительные опции.

Для элементов arc:

start

Начало углового диапазона дуги, в градусах, измеряемое против часовой стрелки от положения «3 часа».

extent

Размер углового диапазона, в градусах против часовой стрелки от start.

стиль

Как рисуется дуга: 'pieslice' (по умолчанию), 'chord' или 'arc'.

Для элементов line:

arrow

Где рисовать наконечники стрелок: 'none' (по умолчанию), 'first', 'last' или 'both'.

arrowshape

Последовательность из трёх расстояний, описывающих форму наконечников стрелок.

capstyle

Как рисуются концы линий: 'butt' (по умолчанию), 'projecting' или 'round'.

joinstyle

Как рисуются вершины линий: 'round' (по умолчанию), 'bevel' или 'miter'.

smooth

Метод сглаживания: ложное значение (по умолчанию) без сглаживания, или 'true'/'bezier' или 'raw' для рисования линии в виде кривой.

splinesteps

Количество отрезков, аппроксимирующих каждый сплайн, когда smooth включён.

Для элементов polygon:

joinstyle, smooth, splinesteps

Как и для элементов line, применяется к контуру многоугольника.

Для элементов text:

text

Отображаемая строка; символы новой строки начинают новые строки.

font

Шрифт, используемый для текста.

выравнивание

Способ выравнивания строк: 'left' (по умолчанию), 'right' или 'center'.

anchor

Как текст позиционируется относительно своей точки; по умолчанию 'center'.

width

Максимальная длина строки; если не равна нулю, строки переносятся по пробелам.

angle

На сколько градусов поворачивать текст против часовой стрелки относительно точки позиционирования, от 0.0 до 360.0 (по умолчанию 0.0).

underline

Индекс символа для подчёркивания или -1, если подчёркивание не требуется.

Для элементов bitmap:

bitmap

Отображаемое растровое изображение.

anchor

Как растровое изображение позиционируется относительно своей точки.

background, foreground

Цвета для пикселей 0 и 1 растрового изображения; пустой background делает пиксели 0 прозрачными. Для обоих есть варианты active… и disabled…, а для bitmap – варианты activebitmap и disabledbitmap.

Для элементов image:

image

Изображение Tk для отображения, предварительно созданное с помощью протоколов изображений.

anchor

Как изображение позиционируется относительно своей точки.

Для обоих параметров существуют варианты active… и disabled… (activeimage, disabledimage), используемые в активном и отключённом состояниях.

Для элементов window:

window

Встраиваемый виджет; он должен быть дочерним элементом холста или одного из его предков и не может быть окном верхнего уровня.

anchor

Как окно позиционируется относительно своей точки.

width, height

Размер, назначаемый окну; если ноль (по умолчанию), окну присваивается его запрошенный размер.

Элементы oval и rectangle не имеют опций, специфичных для типа; они используют только стандартные опции элементов.

Примечание

Tk 8.6 добавил опцию angle, а Tk 9.0 добавил опцию underline для элементов text.

coords(tagOrId)¶

coords(tagOrId, coordList, /)

coords(tagOrId, /, *coordList)

Запрос или изменение координат элемента. С одним только tagOrId возвращает список координат с плавающей запятой элемента, заданного tagOrId (первый подходящий, если соответствует нескольким). При указании новых координат заменяет координаты этого элемента на указанные; как и методы create_*, координаты могут быть заданы отдельными числами, одной последовательностью или парами координат. Возвращаемые координаты всегда в пикселях, независимо от единиц, использованных при задании; для прямоугольников, овалов и дуг они упорядочены как лево, верх, право, низ.

Изменено в версии 3.12: Аргументы теперь уплощаются: координаты могут быть заданы отдельными аргументами, одной последовательностью или сгруппированы парами, как в методах create_*.

move(tagOrId, xAmount, yAmount, /)¶

Перемещает каждый из элементов, заданных tagOrId, в координатном пространстве холста, добавляя xAmount к каждой координате x и yAmount к каждой координате y элемента.

moveto(tagOrId, x='', y='')¶

Перемещает элементы, заданные tagOrId, так, чтобы первая пара координат (левый верхний угол ограничивающей рамки) наименьшего подходящего элемента находилась в позиции (x, y). x или y могут быть пустой строкой, в этом случае соответствующая координата не изменяется. Все подходящие элементы сохраняют свои позиции относительно друг друга.

Добавлено в версии 3.8.

scale(tagOrId, xOrigin, yOrigin, xScale, yScale, /)¶

Масштабирует координаты всех элементов, заданных tagOrId, в координатном пространстве холста. Каждая координата x корректируется так, чтобы её расстояние от xOrigin изменилось в xScale раз, а каждая координата y – чтобы её расстояние от yOrigin изменилось в yScale раз (коэффициент 1.0 оставляет координату без изменений).

delete(*tagOrIds)¶

Удаляет каждый из элементов, заданных аргументами tagOrIds.

dchars(tagOrId, first, /)¶

dchars(tagOrId, first, last, /)

Удаляет из каждого элемента, заданного tagOrId, символы (для текстовых элементов) или координаты (для элементов-линий и многоугольников) в диапазоне от first до last включительно; last по умолчанию равен first. Элементы, не поддерживающие индексацию, игнорируют эту операцию.

insert(tagOrId, beforeThis, string, /)¶

Вставляет string в каждый из элементов, заданных tagOrId, непосредственно перед символом или координатой, индекс которой равен beforeThis. Для элементов-линий и многоугольников string должна быть допустимой последовательностью координат.

itemcget(tagOrId, option)¶

Возвращает текущее значение опции конфигурации option для элемента, заданного tagOrId (наименьший подходящий элемент, если соответствует нескольким). Это похоже на cget(), но применяется к отдельному элементу.

itemconfigure(tagOrId, cnf=None, **kw)¶

Запрос или изменение опций конфигурации элементов, заданных tagOrId. Это отражает configure(), но применяется к отдельным элементам, а не ко всему холсту. Без опций возвращает словарь, описывающий текущие опции первого подходящего элемента; в противном случае устанавливает указанные опции для каждого подходящего элемента. Допустимые опции – это те, которые принимает соответствующий метод create_*. itemconfig() является псевдонимом itemconfigure().

type(tagOrId)¶

Возвращает тип элемента, заданного tagOrId (первый подходящий, если соответствует нескольким), например 'rectangle' или 'text', или None, если tagOrId не соответствует ни одному элементу.

gettags(tagOrId, /)¶

Возвращает кортеж тегов, связанных с элементом, заданным параметром tagOrId (первый подходящий элемент в порядке отображения, если подходит несколько). Возвращает пустой кортеж, если ни один элемент не подходит или у элемента нет тегов.

dtag(tagOrId, /)¶

dtag(tagOrId, tagToDelete, /)

Удаляет тег tagToDelete (по умолчанию равный tagOrId) из каждого элемента, заданного параметром tagOrId. Элементы, у которых нет этого тега, остаются без изменений.

addtag(newtag, searchSpec, /, *args)¶

Добавляет тег newtag каждому элементу, выбранному по спецификации поиска searchSpec (и любым дополнительным параметрам args). searchSpec – одно из значений: 'above', 'all', 'below', 'closest', 'enclosed', 'overlapping' или 'withtag'; приведённые ниже методы addtag_* – это удобные обёртки, предоставляющие каждую из этих форм.

addtag_above(newtag, tagOrId)¶

Добавляет тег newtag элементу, расположенному непосредственно над (после) tagOrId в списке отображения.

addtag_all(newtag)¶

Добавляет тег newtag всем элементам на холсте.

addtag_below(newtag, tagOrId)¶

Добавляет тег newtag элементу, расположенному непосредственно под (перед) tagOrId в списке отображения.

addtag_closest(newtag, x, y, halo=None, start=None)¶

Добавляет тег newtag элементу, ближайшему к точке (x, y). Если задан halo, любой элемент в пределах этого расстояния от точки считается перекрывающим её. Если задан start (тег или id), выбирается самый верхний ближайший элемент, который находится ниже start в списке отображения. Это можно использовать для последовательного перебора всех ближайших элементов.

addtag_enclosed(newtag, x1, y1, x2, y2)¶

Добавляет тег newtag каждому элементу, полностью находящемуся внутри прямоугольника (x1, y1, x2, y2), где x1 <= x2 и y1 <= y2.

addtag_overlapping(newtag, x1, y1, x2, y2)¶

Добавляет тег newtag каждому элементу, который перекрывает прямоугольник (x1, y1, x2, y2) или находится внутри него, где x1 <= x2 и y1 <= y2.

addtag_withtag(newtag, tagOrId)¶

Добавляет тег newtag каждому элементу, заданному параметром tagOrId.

find(searchSpec, /, *args)¶

Возвращает кортеж идентификаторов всех элементов, выбранных по спецификации поиска searchSpec (и любым дополнительным параметрам args), в порядке наложения, начиная с самого нижнего элемента. Спецификация поиска может быть любой из форм, принимаемых методом addtag(). Приведённые ниже методы find_* являются более удобными обёртками для него.

find_above(tagOrId)¶

Возвращает кортеж, содержащий идентификатор элемента, расположенного непосредственно над tagOrId в списке отображения.

find_all()¶

Возвращает кортеж идентификаторов всех элементов на холсте в порядке наложения.

find_below(tagOrId)¶

Возвращает кортеж, содержащий идентификатор элемента, расположенного непосредственно под tagOrId в списке отображения.

find_closest(x, y, halo=None, start=None)¶

Возвращает кортеж, содержащий идентификатор элемента, ближайшего к точке (x, y). Параметры halo и start интерпретируются так же, как в addtag_closest().

find_enclosed(x1, y1, x2, y2)¶

Возвращает кортеж идентификаторов всех элементов, полностью находящихся внутри прямоугольника (x1, y1, x2, y2).

find_overlapping(x1, y1, x2, y2)¶

Возвращает кортеж идентификаторов всех элементов, которые перекрываются или находятся внутри прямоугольника (x1, y1, x2, y2).

find_withtag(tagOrId)¶

Возвращает кортеж идентификаторов всех элементов, заданных tagOrId.

tag_raise(tagOrId, aboveThis=None, /)¶

Перемещает все элементы, заданные tagOrId, на новую позицию в списке отображения сразу над элементом, заданным aboveThis, или в верхнюю часть списка отображения, если aboveThis опущен. При перемещении нескольких элементов их относительный порядок сохраняется. Это не влияет на встроенные оконные элементы, порядок наложения которых вместо этого управляется Misc.tkraise() и Misc.lower(). lift() и tkraise() – псевдонимы tag_raise().

tag_lower(tagOrId, belowThis=None, /)¶

Перемещает все элементы, заданные tagOrId, на новую позицию в списке отображения сразу под элементом, заданным belowThis, или в нижнюю часть списка отображения, если belowThis опущен. При перемещении нескольких элементов их относительный порядок сохраняется. Это не влияет на встроенные оконные элементы. lower() – псевдоним tag_lower().

Примечание

В классе Canvas методы tkraise()/lift() и lower() изменяют порядок наложения элементов canvas, переопределяя унаследованные методы Misc.tkraise()/Misc.lift() и Misc.lower(), которые изменяют порядок самого виджета; поэтому эти унаследованные методы недоступны.

tag_bind(tagOrId, sequence=None, func=None, add=None)¶

Привязывает колбэк func к событию sequence для всех элементов, заданных tagOrId, так что func вызывается всякий раз, когда это событие происходит для одного из этих элементов. Это похоже на Widget.bind, но работает с элементами canvas, а не с целыми виджетами; можно привязывать только события мыши, клавиатуры и виртуальные. События мыши направляются текущему элементу, а события клавиатуры – элементу с фокусом (см. focus()). Если add истинно, новая привязка добавляется к уже существующим привязкам для того же события, а не заменяет их. Возвращает идентификатор привязанной функции, который можно передать tag_unbind().

tag_unbind(tagOrId, sequence, funcid=None)¶

Удаляет для всех элементов, заданных tagOrId, привязку к событию sequence. Если задан funcid, отвязывается и удаляется только этот колбэк (возвращённый tag_bind()).

Изменено в версии 3.13: Если указан funcid, отвязывается только этот колбэк.

bbox(tagOrId, /, *tagOrIds)¶

Возвращает 4-кортеж (x1, y1, x2, y2), задающий приблизительный ограничивающий прямоугольник в пикселях, который охватывает все элементы, заданные tagOrId и любыми дополнительными tagOrIds. Результат может превышать истинный ограничивающий прямоугольник на несколько пикселей. Возвращает None, если ни один элемент не соответствует или соответствующие элементы нечего отображать.

Этот метод переопределяет унаследованный Misc.bbox(); используйте grid_bbox() для получения ограничивающего прямоугольника в сетке.

canvasx(screenx, gridspacing=None)¶

По заданной x-координате окна screenx возвращает x-координату canvas, отображаемую в этой позиции. Если задан gridspacing, результат округляется до ближайшего кратного gridspacing единицам.

canvasy(screeny, gridspacing=None)¶

По заданной y-координате окна screeny возвращает y-координату canvas, отображаемую в этой позиции. Если задан gridspacing, результат округляется до ближайшего кратного gridspacing единицам.

focus()¶

focus(tagOrId, /)

С параметром tagOrId устанавливает фокус клавиатуры canvas на первый элемент, заданный tagOrId, который поддерживает курсор вставки; если такого элемента нет, фокус остаётся без изменений. Если tagOrId – пустая строка, сбрасывает фокус так, что ни один элемент не имеет фокуса. Без аргументов возвращает идентификатор элемента, который в данный момент имеет фокус, или пустую строку, если такого нет. Элемент отображает курсор вставки только когда он сам является элементом с фокусом и его canvas имеет фокус ввода.

Этот метод затеняет унаследованный Misc.focus(); используйте focus_set() для фокусировки самого виджета.

icursor(tagOrId, index, /)¶

Устанавливает курсор вставки элементов, заданных tagOrId, непосредственно перед символом, заданным index. Элементы, не поддерживающие курсор вставки, не затрагиваются. Курсор отображается только когда элемент имеет фокус, но его положение можно установить в любое время.

index(tagOrId, index, /)¶

Возвращает в виде целого числа числовой индекс внутри tagOrId, соответствующий index, который представляет собой текстовое описание позиции (для текстовых элементов – индекс символа, для отрезков и многоугольников – индекс в координатах). Если tagOrId соответствует нескольким элементам, используется первый из них, поддерживающий индексацию.

select_adjust(tagOrId, index)¶

Настраивает конец выделения в tagOrId, ближайший к index, так чтобы он находился на index, и делает другой конец якорной точкой для будущих вызовов select_to(). Если выделение в данный момент не находится в tagOrId, это действует как select_to().

select_clear()¶

Очищает выделение, если оно есть на этом холсте; в противном случае ничего не делает.

select_from(tagOrId, index)¶

Устанавливает точку привязки выделения непосредственно перед символом, заданным index в элементе, заданном tagOrId. Это не изменяет само выделение; оно устанавливает фиксированный конец для будущих вызовов select_to().

select_item()¶

Возвращает идентификатор элемента, содержащего выделение, или None, если выделение отсутствует на этом холсте. В отличие от методов find() и find_*, этот метод возвращает идентификатор в виде строки, а не целого числа.

select_to(tagOrId, index)¶

Устанавливает выделение на символы элемента tagOrId между точкой привязки выделения и index, включительно по index. Точкой привязки является та, что установлена последним вызовом select_adjust() или select_from().

scan_mark(x, y)¶

Запоминает x, y и текущий вид для использования в последующих вызовах scan_dragto(). Обычно привязывается к нажатию кнопки мыши в виджете.

scan_dragto(x, y, gain=10)¶

Прокручивает холст на величину, равную gain, умноженному на разницу между x, y и координатами, переданными последнему вызову scan_mark(). Обычно это привязывается к событиям движения мыши на виджете, создавая эффект перетаскивания холста с высокой скоростью в его окне.

postscript(cnf={}, **kw)¶

Генерирует представление части или всего холста в формате PostScript (Encapsulated PostScript, версия 3.0). Если задан параметр file или channel, PostScript записывается туда и возвращается пустая строка; в противном случае он возвращается в виде строки. По умолчанию генерируется только область, видимая в данный момент в окне, поэтому обычно необходимо либо сначала вызвать update(), либо использовать параметры width и height. Поддерживаемые параметры включают colormap, colormode, file, fontmap, height, pageanchor, pageheight, pagewidth, pagex, pagey, rotate, width, x и y.