Tkinter Class API Reference

https://tkdocs.com/pyref/onepage.html
Admin
This document provides a comprehensive API reference for Tkinter and Ttk (Themed Tkinter) widgets,...
Tokens:11,500
Snippets:21
Trust Score:9.5
Update:11 months ago
Show doc for...
Tokens:
Raw
### Progressbar Widget

Source: https://tkdocs.com/pyref/onepage.html/index

The Progressbar widget shows the status of a long-running operation. It supports methods like start, step, and stop to control the progress.

```APIDOC
## tkinter.ttk.Progressbar

### Description
Ttk Progressbar widget shows the status of a long-running operation.

### Methods
- **start(interval=None)** - Starts the progress bar animation.
- **step(amount=None)** - Increments the progress bar by the specified amount.
- **stop()** - Stops the progress bar animation.

### Configuration Options
- **orient** - Orientation of the progress bar (horizontal or vertical).
- **length** - Length of the progress bar.
- **mode** - Mode of the progress bar (determinate or indeterminate).
- **maximum** - Maximum value of the progress bar.
- **variable** - Variable linked to the progress bar.
- **value** - Current value of the progress bar.
- **phase** - Phase of the progress bar (for indeterminate mode).
- **takefocus** - Whether the widget can take focus.
- **cursor** - Cursor to display when hovering over the widget.
- **style** - Style of the widget.
- **class** - Class of the widget.
```

--------------------------------

### Scale Widget

Source: https://tkdocs.com/pyref/onepage.html/index

The Scale widget is typically used to control the numeric value of a linked variable that varies uniformly over some range. It supports methods like coords, get, and set.

```APIDOC
## tkinter.ttk.Scale

### Description
Ttk Scale widget is typically used to control the numeric value of a linked variable that varies uniformly over some range.

### Methods
- **coords(value=None)** - Returns the coordinates of the scale's slider.
- **get(x=None, y=None)** - Gets the current value of the scale.
- **set(value)** - Sets the value of the scale.

### Configuration Options
- **command** - Command to execute when the scale is adjusted.
- **variable** - Variable linked to the scale.
- **orient** - Orientation of the scale (horizontal or vertical).
- **from** - Minimum value of the scale.
- **to** - Maximum value of the scale.
- **value** - Current value of the scale.
- **length** - Length of the scale.
- **state** - State of the scale (normal, disabled, etc.).
- **takefocus** - Whether the widget can take focus.
- **cursor** - Cursor to display when hovering over the widget.
- **style** - Style of the widget.
- **class** - Class of the widget.
```

--------------------------------

### Scrollbar Widget

Source: https://tkdocs.com/pyref/onepage.html/index

The Scrollbar widget controls the viewport of a scrollable widget. It supports methods like activate, delta, fraction, get, and set.

```APIDOC
## tkinter.ttk.Scrollbar

### Description
Ttk Scrollbar controls the viewport of a scrollable widget.

### Methods
- **activate(index=None)** - Activates the scrollbar.
- **delta(deltax, deltay)** - Returns the fractional change of the scrollbar.
- **fraction(x, y)** - Returns the fractional position of the scrollbar.
- **get()** - Gets the current position of the scrollbar.
- **set(first, last)** - Sets the position of the scrollbar.

### Configuration Options
- **command** - Command to execute when the scrollbar is adjusted.
- **orient** - Orientation of the scrollbar (horizontal or vertical).
- **takefocus** - Whether the widget can take focus.
- **cursor** - Cursor to display when hovering over the widget.
- **style** - Style of the widget.
- **class** - Class of the widget.
```

--------------------------------

### Sizegrip Widget

Source: https://tkdocs.com/pyref/onepage.html/index

The Sizegrip widget allows the user to resize the containing toplevel window by pressing and dragging the grip. It has no methods but supports configuration options.

```APIDOC
## tkinter.ttk.Sizegrip

### Description
Ttk Sizegrip allows the user to resize the containing toplevel window by pressing and dragging the grip.

### Configuration Options
- **takefocus** - Whether the widget can take focus.
- **cursor** - Cursor to display when hovering over the widget.
- **style** - Style of the widget.
- **class** - Class of the widget.
```

--------------------------------

### tkinter.ttk.Notebook

Source: https://tkdocs.com/pyref/onepage.html/index

The Ttk Notebook widget manages multiple child widgets, displaying only one at a time, and providing tabbed navigation between them.

```APIDOC
## tkinter.ttk.Notebook

### Description
Ttk Notebook widget manages a collection of windows and displays a single one at a time.

### Methods
- **add(child, **kw)**: Add a new tab.
- **hide(tab_id)**: Hide a tab.
- **index(tab_id)**: Get the index of a tab.
- **insert(pos, child, **kw)**: Insert a tab at a specific position.
- **select(tab_id=None)**: Select a tab.
- **tab(tab_id, option=None, **kw)**: Configure or query a tab.
- **tabs()**: Get a list of all tab identifiers.
- **enable_traversal()**: Enable keyboard traversal for tabs.

### Endpoint
N/A (Class constructor)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **master** (Widget) - The parent widget.
* **kw** (dict) - Configuration options.

### Request Example
```python
from tkinter import ttk

root = tk.Tk()
notebook = ttk.Notebook(root)
frame1 = ttk.Frame(notebook)
notebook.add(frame1, text='Tab 1')
```

### Response
#### Success Response (200)
N/A (Widget creation)

#### Response Example
N/A
```

--------------------------------

### Spinbox Widget

Source: https://tkdocs.com/pyref/onepage.html/index

The Spinbox widget is an Entry with increment and decrement arrows. It is commonly used for number entry or to select from a list of string values. It supports various methods for manipulation.

```APIDOC
## tkinter.ttk.Spinbox

### Description
Ttk Spinbox is an Entry with increment and decrement arrows. It is commonly used for number entry or to select from a list of string values.

### Methods
- **delete(first, last=None)** - Deletes characters from the spinbox.
- **get()** - Gets the current value of the spinbox.
- **icursor(index)** - Sets the insertion cursor position.
- **index(index)** - Returns the numerical index corresponding to the given position.
- **insert(index, string)** - Inserts a string at the specified position.
- **set(value)** - Sets the value of the spinbox.
- **validate()** - Validates the spinbox's contents.
- **scan_dragto(x)** - Scrolls the spinbox's contents.
- **scan_mark(x)** - Marks a position for scrolling.
- **selection_adjust(index)** - Adjusts the selection.
- **selection_from(index)** - Starts a selection from the specified index.
- **selection_present()** - Checks if there is a selection.
- **selection_range(start, end)** - Sets the selection range.
- **selection_to(index)** - Extends the selection to the specified index.
- **xview(*args)** - Controls horizontal scrolling.
- **xview_moveto(fraction)** - Scrolls horizontally to a fraction.
- **xview_scroll(number, what)** - Scrolls horizontally by a number of units.

### Configuration Options
- **values** - List of values for the spinbox.
- **from** - Minimum value of the spinbox.
- **to** - Maximum value of the spinbox.
- **increment** - Increment value for the spinbox.
- **format** - Format string for the spinbox.
- **command** - Command to execute when the spinbox is adjusted.
- **wrap** - Whether to wrap around values.
- **exportselection** - Whether to export the selection.
- **font** - Font of the spinbox.
- **invalidcommand** - Command to execute when validation fails.
- **justify** - Justification of the text.
- **show** - Whether to show the text.
- **state** - State of the spinbox (normal, disabled, etc.).
- **textvariable** - Variable linked to the text of the spinbox.
- **validate** - Validation mode.
- **validatecommand** - Command to validate the spinbox.
- **width** - Width of the spinbox.
- **xscrollcommand** - Command to execute for horizontal scrolling.
- **foreground** - Foreground color of the spinbox.
- **background** - Background color of the spinbox.
- **takefocus** - Whether the widget can take focus.
- **cursor** - Cursor to display when hovering over the widget.
- **style** - Style of the widget.
- **class** - Class of the widget.
```

--------------------------------

### tkinter.ttk.OptionMenu

Source: https://tkdocs.com/pyref/onepage.html/index

The Ttk OptionMenu widget, based on Tkinter's OptionMenu, allows users to select a value from a dropdown menu.

```APIDOC
## tkinter.ttk.OptionMenu

### Description
Themed OptionMenu, based after tkinter's OptionMenu, which allows the user to select a value from a menu.

### Methods
- **set_menu()**: Set the menu for the OptionMenu.

### Endpoint
N/A (Class constructor)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **master** (Widget) - The parent widget.
* **variable** (tk.Variable) - The variable to hold the selected value.
* **default** (any) - The default selected value.
* ***values** (list) - The list of options for the menu.
* ****kwargs** (dict) - Configuration options.

### Request Example
```python
from tkinter import ttk, tk

root = tk.Tk()
options = ['Apple', 'Banana', 'Cherry']
selected_option = tk.StringVar(root)
option_menu = ttk.OptionMenu(root, selected_option, options[0], *options)
```

### Response
#### Success Response (200)
N/A (Widget creation)

#### Response Example
N/A
```

--------------------------------

### tkinter.ttk.Menubutton

Source: https://tkdocs.com/pyref/onepage.html/index

The Ttk Menubutton widget displays a label and an associated menu that appears when the button is clicked.

```APIDOC
## tkinter.ttk.Menubutton

### Description
Ttk Menubutton widget displays a textual label and/or image, and displays a menu when pressed.

### Endpoint
N/A (Class constructor)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **master** (Widget) - The parent widget.
* **kw** (dict) - Configuration options.

### Request Example
```python
from tkinter import ttk, tk

root = tk.Tk()
menu_button = ttk.Menubutton(root, text="Options")
# Attach a menu to menu_button
```

### Response
#### Success Response (200)
N/A (Widget creation)

#### Response Example
N/A
```

--------------------------------

### Radiobutton Widget

Source: https://tkdocs.com/pyref/onepage.html/index

The Radiobutton widget is used in groups to show or change a set of mutually-exclusive options. It supports the invoke method to trigger the button.

```APIDOC
## tkinter.ttk.Radiobutton

### Description
Ttk Radiobutton widgets are used in groups to show or change a set of mutually-exclusive options.

### Methods
- **invoke()** - Triggers the radiobutton's command.

### Configuration Options
- **variable** - Variable linked to the radiobutton.
- **value** - Value associated with the radiobutton.
- **command** - Command to execute when the radiobutton is invoked.
- **takefocus** - Whether the widget can take focus.
- **text** - Text displayed on the radiobutton.
- **textvariable** - Variable linked to the text of the radiobutton.
- **underline** - Index of the character to underline.
- **width** - Width of the radiobutton.
- **image** - Image displayed on the radiobutton.
- **compound** - How to combine text and image.
- **padding** - Padding around the radiobutton.
- **state** - State of the radiobutton (normal, disabled, etc.).
- **cursor** - Cursor to display when hovering over the widget.
- **style** - Style of the widget.
- **class** - Class of the widget.
```

--------------------------------

### Treeview Widget

Source: https://tkdocs.com/pyref/onepage.html/index

The Treeview widget displays a hierarchical collection of items. It supports various methods for manipulating items, columns, and selections.

```APIDOC
## tkinter.ttk.Treeview

### Description
Ttk Treeview widget displays a hierarchical collection of items.

### Methods
- **column(column, option=None, **kw)** - Configures a column.
- **delete(*items)** - Deletes items.
- **detach(*items)** - Detaches items.
- **exists(item)** - Checks if an item exists.
- **heading(column, option=None, **kw)** - Configures a heading.
- **index(item)** - Returns the index of an item.
- **insert(parent, index, iid=None, **kw)** - Inserts an item.
- **item(item, option=None, **kw)** - Configures an item.
- **move(item, parent, index)** - Moves an item.
- **next(item)** - Returns the next item.
- **parent(item)** - Returns the parent of an item.
- **prev(item)** - Returns the previous item.
- **see(item)** - Ensures an item is visible.
- **get_children(item=None)** - Returns the children of an item.
- **identify_column(x)** - Identifies the column at a position.
- **identify_element(x, y)** - Identifies the element at a position.
- **identify_region(x, y)** - Identifies the region at a position.
- **identify_row(y)** - Identifies the row at a position.
- **selection()** - Returns the selected items.
- **selection_add(*items)** - Adds items to the selection.
- **selection_remove(*items)** - Removes items from the selection.
- **selection_set(*items)** - Sets the selection.
- **selection_toggle(*items)** - Toggles the selection of items.
- **set(item, column=None, value=None)** - Sets the value of an item.
- **set_children(item, *newchildren)** - Sets the children of an item.
- **tag_bind(tagname, sequence=None, callback=None)** - Binds an event to a tag.
- **tag_configure(tagname, option=None, **kw)** - Configures a tag.
- **tag_has(tagname, item=None)** - Checks if an item has a tag.
- **xview(*args)** - Controls horizontal scrolling.
- **xview_moveto(fraction)** - Scrolls horizontally to a fraction.
- **xview_scroll(number, what)** - Scrolls horizontally by a number of units.
- **yview(*args)** - Controls vertical scrolling.
- **yview_moveto(fraction)** - Scrolls vertically to a fraction.
- **yview_scroll(number, what)** - Scrolls vertically by a number of units.

### Configuration Options
- **columns** - List of columns.
- **displaycolumns** - Columns to display.
- **show** - Which parts of the tree to show.
- **selectmode** - Selection mode.
- **height** - Height of the treeview.
- **padding** - Padding around the treeview.
- **xscrollcommand** - Command to execute for horizontal scrolling.
- **yscrollcommand** - Command to execute for vertical scrolling.
- **takefocus** - Whether the widget can take focus.
- **cursor** - Cursor to display when hovering over the widget.
- **style** - Style of the widget.
- **class** - Class of the widget.
```

--------------------------------

### tkinter.ttk.Combobox

Source: https://tkdocs.com/pyref/onepage.html/index

The Ttk Combobox widget integrates a text field with a dropdown list, enabling users to select a value or enter their own. It offers methods for managing the list, text, and selection.

```APIDOC
## tkinter.ttk.Combobox

### Description
Ttk Combobox widget combines a text field with a pop-down list of values.

### Methods
- **current(newindex=None)**: Get or set the current selection index.
- **delete(first, last=None)**: Delete characters from the widget.
- **get()**: Get the current text in the entry.
- **icursor(index)**: Set the insertion cursor to the given index.
- **index(index)**: Return the index for the given string.
- **insert(index, string)**: Insert string at the given index.
- **set(value)**: Set the entry's value.
- **validate()**: Validate the current content.
- **scan_dragto(x)**: Used for scanning.
- **scan_mark(x)**: Used for scanning.
- **selection_adjust(index)**: Adjust the selection.
- **selection_from(index)**: Set the start of the selection.
- **selection_present()**: Check if there is a selection.
- **selection_range(start, end)**: Set the selection range.
- **selection_to(index)**: Set the end of the selection.
- **xview(*args)**: Control the horizontal view.
- **xview_moveto(fraction)**: Move the view to a fraction.
- **xview_scroll(number, what)**: Scroll the view.

### Endpoint
N/A (Class constructor)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **master** (Widget) - The parent widget.
* **kw** (dict) - Configuration options.

### Request Example
```python
from tkinter import ttk

root = tk.Tk()
values = ['Option 1', 'Option 2', 'Option 3']
combobox = ttk.Combobox(root, values=values)
```

### Response
#### Success Response (200)
N/A (Widget creation)

#### Response Example
N/A
```

--------------------------------

### tkinter.ttk.Entry

Source: https://tkdocs.com/pyref/onepage.html/index

The Ttk Entry widget provides a single-line text input field for user interaction. It supports methods for text manipulation, cursor positioning, and validation.

```APIDOC
## tkinter.ttk.Entry

### Description
Ttk Entry widget displays a one-line text string and allows that string to be edited by the user.

### Methods
- **delete(first, last=None)**: Delete characters from the widget.
- **get()**: Get the current text in the entry.
- **icursor(index)**: Set the insertion cursor to the given index.
- **index(index)**: Return the index for the given string.
- **insert(index, string)**: Insert string at the given index.
- **validate()**: Validate the current content.
- **scan_dragto(x)**: Used for scanning.
- **scan_mark(x)**: Used for scanning.
- **selection_adjust(index)**: Adjust the selection.
- **selection_from(index)**: Set the start of the selection.
- **selection_present()**: Check if there is a selection.
- **selection_range(start, end)**: Set the selection range.
- **selection_to(index)**: Set the end of the selection.
- **xview(*args)**: Control the horizontal view.
- **xview_moveto(fraction)**: Move the view to a fraction.
- **xview_scroll(number, what)**: Scroll the view.

### Endpoint
N/A (Class constructor)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **master** (Widget) - The parent widget.
* **widget** (Widget) - A widget associated with the entry.
* **kw** (dict) - Configuration options.

### Request Example
```python
from tkinter import ttk

root = tk.Tk()
entry = ttk.Entry(root, width=30)
```

### Response
#### Success Response (200)
N/A (Widget creation)

#### Response Example
N/A
```

--------------------------------

### Separator Widget

Source: https://tkdocs.com/pyref/onepage.html/index

The Separator widget displays a horizontal or vertical separator bar. It has no methods but supports configuration options.

```APIDOC
## tkinter.ttk.Separator

### Description
Ttk Separator widget displays a horizontal or vertical separator bar.

### Configuration Options
- **orient** - Orientation of the separator (horizontal or vertical).
- **takefocus** - Whether the widget can take focus.
- **cursor** - Cursor to display when hovering over the widget.
- **style** - Style of the widget.
- **class** - Class of the widget.
```

--------------------------------

### tkinter.ttk.LabeledScale

Source: https://tkdocs.com/pyref/onepage.html/index

The Ttk LabeledScale widget combines a Ttk Scale with a Ttk Label that shows the current value, providing a visual representation of a range selection.

```APIDOC
## tkinter.ttk.LabeledScale

### Description
A Ttk Scale widget with a Ttk Label widget indicating its current value. The Ttk Scale can be accessed through instance.scale, and Ttk Label can be accessed through instance.label

### Methods
- **value()**: Get the current value of the scale.

### Endpoint
N/A (Class constructor)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **master** (Widget) - The parent widget.
* **variable** (tk.Variable) - The variable to associate with the scale.
* **from_** (float) - The minimum value of the scale.
* **to** (float) - The maximum value of the scale.
* **kw** (dict) - Configuration options.

### Request Example
```python
from tkinter import ttk, tk

root = tk.Tk()
scale_var = tk.DoubleVar()
labeled_scale = ttk.LabeledScale(root, variable=scale_var, from_=0, to=100)
```

### Response
#### Success Response (200)
N/A (Widget creation)

#### Response Example
N/A
```

--------------------------------

### tkinter.ttk.Label

Source: https://tkdocs.com/pyref/onepage.html/index

The Ttk Label widget is used to display static text or images. It supports various styling and alignment options for presentation.

```APIDOC
## tkinter.ttk.Label

### Description
Ttk Label widget displays a textual label and/or image.

### Endpoint
N/A (Class constructor)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **master** (Widget) - The parent widget.
* **kw** (dict) - Configuration options.

### Request Example
```python
from tkinter import ttk

root = tk.Tk()
label = ttk.Label(root, text="Hello, Tkinter!")
```

### Response
#### Success Response (200)
N/A (Widget creation)

#### Response Example
N/A
```

--------------------------------

### tkinter.ttk.Panedwindow

Source: https://tkdocs.com/pyref/onepage.html/index

The Ttk Panedwindow widget allows users to resize the space allocated to child widgets stacked either vertically or horizontally.

```APIDOC
## tkinter.ttk.Panedwindow

### Description
Ttk Panedwindow widget displays a number of subwindows, stacked either vertically or horizontally.

### Methods
- **add(child, **kw)**: Add a pane.
- **insert(pos, child, **kw)**: Insert a pane at a position.
- **pane(pane, option=None, **kw)**: Configure or query a pane.
- **panecget(child, option)**: Get a pane's configuration option.
- **paneconfigure(tagOrId, cnf=None, **kw)**: Configure a pane.
- **panes()**: Get a list of panes.
- **remove(child)**: Remove a pane.
- **sashpos(index, newpos=None)**: Get or set the position of a sash.
- **proxy(*args)**: Proxy methods.
- **proxy_coord()**: Get proxy coordinates.
- **proxy_forget()**: Forget proxy.
- **proxy_place(x, y)**: Place proxy.
- **sash(*args)**: Sash methods.
- **sash_coord(index)**: Get sash coordinates.
- **sash_mark(index)**: Get sash mark.
- **sash_place(index, x, y)**: Place sash.

### Endpoint
N/A (Class constructor)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **master** (Widget) - The parent widget.
* **kw** (dict) - Configuration options.

### Request Example
```python
from tkinter import ttk

root = tk.Tk()
paned_window = ttk.Panedwindow(root, orient=tk.HORIZONTAL)
left_pane = ttk.Frame(paned_window)
right_pane = ttk.Frame(paned_window)
paned_window.add(left_pane)
paned_window.add(right_pane)
```

### Response
#### Success Response (200)
N/A (Widget creation)

#### Response Example
N/A
```

--------------------------------

### tkinter.ttk.Frame

Source: https://tkdocs.com/pyref/onepage.html/index

The Ttk Frame widget serves as a container to organize and group other widgets within a Tkinter application.

```APIDOC
## tkinter.ttk.Frame

### Description
Ttk Frame widget is a container, used to group other widgets together.

### Endpoint
N/A (Class constructor)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **master** (Widget) - The parent widget.
* **kw** (dict) - Configuration options.

### Request Example
```python
from tkinter import ttk

root = tk.Tk()
frame = ttk.Frame(root, padding="10")
```

### Response
#### Success Response (200)
N/A (Widget creation)

#### Response Example
N/A
```

--------------------------------

### tkinter.ttk.Checkbutton

Source: https://tkdocs.com/pyref/onepage.html/index

The Ttk Checkbutton widget allows users to select or deselect an option. It can be configured with various options to control its appearance and behavior.

```APIDOC
## tkinter.ttk.Checkbutton

### Description
Ttk Checkbutton widget which is either in on- or off-state.

### Method
Constructor

### Endpoint
N/A (Class constructor)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **master** (Widget) - The parent widget.
* **kw** (dict) - Configuration options.

### Request Example
```python
from tkinter import ttk

root = tk.Tk()
checkbutton = ttk.Checkbutton(root, text="Option", variable=my_var)
```

### Response
#### Success Response (200)
N/A (Widget creation)

#### Response Example
N/A
```

--------------------------------

### tkinter.ttk.Labelframe

Source: https://tkdocs.com/pyref/onepage.html/index

The Ttk Labelframe widget is a framed container that can optionally display a label. It is used for grouping related widgets.

```APIDOC
## tkinter.ttk.Labelframe

### Description
Ttk Labelframe widget is a container used to group other widgets together. It has an optional label, which may be a plain text string or another widget.

### Endpoint
N/A (Class constructor)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **master** (Widget) - The parent widget.
* **kw** (dict) - Configuration options.

### Request Example
```python
from tkinter import ttk

root = tk.Tk()
label_frame = ttk.Labelframe(root, text="Group Box")
```

### Response
#### Success Response (200)
N/A (Widget creation)

#### Response Example
N/A
```
Tokens:
Raw