tkinter.ttk — Tk widgets temáticos

Código fuente: Lib/tkinter/ttk.py

---

El módulo tkinter.ttk proporciona acceso al conjunto de widgets temáticos Tk, introducido en Tk 8.5. Si Python no se ha compilado con Tk 8.5, todavía se puede acceder a este módulo si se ha instalado Tile. El método anterior que utiliza Tk 8.5 proporciona ventajas adicionales, incluida la representación de fuentes suavizada en X11 y la transparencia de ventanas (requiere un administrador de ventanas de composición en X11).

La idea básica de tkinter.ttk es separar, en la medida de lo posible, el comportamiento de un widget del código que implementa su apariencia.

Ver también

Soporte para estilos de Widgets Tk

Un documento que presenta apoyo temático para Tk

Uso de Ttk

Para empezar a utilizar Ttk, hay que importar su módulo:

from tkinter import ttk

Para anular los widgets Tk básicos, la importación debe seguir la importación de Tk:

from tkinter import *
from tkinter.ttk import *

Ese código hace que varios widgets tkinter.ttk (Button, Checkbutton, Entry, Frame, Label, LabelFrame, Menubutton, PanedWindow, Radiobutton, Scale y Scrollbar) reemplacen automáticamente los widgets Tk.

Esto tiene el beneficio de usar los nuevos widgets que dan una mejor apariencia en todas las plataformas; sin embargo, el reemplazo de widgets no es completamente compatible. La principal diferencia es que las opciones de widgets como «fg», «bg» y otras relacionadas con el estilo del widget ya no están presentes en los widgets de Ttk. En su lugar, utiliza la clase ttk.Style para mejorar los efectos de estilo.

Ver también

Converting existing applications to use Tile widgets

Una monografía (utilizando la terminología Tcl) sobre las diferencias que normalmente se encuentran al modificar aplicaciones para usar los nuevos widgets.

Ttk widgets

Ttk viene con 18 widgets, doce de los cuales ya existían en tkinter: Button, Checkbutton, Entry, Frame, Label, LabelFrame, Menubutton, PanedWindow, Radiobutton, Scale, Scrollbar y Spinbox. Los otros seis son nuevos: Combobox, Notebook, Progressbar, Separator, Sizegrip y Treeview. Y todas ellas son subclases de Widget.

El uso de los widgets Ttk le da a la aplicación un aspecto mejorado. Como se ha mencionado anteriormente, hay diferencias en cómo se codifica el estilo.

Código Tk:

l1 = tkinter.Label(text="Test", fg="black", bg="white")
l2 = tkinter.Label(text="Test", fg="black", bg="white")

Código Ttk:

style = ttk.Style()
style.configure("BW.TLabel", foreground="black", background="white")

l1 = ttk.Label(text="Test", style="BW.TLabel")
l2 = ttk.Label(text="Test", style="BW.TLabel")

Para obtener más información acerca de TtkStyling, consulta la documentación de la clase Style.

Widget

ttk.Widget define las opciones y métodos estándar compatibles con los widgets temáticos de Tk y no se crea una instancia directamente.

Opciones estándar

Todos los widgets ttk aceptan las siguientes opciones:

Opción	Descripción
class	Especifica la clase de ventana. La clase se usa cuando se consulta la base de datos de opciones para las otras opciones de la ventana, para determinar las etiquetas de enlace (bindtags) predeterminadas para la ventana y para seleccionar el diseño y estilo predeterminados del widget. Esta opción es de solo lectura y solo se puede especificar cuando se crea la ventana.
cursor	Especifica el cursor del mouse que se utilizará para el widget. Si se establece en la cadena vacía (el valor predeterminado), el cursor se hereda para el widget principal.
takefocus	Determina si la ventana acepta el foco durante el recorrido del teclado. Se retorna 0, 1 o una cadena vacía. Si se retorna 0, significa que la ventana debe omitirse por completo durante el recorrido del teclado. Si es 1, significa que la ventana debe recibir el foco de entrada siempre que sea visible. Y una cadena vacía significa que los scripts transversales toman la decisión sobre si enfocarse o no en la ventana.
style	Se puede usar para especificar un estilo personalizado para el widget.

Opciones de widgets desplegables

Los widgets controlados por una barra deslizante presentan las siguientes opciones.

Opción	Descripción
xscrollcommand	Se usa para interactuar con las barras deslizantes horizontales. Cuando la vista en la ventana del widget cambia, el widget generará un comando Tcl basado en el scrollcommand. Por lo general, esta opción consiste en el método Scrollbar.set() de barras deslizantes. Esto hará que la barra deslizante se actualice cada vez que cambie la vista de la ventana.
yscrollcommand	Se utiliza para comunicarse con las barras deslizantes verticales. Para obtener más información, consulta más arriba.

Opciones de etiqueta

Las siguientes opciones son compatibles con etiquetas, botones y otros widgets similares a botones.

Opción	Descripción
text	Especifica una cadena de texto que se mostrará dentro del widget.
textvariable	Especifica un nombre cuyo valor se utilizará en lugar del recurso de opción de texto.
underline	Si se activa, especifica el índice (empezando por 0) de un carácter que se va a subrayar en la cadena de texto. El carácter subrayado se utiliza para la activación mnemotécnica.
image	Especifica una imagen que se va a mostrar. Es una lista de 1 o más elementos. El primer elemento es el nombre de imagen predeterminado. El resto de la lista es una secuencia de pares statespec/value según lo definido por Style.map(), especificando diferentes imágenes para usar cuando el widget está en un estado determinado o una combinación de estados. Todas las imágenes de la lista deben tener el mismo tamaño.
compound	Especifica cómo mostrar la imagen en relación con el texto, en el caso de que estén presentes las opciones de texto e imágenes. Los valores válidos son: text: mostrar solo texto image: mostrar solo la imagen top, bottom, left, right: muestra la imagen por encima, por debajo, a la izquierda o a la derecha del texto, respectivamente. none: valor predeterminado. Mostrar la imagen si está presente, de lo contrario el texto.
width	Si es mayor que cero, especifica cuánto espacio, en ancho de caracteres, se debe asignar para la etiqueta de texto; si es menor que cero, especifica un ancho mínimo. Si es cero o no se especifica, se utiliza el ancho natural de la etiqueta de texto.

Opciones de compatibilidad

Opción	Descripción
state	Se puede establecer en «normal» o «deshabilitado» para controlar el bit de estado «deshabilitado». Esta es una opción de solo escritura: establecerlo cambia el estado del widget, pero el método Widget.state() no afecta a esta opción.

Estados del widget

El estado del widget es un mapa de bits de indicadores de estado independientes.

Indicador de estado	Descripción
active	El puntero está sobre el widget y clickeando sobre él producirá alguna acción
disabled	El widget está desactivado bajo el control del programa
focus	El widget tiene el enfoque del teclado
pressed	El widget está siendo pulsado
selected	«On», «true» o «current» para aspectos como Checkbuttons y radiobuttons
background	Windows y Mac tienen el concepto de ventana «activa» o en primer plano. El estado background se establece para los widgets en una ventana de fondo y se borra para los que están en la ventana en primer plano
readonly	El widget no debe permitir la modificación del usuario
alternate	Un formato de visualización alternativo específico del widget
invalid	El valor del widget no es válido

Una especificación de estado es una secuencia de nombres de estado, opcionalmente prefijados con un signo de exclamación que indica que el bit está desactivado.

ttk.Widget

Además de los métodos descritos a continuación, el ttk.Widget soporta los métodos tkinter.Widget.cget() y tkinter.Widget.configure().

class tkinter.ttk.Widget

identify(x, y)

Retorna el nombre del elemento en la posición x y o la cadena vacía si el punto no se encuentra dentro de ningún elemento.

x e y son coordenadas en píxeles relativas al widget.

instate(statespec, callback=None, *args, **kw)

Prueba el estado del widget. Si no se especifica una retrollamada, retorna True si el estado del widget coincide con statespec y False en caso contrario. Si se especifica la retrollamada, se llama con argumentos (args) si el estado del widget coincide con statespec.

state(statespec=None)

Modify or inquire widget state. If statespec is specified, sets the widget state according to it and return a new statespec indicating which flags were changed. If statespec is not specified, returns the currently enabled state flags.

statespec es generalmente una lista o una tupla.

Combobox

El widget ttk.Combobox combina un campo de texto con una lista desplegable de valores. Este widget es una subclase de Entry.

Además de los métodos heredados de Widget: Widget.cget(), Widget.configure(), Widget.identify(), Widget.instate() y Widget.state(), y los siguientes heredados de Entry: Entry.bbox(), Entry.delete(), Entry.icursor(), Entry.index(), Entry.insert(), Entry.selection(), Entry.xview(), tiene algunos otros métodos, descritos en ttk.Combobox.

Opciones

Este widget acepta las siguientes opciones específicas:

Opción	Descripción
exportselection	Valor booleano. Si se establece, la selección del widget está vinculada a la selección del Administrador de ventanas (que se puede retornar invocando Misc.selection_get, por ejemplo).
justify	Especifica cómo el texto se alinea en el widget. Uno de «left», «center» o «right».
height	Especifica el largo/altura del cuadro de la lista desplegable, en filas.
postcommand	Un script (posiblemente registrado con Misc.register) que se llama inmediatamente antes de mostrar los valores. Puede especificar qué valores mostrar.
state	Uno de «normal», «readonly» o «disabled». En el estado «readonly» el valor no se puede editar directamente y el usuario solo puede seleccionar los valores de la lista desplegable. En el estado «normal» el campo de texto se puede editar directamente. En el estado «deshabilitado» no es posible ninguna interacción.
textvariable	Especifica un nombre cuyo valor está vinculado al valor del widget. Cada vez que cambia el valor asociado a ese nombre, se actualiza el valor del widget y viceversa. Véase tkinter.StringVar.
values	Especifica la lista de valores que se mostrarán en el cuadro de lista desplegable.
width	Especifica un valor entero que indica el ancho deseado de la ventana de entrada, en caracteres de tamaño medio de la fuente del widget.

Eventos virtuales

Los widgets de cuadro combinado generan un evento virtual <<ComboboxSelected>> cuando el usuario selecciona un elemento de la lista de valores.

ttk.Combobox

class tkinter.ttk.Combobox

current(newindex=None)

Si se especifica newindex, establece el valor del cuadro combinado en la posición del elemento newindex. De lo contrario, retorna el índice del valor actual o -1 si el valor actual no está en la lista de valores.

get()

Retorna el valor actual del cuadro combinado.

set(value)

Establece el valor del cuadro combinado a value.

Spinbox

El widget ttk.Spinbox es un ttk.Entry mejorado con flechas de incremento y decremento. Se puede utilizar para números o listas de valores de cadena. Este widget es una subclase de Entry.

Además de los métodos heredados de Widget: Widget.cget(), Widget.configure(), Widget.identify(), Widget.instate() y Widget.state(), y los siguientes heredados de Entry: Entry.bbox(), Entry.delete(), Entry.icursor(), Entry.index(), Entry.insert(), Entry.xview(), tiene algunos otros métodos, descritos en ttk.Spinbox.

Opciones

Este widget acepta las siguientes opciones específicas:

Opción	Descripción
from	Valor flotante. Si se establece, este es el valor mínimo al que se reducirá el botón de disminución. Debe escribirse como from_ cuando se usa como argumento, ya que from es una palabra clave de Python.
to	Valor flotante. Si se establece, este es el valor máximo al que se incrementará el botón de incremento.
increment	Valor flotante. Especifica la cantidad por la cual los botones de incremento/disminución cambian el valor. Por defecto la cantidad es de 1.0.
values	Secuencia de valores de cadena o flotantes. Si se especifica, los botones de incremento/disminución recorrerán los elementos de esta secuencia en lugar de incrementar o disminuir los números.
wrap	Valor booleano. Si es True, los botones de incremento y disminución pasarán del valor to al valor from o del valor from al valor to, respectivamente.
format	Valor de cadena. Especifica el formato de los números establecidos por los botones de incremento/disminución. Debe tener la forma «%W.Pf», donde W es el ancho de relleno del valor, P es la precisión, y “%” y “f” son literales.
command	Python invocable. Se llamará sin argumentos cada vez que se presione alguno de los botones de incremento o disminución.

Eventos virtuales

El widget spinbox genera un evento virtual <<Increment>> cuando el usuario presiona <Up>, y un evento virtual <<Decrement>> cuando el usuario presiona <Down>.

ttk.Spinbox

class tkinter.ttk.Spinbox

get()

Retorna el valor actual del spinbox.

set(value)

Establece el valor del spinbox a value.

Notebook

Ttk Notebook widget manages a collection of windows and displays a single one at a time. Each child window is associated with a tab, which the user may select to change the currently displayed window.

Opciones

Este widget acepta las siguientes opciones específicas:

Opción	Descripción
height	Si está presente y es mayor que cero, especifica la altura deseada del área del panel (sin incluir el relleno interno o las pestañas). De lo contrario, se utiliza la altura máxima de todos los paneles.
padding	Especifica la cantidad de espacio adicional que se va a agregar alrededor del exterior del bloc de notas. El relleno es una lista de hasta cuatro especificaciones de longitud izquierda superior derecha inferior. Si se especifican menos de cuatro elementos, el valor predeterminado inferior es el superior, el valor predeterminado de la derecha es el de la izquierda y el valor predeterminado superior es el de la izquierda.
width	Si está presente y es mayor que cero, especifica el ancho deseado del área del panel (sin incluir el relleno interno). De lo contrario, se utiliza el ancho máximo de todos los paneles.

Opciones de pestañas

Las opciones específicas para pestañas son:

Opción	Descripción
state	O bien «normal», «disabled» o «hidden». Si es «disabled», la pestaña no se puede seleccionar. Si es «hidden», la pestaña no se muestra.
sticky	Especifica cómo se coloca la ventana secundaria dentro del área del panel. Value es una cadena que contiene cero o más de los caracteres «n», «s», «e» o «w». Cada letra se refiere a un lado (norte, sur, este u oeste) al que se pegará la ventana secundaria, según el administrador de geometría grid().
padding	Especifica la cantidad de espacio adicional que se va a agregar entre el notebook y este panel. La sintaxis es la misma que para el relleno de opciones utilizado por Notebook.
text	Especifica un texto que se muestra en la pestaña.
image	Especifica una imagen que se muestra en la pestaña. Consulta la opción de imagen descrita en Widget.
compound	Especifica cómo mostrar la imagen en relación con el texto, en el caso de que tanto el texto como la imagen estén presentes. Consulta Label Options para obtener valores válidos.
underline	Especifica el índice (basado en 0) de un carácter que se va a subrayar en la cadena de texto. El carácter subrayado se utiliza para la activación mnemotécnica si se llama a Notebook.enable_traversal().

Identificadores de pestañas

El tab_id presente en varios métodos de ttk.Notebook puede tener cualquiera de las siguientes formas:

• Un entero entre cero y el número de pestañas

• El nombre de una ventana secundaria

• Un especificación de posición de la forma «@x,y» que identifique la pestaña

• The literal string «current», which identifies the currently selected tab

• El valor «end» que retorna el número de pestañas (válido solo para Notebook.index())

Eventos virtuales

Este widget genera un evento virtual <<NotebookTabChanged>> después de seleccionar una nueva pestaña.

ttk.Notebook

class tkinter.ttk.Notebook

add(child, **kw)

Añade una nueva pestaña al notebook.

Si la ventana está actualmente administrada por el notebook pero oculta, se restaura a su posición anterior.

Consulta Tab Options para la lista de opciones disponibles.

forget(tab_id)

Quita la pestaña especificada por tab_id, desasigna y quita la ventana asociada.

hide(tab_id)

Oculta la pestaña especificada por tab_id.

La pestaña no se mostrará, pero la ventana asociada permanece administrada por el notebook y se recordará su configuración. Las pestañas ocultas se pueden restaurar con el comando add().

identify(x, y)

Retorna el nombre del elemento de la pestaña en la posición x, y o cadena vacía si no hay ninguno.

index(tab_id)

Retorna el índice numérico de la pestaña especificada por tab_id, o el número total de pestañas si tab_id es la cadena «end».

insert(pos, child, **kw)

Añade un panel en la posición especificada.

pos es la cadena «end», un índice entero o el nombre de un elemento secundario administrado. Si el bloc de notas ya administra child, lo mueve a la posición especificada.

Consulta Tab Options para la lista de opciones disponibles.

select(tab_id=None)

Selecciona el tab_id especificado.

The associated child window will be displayed, and the previously selected window (if different) is unmapped. If tab_id is omitted, returns the widget name of the currently selected pane.

tab(tab_id, option=None, **kw)

Consultar o modificar las opciones del tab_id específico.

Si no se proporciona kw, retorna un diccionario de los valores de las opciones de pestañas. Si se especifica option, retorna el valor de esa option. De lo contrario, establece las opciones en los valores correspondientes.

tabs()

Retorna una lista de ventanas administradas por el notebook.

enable_traversal()

Habilita la tabulación para una ventana de nivel superior que contenga este notebook.

Esto extenderá los enlaces para la ventana de nivel superior que contiene el notebook del siguiente modo:

• Control-Tab: selecciona la pestaña siguiente a la seleccionada actualmente.

• Shift-Control-Tab: selecciona la pestaña precedente a la seleccionada actualmente.

• Alt-K: donde K es el carácter mnemotécnico (subrayado) de cualquier pestaña, seleccionará esa pestaña.

Se pueden habilitar varios notebooks en un único nivel superior para la tabulación, incluidos los notebooks anidados. Sin embargo, la tabulación entre notebooks solo funciona correctamente si todos los paneles tienen el notebook en el que se encuentran como maestro.

Progressbar

El widget ttk.Progressbar muestra el estado de una operación de larga duración. Puede funcionar en dos modos: 1) el modo determinado que muestra la cantidad completada en función de la cantidad total de trabajo a realizar y 2) el modo indeterminado que proporciona una pantalla animada para que el usuario sepa que la operación está en curso.

Opciones

Este widget acepta las siguientes opciones específicas:

Opción	Descripción
orient	Puede ser «horizontal» o «vertical». Especifica la orientación de la barra de progreso.
length	Especifica la longitud del eje largo de la barra de progreso (ancho si horizontal, alto si es vertical).
mode	Puede ser «determinate» o «indeterminate».
maximum	Número que especifica el valor máximo. Por defecto el valor es 100.
value	El valor actual de la barra de progreso. En el modo «determinado», representa la cantidad de trabajo completado. En el modo «indeterminado», se interpreta como módulo maximum, es decir, la barra de progreso completa un «ciclo» cuando su valor aumenta en maximum.
variable	Nombre vinculado al valor de la opción. Si se especifica, el valor de la barra de progreso se establece automáticamente en el valor de este nombre cada vez que se modifica dicho valor.
phase	Variable de solo lectura. El widget incrementa periódicamente el valor de esta opción siempre que su valor sea mayor que 0 y, en modo determinado, menor que el máximo. Esta opción puede ser utilizada por el tema actual para proporcionar efectos de animación adicionales.

ttk.Progressbar

class tkinter.ttk.Progressbar

start(interval=None)

Inicia el modo de incremento automático: programa un evento timer periódico que llama a Progressbar.step() cada interval milisegundos. Si se omite, interval tiene como valor predeterminado 50 milisegundos.

step(amount=None)

Incrementa el valor de la barra de progreso en amount.

amount vale 1.0 por defecto si se omite.

stop()

Para el modo de incremento automático: cancela cualquier evento timer periódico iniciado por Progressbar.start() para la barra de progreso en cuestión.

Separator

El widget ttk.Separator muestra una barra de separación horizontal o vertical.

No tiene otros métodos aparte de aquellos heredados de ttk.Widget.

Opciones

Este widget acepta las opción específica siguiente:

Opción	Descripción
orient	Puede ser «horizontal» o «vertical». Especifica la orientación del separador.

Sizegrip

El widget ttk.Sizegrip (también conocido como grow box) permite al usuario cambiar el tamaño de la ventana de nivel superior que lo contiene presionando y arrastrando la esquina.

Este widget no tiene ni opciones ni métodos específicos, aparte de aquellos heredados de ttk.Widget.

Notas específicas por plataforma

• En macOS, las ventanas de nivel superior incluyen automáticamente un control de tamaño integrado de forma predeterminada. Agregar un Sizegrip es inofensivo, ya que el agarre integrado solo enmascara el widget.

Errores detectados

• Si la posición del nivel superior que lo contiene se especifica en relación con la parte derecha o inferior de la pantalla (por ejemplo,…), el widget Sizegrip no cambiará el tamaño de la ventana.

• El widget solo soporta el cambio de tamaño desde la esquina inferior derecha.

Treeview

El widget ttk.Treeview muestra una colección en árbol de elementos. Cada elemento tiene una etiqueta textual, una imagen opcional y una lista opcional de valores de datos. Los valores de datos se muestran en columnas sucesivas después de la etiqueta de árbol.

El orden en que se muestran los valores de datos se puede controlar estableciendo la opción de widget displaycolumns. El Treeview también puede mostrar encabezados. Se puede acceder a las columnas por número o nombres simbólicos enumerados en las columnas de opciones del widget. Consulte Column Identifiers.

Cada elemento se identifica con un nombre único. El widget genera IDs para los elementos si no se proporcionan en la declaración. Hay un elemento raíz distinguido, denominado {}. El elemento raíz en sí no se muestra; sus hijos aparecen en el nivel superior de la jerarquía.

Cada elemento también tiene una lista de etiquetas que se pueden usar para asociar enlaces de eventos con elementos individuales y controlar la apariencia del elemento.

El widget Treeview admite el deslizamiento horizontal y vertical, según las opciones descritas en Scrollable Widget Options y los métodos Treeview.xview() y Treeview.yview().

Opciones

Este widget acepta las siguientes opciones específicas:

Opción	Descripción
columns	Una lista de identificadores de columna, que especifican el número de columnas y sus nombres.
displaycolumns	Una lista de identificadores de columna (índices simbólicos o enteros) que especifican qué columnas de datos se muestran y el orden en que aparecen, o la cadena «#all».
height	Especifica el número de filas que deben estar visibles. Nota: el ancho solicitado se determina a partir de la suma de los anchos de columna.
padding	Especifica el relleno interno del widget. El relleno es una lista de hasta cuatro especificaciones de longitud.
selectmode	Controla cómo los enlaces de clase integrados administran la selección. Puede ser «extended», «browse» o «none». Si se establece en «extended» (valor predeterminado), se pueden seleccionar varios elementos. Si se elige «browse», se seleccionará un solo elemento a la vez. Si se elige «none», la selección no se cambiará. Tenga en cuenta que el código de la aplicación y los enlaces de etiqueta pueden establecer la selección como deseen, independientemente del valor de esta opción.
show	Una lista que contiene cero o más de los siguientes valores, especificando qué elementos del árbol se van a mostrar. tree: muestra las etiquetas del árbol en la columna #0. headings: muestra la fila de encabezado. El valor predeterminado es «tree headings», es decir, mostrar todos los elementos. Nota: la columna #0 siempre hace referencia a la columna del árbol, incluso si no se especifica show=»tree».

Opciones de elementos

Las siguientes opciones de elemento se pueden especificar para los elementos de los comandos de inserción y de elementos del widget.

Opción	Descripción
text	La etiqueta textual que se va a mostrar para el elemento.
image	Una imagen Tk, que se muestra a la izquierda de la etiqueta.
values	La lista de valores asociados al elemento. Cada elemento debe tener el mismo número de valores que las columnas de opciones del widget. Si hay menos valores que columnas, los valores restantes se asumen vacíos. Si hay más valores que columnas, se omiten los valores adicionales.
open	Valor True/False que indica si los elementos secundarios deben mostrarse u ocultarse.
tags	La lista de etiquetas asociadas al elemento.

Opciones de etiqueta

Se pueden especificar las opciones siguientes para etiquetas:

Opción	Descripción
foreground	Especifica el color de primer plano del texto.
background	Especifica el color de fondo de la celda o elemento.
font	Especifica la fuente que se utilizará al añadir texto.
image	Especifica la imagen del elemento, en caso de que la opción de imagen del elemento esté vacía.

Identificadores de columna

Los identificadores de columna toman cualquiera de los siguientes formas:

• Un nombre simbólico de la lista de opciones de columna.

• Un entero n, especificando la enésima columna de datos.

• Una cadena de la forma #n, donde n es un entero, especificando la enésima columna mostrada.

Notas:

• Los valores de opciones del elemento se pueden mostrar en un orden diferente al orden en el que se almacenan.

• La columna #0 siempre hace referencia a la columna del árbol, incluso si no se especifica show=»tree».

Un número de columna de datos es un índice en la lista de valores de opciones de un elemento; el número de columna se visualiza en el árbol donde se muestran los valores. Las etiquetas de árbol se muestran en la columna #0. Si no se establece la opción displaycolumns, la columna de datos n se muestra en la columna #n+1. Una vez más, la columna #0 siempre hace referencia a la columna del árbol.

Eventos virtuales

El widget Treeview genera los siguientes eventos virtuales.

Evento	Descripción
<<TreeviewSelect>>	Se genera cada vez que cambia la selección.
<<TreeviewOpen>>	Generado justo antes configurar el elemento de resalto a open=True.
<<TreeviewClose>>	Generado justo después de establecer el elemento de resalto a open=False.

Los métodos Treeview.focus() y Treeview.selection() se pueden utilizar para determinar el elemento o elementos afectados.

ttk.Treeview

class tkinter.ttk.Treeview

bbox(item, column=None)

Retorna el cuadro delimitador (en relación con la ventana del widget de Treeview) del item especificado con el formato (x, y, ancho, alto).

Si se especifica column, retorna el cuadro delimitador de esa celda. Si el item no está visible (es decir, si es descendiente de un elemento cerrado o se desplaza fuera de la pantalla), retorna una cadena vacía.

get_children(item=None)

Retorna la lista de elementos secundarios que pertenecen a item.

Si no se especifica item, retorna la raíz.

set_children(item, *newchildren)

Reemplaza el elemento secundario de item por newchildren.

Los elementos secundarios presentes en item que no están presentes en newchildren se separan del árbol. Ningún elemento de newchildren puede ser un antecesor de item. Tenga en cuenta que si no se especifica newchildren se desasocian los elementos secundarios de item.

column(column, option=None, **kw)

Consultar o modificar las opciones para la columna especificada.

Si no se proporciona kw, retorna un diccionario de los valores de opciones de columna. Si se especifica option, se retorna el valor de esa option. De lo contrario, establece las opciones en los valores correspondientes.

Las opciones/valores válidos son:

• id

  Retorna el nombre de la columna. Esta es una opción de solo lectura.

• ancla: Uno de los valores de ancla Tk estándar.

  Especifica cómo se debe alinear el texto de esta columna con respecto a la celda.

• minwidth: width

  El ancho mínimo de la columna en píxeles. El widget Treeview no hará que la columna sea más pequeña de lo especificado por esta opción cuando se cambie el tamaño del widget o el usuario arrastre una columna.

• stretch: True/False

  Especifica si el ancho de la columna debe ajustarse cuando se cambia el tamaño del widget.

• width: ancho

  El ancho de la columna en píxeles.

Se puede establecer column = «#0» para configurar el árbol de la columna.

delete(*items)

Elimina todos los items especificados y todos sus descendientes.

El elemento raíz no se elimina.

detach(*items)

Desvincula todos los items especificados del árbol.

Los objetos y todos sus descendientes todavía existen, y pueden ser reinsertados en otro punto del árbol, pero no se mostrarán.

El elemento raíz no se desvincula.

exists(item)

Retorna True si el item especificado está presente en el árbol.

focus(item=None)

Si se especifica item, establece el elemento de foco en item. De lo contrario, retorna el elemento de foco actual o “” si no hay ninguno.

heading(column, option=None, **kw)

Consulta o modifica las opciones de encabezado para la column especificada.

Si no se proporciona kw, retorna un diccionario de los valores de opciones de encabezado. Si se especifica option, se retorna el valor de esa option. De lo contrario, establece las opciones en los valores correspondientes.

Las opciones/valores válidos son:

• text: texto

  El texto se muestra en el encabezado de la columna.

• image: imageName

  Especifica una imagen para mostrar en la parte derecha del encabezado de la columna.

• anchor: ancla

  Especifica el alineamiento del texto del encabezado. Es uno de los valores estándar de Tk anchor.

• command: callback

  Una retrollamada que se ejecutará cuando se presione la etiqueta de encabezado.

Se especifica column =»#0» para configurar el encabezado de la columna de árbol.

identify(component, x, y)

Retorna una descripción del component especificado bajo el punto dado por x e y, o la cadena vacía si no existe dicho component en esa posición.

identify_row(y)

Retorna el identificador del elemento en la posición y.

identify_column(x)

Retorna el identificador de los datos de columna de la celda en la posición x.

La columna del árbol tiene ID #0.

identify_region(x, y)

Retorna uno de:

zona	significado
heading	Zona de encabezado del árbol.
separator	Espacio entre dos encabezados de columna.
tree	La zona del árbol.
cell	Datos de celda.

Disponibilidad: Tk 8.6.

identify_element(x, y)

Retorna el elemento en la posición x, y.

Disponibilidad: Tk 8.6.

index(item)

Retorna el índice entero de item dentro de la lista de elementos secundarios de su elemento primario.

insert(parent, index, iid=None, **kw)

Crea un nuevo elemento y retorna el identificador del elemento recién creado.

parent es el identificador del elemento primario o la cadena vacía para crear un nuevo elemento de nivel superior. index es un entero, o el valor «end», especificando dónde insertar el nuevo elemento en la lista de elementos secundarios del elemento primario. Si index es menor o igual que cero, el nuevo nodo se inserta al principio; si index es mayor o igual que el número actual de elementos secundarios, se inserta al final. Si se especifica iid, se utiliza como identificador de elemento; iid no debe existir en el árbol previamente. De lo contrario, se genera un nuevo identificador único.

Consulte Item Options para obtener la lista de puntos disponibles.

item(item, option=None, **kw)

Consulta o modifica las opciones para el item especificado.

Si no se proporciona ninguna opción, se retorna un diccionario con opciones/valores para el elemento. Si se especifica option, se retorna el valor de esa opción. De lo contrario, establece las opciones en los valores correspondientes según kw.

move(item, parent, index)

Mueve item a la posición index en la lista de elementos secundarios de parent.

No se permite mover un elemento bajo uno de sus descendientes. Si index es menor o igual que cero, item se mueve al principio; si es mayor o igual que el número de hijos, se mueve hasta el final. Si item se desvincula, se vuelve a conectar.

next(item)

Retorna el identificador del siguiente elemento de item, o “” si item es el último elemento secundario de su elemento primario.

parent(item)

Retorna el identificador del elemento primario de item o “” si item está en el nivel superior de la jerarquía.

prev(item)

Retorna el identificador del elemento anterior de item, o “” si item es el primer elemento secundario de su elemento primario.

reattach(item, parent, index)

Un alias para Treeview.move().

see(item)

Garantiza que item está visible.

Establece todas las opciones modificables de los antecesores de item a True y desplaza el widget si es necesario para que item esté dentro de la parte visible del árbol.

selection()

Retorna una tupla de los elementos seleccionados.

Distinto en la versión 3.8: selection() ya no toma argumentos. Para cambiar el estado de selección, utiliza los siguientes métodos de selección.

selection_set(*items)

items se convierte en la nueva selección.

Distinto en la versión 3.6: items se pueden pasar como argumentos separados, no solo como una sola tupla.

selection_add(*items)

Añade items a la selección.

Distinto en la versión 3.6: items se pueden pasar como argumentos separados, no solo como una sola tupla.

selection_remove(*items)

Elimina elementos de la selección.

Distinto en la versión 3.6: items se pueden pasar como argumentos separados, no solo como una sola tupla.

selection_toggle(*items)

Alterna el estado de selección de cada elemento en items.

Distinto en la versión 3.6: items se pueden pasar como argumentos separados, no solo como una sola tupla.

set(item, column=None, value=None)

Con un argumento, retorna un diccionario de pares columna/valor para el item especificado. Con dos argumentos, retorna el valor actual de la columna especificada. Con tres argumentos, establece el valor de determinado column en un item determinado en el value especificado.

tag_bind(tagname, sequence=None, callback=None)

Enlaza una retrollamada para el evento sequence a la etiqueta tagname. Cuando se entrega un evento a un elemento, se llama a las retrollamadas de cada una de las etiquetas del elemento.

tag_configure(tagname, option=None, **kw)

Consulta o modifica las opciones para el tagname especificado.

Si no se proporciona kw, retorna un diccionario de la configuración de opciones para tagname. Si se especifica option, retorna el valor de esa option para el tagname especificado. De lo contrario, establece las opciones en los valores correspondientes para el tagname dado.

tag_has(tagname, item=None)

Si se especifica item, retorna 1 o 0 dependiendo de si el item tiene el tagname especificado. De lo contrario, retorna una lista de todos los elementos que tienen la etiqueta especificada.

Disponibilidad: Tk 8.6

xview(*args)

Consulta o modifica la posición horizontal de la vista de árbol.

yview(*args)

Consulta o modifica la posición vertical de la vista de árbol.

Ttk Styling

A cada widget en ttk se le asigna un estilo, que especifica el conjunto de elementos que componen el widget y cómo se organizan, junto con la configuración dinámica y predeterminada para las opciones de elemento. De forma predeterminada, el nombre del estilo es el mismo que el nombre de clase del widget, pero puede ser reemplazado por la opción de estilo del widget. Si no conoces el nombre de clase de un widget, utiliza el método Misc.winfo_class() (somewidget.winfo_class()).

Ver también

Tcl’2004 conference presentation

Este documento explica cómo funciona el motor de temas

class tkinter.ttk.Style

Esta clase se utiliza para manipular la base de datos de estilos.

configure(style, query_opt=None, **kw)

Consulta o establece el valor predeterminado de las opciones especificadas en style.

Cada clave en kw es una opción y cada valor es una cadena que identifica el valor de esa opción.

Por ejemplo, para cambiar cualquier botón por defecto a un botón plano con borde interno y un color de fondo distinto:

from tkinter import ttk
import tkinter

root = tkinter.Tk()

ttk.Style().configure("TButton", padding=6, relief="flat",
   background="#ccc")

btn = ttk.Button(text="Sample")
btn.pack()

root.mainloop()

map(style, query_opt=None, **kw)

Consulta o establece valores dinámicos de opciones específicas en style.

Cada clave en kw es una opción y cada valor es una lista o tupla (generalmente) que contiene statespecs agrupados en tuplas, listas o alguna otra preferencia. Una statespec es un compuesto de uno o más estados y un valor.

Un ejemplo puede hacerlo más comprensible:

import tkinter
from tkinter import ttk

root = tkinter.Tk()

style = ttk.Style()
style.map("C.TButton",
    foreground=[('pressed', 'red'), ('active', 'blue')],
    background=[('pressed', '!disabled', 'black'), ('active', 'white')]
    )

colored_btn = ttk.Button(text="Test", style="C.TButton").pack()

root.mainloop()

Ten en cuenta que el orden de las secuencias (estado, valor) para una opción es importante, si se cambia el orden a [('active', 'blue'), ('pressed', 'red')] en la opción en primer plano, por ejemplo, el resultado sería un primer plano azul cuando el widget se encuentre en los estados active o pressed.

lookup(style, option, state=None, default=None)

Retorna el valor especificado para option en style.

Si state se especifica, se espera que sea una secuencia de uno o más estados. Si se establece el argumento default, se usa como valor de reserva en caso de que no se especifique una opción.

Para verificar qué fuente usa un Button por defecto:

from tkinter import ttk

print(ttk.Style().lookup("TButton", "font"))

layout(style, layoutspec=None)

Define el diseño del widget para un estilo dado. Si se omite layoutspec, retorna la especificación de diseño para un estilo determinado.

layoutspec, si se especifica, se espera que sea una lista o algún otro tipo de secuencia (excluyendo cadenas), donde cada elemento debe ser una tupla y el primer elemento es el nombre de diseño y el segundo elemento debe tener el formato descrito en Layouts.

Para entender el formato, consulta el siguiente ejemplo (no está pensado para hacer nada útil):

from tkinter import ttk
import tkinter

root = tkinter.Tk()

style = ttk.Style()
style.layout("TMenubutton", [
   ("Menubutton.background", None),
   ("Menubutton.button", {"children":
       [("Menubutton.focus", {"children":
           [("Menubutton.padding", {"children":
               [("Menubutton.label", {"side": "left", "expand": 1})]
           })]
       })]
   }),
])

mbtn = ttk.Menubutton(text='Text')
mbtn.pack()
root.mainloop()

element_create(elementname, etype, *args, **kw)

Crea un nuevo elemento en el tema actual, del etype dado, que se espera que sea «image», «from» o «vsapi». Este último solo está disponible en Tk 8.6a para Windows XP y Vista y no se describe aquí.

Si se utiliza «image», args debe contener el nombre de imagen predeterminado seguido de pares statespec/value (esta es imagespec), y kw puede tener las siguientes opciones:

• border=padding

  el relleno interno es una lista de hasta cuatro enteros, especificando los bordes izquierdo, superior, derecho e inferior, respectivamente.

• height=height

  Especifica una altura mínima para el elemento. Si es menor que cero, la altura de la imagen base se utiliza como valor predeterminado.

• padding=padding

  Especifica el relleno interior del elemento. El valor predeterminado es el valor del borde si no se especifica.

• sticky=spec

  Especifica cómo se coloca la imagen dentro de la sección. spec contiene cero o más caracteres «n», «s», «w» o «e».

• width=width

  Especifica un ancho mínimo para el elemento. Si es menor que cero, el ancho de la imagen base se utiliza como valor predeterminado.

Si se utiliza «from» como valor de etype, element_create() clonará un elemento existente. args contiene un themename, desde el que se clonará el elemento y, opcionalmente, un elemento desde el que clonar. Si no se especifica este elemento para clonar, se usará un elemento vacío. kw se descarta.

element_names()

Retorna la lista de elementos definidos en le tema actual.

element_options(elementname)

Retorna la lista de opciones de elementname.

theme_create(themename, parent=None, settings=None)

Crea un tema nuevo.

Es un error si themename ya existe. Si se especifica parent, el nuevo tema heredará estilos, elementos y diseños del tema primario. Si se especifica settings, se espera que tengan la misma sintaxis utilizada para theme_settings().

theme_settings(themename, settings)

Establece temporalmente el tema actual en themename, aplica los settings especificados y, a continuación, restaura el tema anterior.

Cada clave en settings es un estilo y cada valor puede contener las teclas “configure”, “map”, “layout” y “element create” y se espera que tengan el mismo formato especificado por los métodos Style.configure(), Style.map(), Style.layout() y Style.element_create() respectivamente.

Como ejemplo, vamos a cambiar un poco el Combobox por el tema predeterminado:

from tkinter import ttk
import tkinter

root = tkinter.Tk()

style = ttk.Style()
style.theme_settings("default", {
   "TCombobox": {
       "configure": {"padding": 5},
       "map": {
           "background": [("active", "green2"),
                          ("!disabled", "green4")],
           "fieldbackground": [("!disabled", "green3")],
           "foreground": [("focus", "OliveDrab1"),
                          ("!disabled", "OliveDrab2")]
       }
   }
})

combo = ttk.Combobox().pack()

root.mainloop()

theme_names()

Retorna una lista de temas conocidos.

theme_use(themename=None)

Si no se proporciona themename, retorna el tema en uso. De lo contrario, establece el tema actual en themename, actualiza todos los widgets y emite un evento <<ThemeChanged>>.

Diseños

Un diseño puede ser simplemente None, si no tiene opciones, o un diccionario de opciones que especifica cómo organizar el elemento. El mecanismo de diseño utiliza una versión simplificada del paquete de gestión de geometría: dada una cavidad inicial, a cada elemento se le asigna una sección. Las opciones/valores válidos son:

• side: whichside

  Especifica en qué lado de la cavidad colocar el elemento; sea arriba, derecha, abajo o izquierda. Si se omite, el elemento ocupa toda la cavidad.

• sticky: nswe

  Especifica dónde se coloca el elemento dentro de su sección asignada.

• unit: 0 or 1

  Si se establece en 1, hace que el elemento y todos sus descendientes sean tratados como un único elemento en métodos como Widget.identify() y otros. Se utiliza para cosas como los thumbs de la barra de desplazamiento.

• children: [sublayout… ]

  Especifica una lista de elementos para colocar dentro del elemento. Cada elemento es una tupla (u otro tipo de secuencia) donde el primer elemento es el nombre de diseño y el otro es un Layout.