"""Ttk wrapper.

This module provides classes to allow using Tk themed widget set.

Ttk is based on a revised and enhanced version of

TIP #48 (http://tip.tcl.tk/48) specified style engine.

Its basic idea is to separate, to the extent possible, the code

implementing a widget's behavior from the code implementing its

appearance. Widget class bindings are primarily responsible for

maintaining the widget state and invoking callbacks, all aspects

of the widgets appearance lies at Themes.

"""

__version__ = "0.3.1"

__author__ = "Guilherme Polo <[email protected]>"

__all__ = ["Button", "Checkbutton", "Combobox", "Entry", "Frame", "Label",

"Labelframe", "LabelFrame", "Menubutton", "Notebook", "Panedwindow",

"PanedWindow", "Progressbar", "Radiobutton", "Scale", "Scrollbar",

"Separator", "Sizegrip", "Style", "Treeview",

# Extensions

"LabeledScale", "OptionMenu",

# functions

"tclobjs_to_py", "setup_master"]

import tkinter

from tkinter import _flatten, _join, _stringify

# Verify if Tk is new enough to not need the Tile package

_REQUIRE_TILE = True if tkinter.TkVersion < 8.5 else False

def _load_tile(master):

if _REQUIRE_TILE:

import os

tilelib = os.environ.get('TILE_LIBRARY')

if tilelib:

# append custom tile path to the list of directories that

# Tcl uses when attempting to resolve packages with the package

# command

master.tk.eval(

'global auto_path; '

'lappend auto_path {%s}' % tilelib)

master.tk.eval('package require tile') # TclError may be raised here

master._tile_loaded = True

def _format_optvalue(value, script=False):

"""Internal function."""

if script:

# if caller passes a Tcl script to tk.call, all the values need to

# be grouped into words (arguments to a command in Tcl dialect)

value = _stringify(value)

elif isinstance(value, (list, tuple)):

value = _join(value)

return value

def _format_optdict(optdict, script=False, ignore=None):

"""Formats optdict to a tuple to pass it to tk.call.

E.g. (script=False):

{'foreground': 'blue', 'padding': [1, 2, 3, 4]} returns:

('-foreground', 'blue', '-padding', '1 2 3 4')"""

opts = []

for opt, value in optdict.items():

if not ignore or opt not in ignore:

opts.append("-%s" % opt)

if value is not None:

opts.append(_format_optvalue(value, script))

return _flatten(opts)

def _mapdict_values(items):

# each value in mapdict is expected to be a sequence, where each item

# is another sequence containing a state (or several) and a value

# E.g. (script=False):

# [('active', 'selected', 'grey'), ('focus', [1, 2, 3, 4])]

# returns:

# ['active selected', 'grey', 'focus', [1, 2, 3, 4]]

opt_val = []

for *state, val in items:

# hacks for bakward compatibility

state[0] # raise IndexError if empty

if len(state) == 1:

# if it is empty (something that evaluates to False), then

# format it to Tcl code to denote the "normal" state

state = state[0] or ''

else:

# group multiple states

state = ' '.join(state) # raise TypeError if not str

opt_val.append(state)

if val is not None:

opt_val.append(val)

return opt_val

def _format_mapdict(mapdict, script=False):

"""Formats mapdict to pass it to tk.call.

E.g. (script=False):

{'expand': [('active', 'selected', 'grey'), ('focus', [1, 2, 3, 4])]}

returns:

('-expand', '{active selected} grey focus {1, 2, 3, 4}')"""

opts = []

for opt, value in mapdict.items():

opts.extend(("-%s" % opt,

_format_optvalue(_mapdict_values(value), script)))

return _flatten(opts)

def _format_elemcreate(etype, script=False, *args, **kw):

"""Formats args and kw according to the given element factory etype."""

spec = None

opts = ()

if etype in ("image", "vsapi"):

if etype == "image": # define an element based on an image

# first arg should be the default image name

iname = args[0]

# next args, if any, are statespec/value pairs which is almost

# a mapdict, but we just need the value

imagespec = _join(_mapdict_values(args[1:]))

spec = "%s %s" % (iname, imagespec)

else:

# define an element whose visual appearance is drawn using the

# Microsoft Visual Styles API which is responsible for the

# themed styles on Windows XP and Vista.

# Availability: Tk 8.6, Windows XP and Vista.

class_name, part_id = args[:2]

statemap = _join(_mapdict_values(args[2:]))

spec = "%s %s %s" % (class_name, part_id, statemap)

opts = _format_optdict(kw, script)

elif etype == "from": # clone an element

# it expects a themename and optionally an element to clone from,

# otherwise it will clone {} (empty element)

spec = args[0] # theme name

if len(args) > 1: # elementfrom specified

opts = (_format_optvalue(args[1], script),)

if script:

spec = '{%s}' % spec

opts = ' '.join(opts)

return spec, opts

def _format_layoutlist(layout, indent=0, indent_size=2):

"""Formats a layout list so we can pass the result to ttk::style

layout and ttk::style settings. Note that the layout doesn't has to

be a list necessarily.

E.g.:

[("Menubutton.background", None),

("Menubutton.button", {"children":

[("Menubutton.focus", {"children":

[("Menubutton.padding", {"children":

[("Menubutton.label", {"side": "left", "expand": 1})]

})]

})]

}),

("Menubutton.indicator", {"side": "right"})

]

returns:

Menubutton.background

Menubutton.button -children {

Menubutton.focus -children {

Menubutton.padding -children {

Menubutton.label -side left -expand 1

}

}

}

Menubutton.indicator -side right"""

script = []

for layout_elem in layout:

elem, opts = layout_elem

opts = opts or {}

fopts = ' '.join(_format_optdict(opts, True, ("children",)))

head = "%s%s%s" % (' ' * indent, elem, (" %s" % fopts) if fopts else '')

if "children" in opts:

script.append(head + " -children {")

indent += indent_size

newscript, indent = _format_layoutlist(opts['children'], indent,

indent_size)

script.append(newscript)

indent -= indent_size

script.append('%s}' % (' ' * indent))

else:

script.append(head)

return '\n'.join(script), indent

def _script_from_settings(settings):

"""Returns an appropriate script, based on settings, according to

theme_settings definition to be used by theme_settings and

theme_create."""

script = []

# a script will be generated according to settings passed, which

# will then be evaluated by Tcl

for name, opts in settings.items():

# will format specific keys according to Tcl code

if opts.get('configure'): # format 'configure'

s = ' '.join(_format_optdict(opts['configure'], True))

script.append("ttk::style configure %s %s;" % (name, s))

if opts.get('map'): # format 'map'

s = ' '.join(_format_mapdict(opts['map'], True))

script.append("ttk::style map %s %s;" % (name, s))

if 'layout' in opts: # format 'layout' which may be empty

if not opts['layout']:

s = 'null' # could be any other word, but this one makes sense

else:

s, _ = _format_layoutlist(opts['layout'])

script.append("ttk::style layout %s {\n%s\n}" % (name, s))

if opts.get('element create'): # format 'element create'

eopts = opts['element create']

etype = eopts[0]

# find where args end, and where kwargs start

argc = 1 # etype was the first one

while argc < len(eopts) and not hasattr(eopts[argc], 'items'):

argc += 1

elemargs = eopts[1:argc]

elemkw = eopts[argc] if argc < len(eopts) and eopts[argc] else {}

spec, opts = _format_elemcreate(etype, True, *elemargs, **elemkw)

script.append("ttk::style element create %s %s %s %s" % (

name, etype, spec, opts))

return '\n'.join(script)

def _dict_from_tcltuple(ttuple, cut_minus=True):

"""Break tuple in pairs, format it properly, then build the return

dict. If cut_minus is True, the supposed '-' prefixing options will

be removed.

ttuple is expected to contain an even number of elements."""

opt_start = 1 if cut_minus else 0

retdict = {}

it = iter(ttuple)

for opt, val in zip(it, it):

retdict[str(opt)[opt_start:]] = val

return tclobjs_to_py(retdict)

def _list_from_statespec(stuple):

"""Construct a list from the given statespec tuple according to the

accepted statespec accepted by _format_mapdict."""

nval = []

for val in stuple:

typename = getattr(val, 'typename', None)

if typename is None:

nval.append(val)

else: # this is a Tcl object

val = str(val)

if typename == 'StateSpec':

val = val.split()

nval.append(val)

it = iter(nval)

return [_flatten(spec) for spec in zip(it, it)]

def _list_from_layouttuple(ltuple):

"""Construct a list from the tuple returned by ttk::layout, this is

somewhat the reverse of _format_layoutlist."""

res = []

indx = 0

while indx < len(ltuple):

name = ltuple[indx]

opts = {}

res.append((name, opts))

indx += 1

while indx < len(ltuple): # grab name's options

opt, val = ltuple[indx:indx + 2]

if not opt.startswith('-'): # found next name

break

opt = opt[1:] # remove the '-' from the option

indx += 2

if opt == 'children':

if (tkinter._default_root and

not tkinter._default_root.wantobjects()):

val = tkinter._default_root.splitlist(val)

val = _list_from_layouttuple(val)

opts[opt] = val

return res

def _val_or_dict(options, func, *args):

"""Format options then call func with args and options and return

the appropriate result.

If no option is specified, a dict is returned. If a option is

specified with the None value, the value for that option is returned.

Otherwise, the function just sets the passed options and the caller

shouldn't be expecting a return value anyway."""

options = _format_optdict(options)

res = func(*(args + options))

if len(options) % 2: # option specified without a value, return its value

return res

if tkinter._default_root:

res = tkinter._default_root.splitlist(res)

return _dict_from_tcltuple(res)

def _convert_stringval(value):

"""Converts a value to, hopefully, a more appropriate Python object."""

value = str(value)

try:

value = int(value)

except (ValueError, TypeError):

pass

return value

def _to_number(x):

if isinstance(x, str):

if '.' in x:

x = float(x)

else:

x = int(x)

return x

def tclobjs_to_py(adict):

"""Returns adict with its values converted from Tcl objects to Python

objects."""

for opt, val in adict.items():

if val and hasattr(val, '__len__') and not isinstance(val, str):

if getattr(val[0], 'typename', None) == 'StateSpec':

val = _list_from_statespec(val)

else:

val = list(map(_convert_stringval, val))

elif hasattr(val, 'typename'): # some other (single) Tcl object

val = _convert_stringval(val)

adict[opt] = val

return adict

def setup_master(master=None):

"""If master is not None, itself is returned. If master is None,

the default master is returned if there is one, otherwise a new

master is created and returned.

If it is not allowed to use the default root and master is None,

RuntimeError is raised."""

if master is None:

if tkinter._support_default_root:

master = tkinter._default_root or tkinter.Tk()

else:

raise RuntimeError(

"No master specified and tkinter is "

"configured to not support default root")

return master

class Style(object):

"""Manipulate style database."""

_name = "ttk::style"

def __init__(self, master=None):

master = setup_master(master)

if not getattr(master, '_tile_loaded', False):

# Load tile now, if needed

_load_tile(master)

self.master = master

self.tk = self.master.tk

def configure(self, style, query_opt=None, **kw):

"""Query or sets the default value of the specified option(s) in

style.

Each key in kw is an option and each value is either a string or

a sequence identifying the value for that option."""

if query_opt is not None:

kw[query_opt] = None

return _val_or_dict(kw, self.tk.call, self._name, "configure", style)

def map(self, style, query_opt=None, **kw):

"""Query or sets dynamic values of the specified option(s) in

style.

Each key in kw is an option and each value should be a list or a

tuple (usually) containing statespecs grouped in tuples, or list,

or something else of your preference. A statespec is compound of

one or more states and then a value."""

if query_opt is not None:

return _list_from_statespec(self.tk.splitlist(

self.tk.call(self._name, "map", style, '-%s' % query_opt)))

return _dict_from_tcltuple(

self.tk.call(self._name, "map", style, *(_format_mapdict(kw))))

def lookup(self, style, option, state=None, default=None):

"""Returns the value specified for option in style.

If state is specified it is expected to be a sequence of one

or more states. If the default argument is set, it is used as

a fallback value in case no specification for option is found."""

state = ' '.join(state) if state else ''

return self.tk.call(self._name, "lookup", style, '-%s' % option,

state, default)

def layout(self, style, layoutspec=None):

"""Define the widget layout for given style. If layoutspec is

omitted, return the layout specification for given style.

layoutspec is expected to be a list or an object different than

None that evaluates to False if you want to "turn off" that style.

If it is a list (or tuple, or something else), each item should be

a tuple where the first item is the layout name and the second item

should have the format described below:

LAYOUTS

A layout can contain the value None, if takes no options, or

a dict of options specifying how to arrange the element.

The layout mechanism uses a simplified version of the pack

geometry manager: given an initial cavity, each element is

allocated a parcel. Valid options/values are:

side: whichside

Specifies which side of the cavity to place the

element; one of top, right, bottom or left. If

omitted, the element occupies the entire cavity.

sticky: nswe

Specifies where the element is placed inside its

allocated parcel.

children: [sublayout... ]

Specifies a list of elements to place inside the

element. Each element is a tuple (or other sequence)

where the first item is the layout name, and the other

is a LAYOUT."""

lspec = None

if layoutspec:

lspec = _format_layoutlist(layoutspec)[0]

elif layoutspec is not None: # will disable the layout ({}, '', etc)

lspec = "null" # could be any other word, but this may make sense

# when calling layout(style) later

return _list_from_layouttuple(self.tk.splitlist(

self.tk.call(self._name, "layout", style, lspec)))

def element_create(self, elementname, etype, *args, **kw):

"""Create a new element in the current theme of given etype."""

spec, opts = _format_elemcreate(etype, False, *args, **kw)

self.tk.call(self._name, "element", "create", elementname, etype,

spec, *opts)

def element_names(self):

"""Returns the list of elements defined in the current theme."""

return self.tk.splitlist(self.tk.call(self._name, "element", "names"))

def element_options(self, elementname):

"""Return the list of elementname's options."""

return self.tk.splitlist(self.tk.call(self._name, "element", "options", elementname))

def theme_create(self, themename, parent=None, settings=None):

"""Creates a new theme.

It is an error if themename already exists. If parent is

specified, the new theme will inherit styles, elements and

layouts from the specified parent theme. If settings are present,

they are expected to have the same syntax used for theme_settings."""

script = _script_from_settings(settings) if settings else ''

if parent:

self.tk.call(self._name, "theme", "create", themename,

"-parent", parent, "-settings", script)

else:

self.tk.call(self._name, "theme", "create", themename,

"-settings", script)

def theme_settings(self, themename, settings):

"""Temporarily sets the current theme to themename, apply specified

settings and then restore the previous theme.

Each key in settings is a style and each value may contain the

keys 'configure', 'map', 'layout' and 'element create' and they

are expected to have the same format as specified by the methods

configure, map, layout and element_create respectively."""

script = _script_from_settings(settings)

self.tk.call(self._name, "theme", "settings", themename, script)

def theme_names(self):

"""Returns a list of all known themes."""

return self.tk.splitlist(self.tk.call(self._name, "theme", "names"))

def theme_use(self, themename=None):

"""If themename is None, returns the theme in use, otherwise, set

the current theme to themename, refreshes all widgets and emits

a <<ThemeChanged>> event."""

if themename is None:

# Starting on Tk 8.6, checking this global is no longer needed

# since it allows doing self.tk.call(self._name, "theme", "use")

return self.tk.eval("return $ttk::currentTheme")

# using "ttk::setTheme" instead of "ttk::style theme use" causes

# the variable currentTheme to be updated, also, ttk::setTheme calls

# "ttk::style theme use" in order to change theme.

self.tk.call("ttk::setTheme", themename)

class Widget(tkinter.Widget):

"""Base class for Tk themed widgets."""

def __init__(self, master, widgetname, kw=None):

"""Constructs a Ttk Widget with the parent master.

STANDARD OPTIONS

class, cursor, takefocus, style

SCROLLABLE WIDGET OPTIONS

xscrollcommand, yscrollcommand

LABEL WIDGET OPTIONS

text, textvariable, underline, image, compound, width

WIDGET STATES

active, disabled, focus, pressed, selected, background,

readonly, alternate, invalid

"""

master = setup_master(master)

if not getattr(master, '_tile_loaded', False):

# Load tile now, if needed

_load_tile(master)

tkinter.Widget.__init__(self, master, widgetname, kw=kw)

def identify(self, x, y):

"""Returns the name of the element at position x, y, or the empty

string if the point does not lie within any element.

x and y are pixel coordinates relative to the widget."""

return self.tk.call(self._w, "identify", x, y)

def instate(self, statespec, callback=None, *args, **kw):

"""Test the widget's state.

If callback is not specified, returns True if the widget state

matches statespec and False otherwise. If callback is specified,

then it will be invoked with *args, **kw if the widget state

matches statespec. statespec is expected to be a sequence."""

ret = self.tk.getboolean(

self.tk.call(self._w, "instate", ' '.join(statespec)))

if ret and callback:

return callback(*args, **kw)

return bool(ret)

def state(self, statespec=None):

"""Modify or inquire widget state.

Widget state is returned if statespec is None, otherwise it is

set according to the statespec flags and then a new state spec

is returned indicating which flags were changed. statespec is

expected to be a sequence."""

if statespec is not None:

statespec = ' '.join(statespec)

return self.tk.splitlist(str(self.tk.call(self._w, "state", statespec)))

class Button(Widget):

"""Ttk Button widget, displays a textual label and/or image, and

evaluates a command when pressed."""

def __init__(self, master=None, **kw):

"""Construct a Ttk Button widget with the parent master.

STANDARD OPTIONS

class, compound, cursor, image, state, style, takefocus,

text, textvariable, underline, width

WIDGET-SPECIFIC OPTIONS

command, default, width

"""

Widget.__init__(self, master, "ttk::button", kw)

def invoke(self):

"""Invokes the command associated with the button."""

return self.tk.call(self._w, "invoke")

class Checkbutton(Widget):

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

def __init__(self, master=None, **kw):

"""Construct a Ttk Checkbutton widget with the parent master.

STANDARD OPTIONS

class, compound, cursor, image, state, style, takefocus,

text, textvariable, underline, width

WIDGET-SPECIFIC OPTIONS

command, offvalue, onvalue, variable

"""

Widget.__init__(self, master, "ttk::checkbutton", kw)

def invoke(self):

"""Toggles between the selected and deselected states and

invokes the associated command. If the widget is currently

selected, sets the option variable to the offvalue option

and deselects the widget; otherwise, sets the option variable

to the option onvalue.

Returns the result of the associated command."""

return self.tk.call(self._w, "invoke")

class Entry(Widget, tkinter.Entry):

"""Ttk Entry widget displays a one-line text string and allows that

string to be edited by the user."""

def __init__(self, master=None, widget=None, **kw):

"""Constructs a Ttk Entry widget with the parent master.

STANDARD OPTIONS

class, cursor, style, takefocus, xscrollcommand

WIDGET-SPECIFIC OPTIONS

exportselection, invalidcommand, justify, show, state,

textvariable, validate, validatecommand, width

VALIDATION MODES

none, key, focus, focusin, focusout, all

"""

Widget.__init__(self, master, widget or "ttk::entry", kw)

def bbox(self, index):

"""Return a tuple of (x, y, width, height) which describes the

bounding box of the character given by index."""

return self._getints(self.tk.call(self._w, "bbox", index))

def identify(self, x, y):

"""Returns the name of the element at position x, y, or the

empty string if the coordinates are outside the window."""

return self.tk.call(self._w, "identify", x, y)

def validate(self):

"""Force revalidation, independent of the conditions specified

by the validate option. Returns False if validation fails, True

if it succeeds. Sets or clears the invalid state accordingly."""

return bool(self.tk.getboolean(self.tk.call(self._w, "validate")))

class Combobox(Entry):

"""Ttk Combobox widget combines a text field with a pop-down list of

values."""

def __init__(self, master=None, **kw):

"""Construct a Ttk Combobox widget with the parent master.

STANDARD OPTIONS

class, cursor, style, takefocus

WIDGET-SPECIFIC OPTIONS

exportselection, justify, height, postcommand, state,

textvariable, values, width

"""

Entry.__init__(self, master, "ttk::combobox", **kw)

def current(self, newindex=None):

"""If newindex is supplied, sets the combobox value to the

element at position newindex in the list of values. Otherwise,

returns the index of the current value in the list of values

or -1 if the current value does not appear in the list."""

if newindex is None:

return self.tk.getint(self.tk.call(self._w, "current"))

return self.tk.call(self._w, "current", newindex)

def set(self, value):

"""Sets the value of the combobox to value."""

self.tk.call(self._w, "set", value)

class Frame(Widget):

"""Ttk Frame widget is a container, used to group other widgets

together."""

def __init__(self, master=None, **kw):

"""Construct a Ttk Frame with parent master.

STANDARD OPTIONS

class, cursor, style, takefocus

WIDGET-SPECIFIC OPTIONS

borderwidth, relief, padding, width, height

"""

Widget.__init__(self, master, "ttk::frame", kw)

class Label(Widget):

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

def __init__(self, master=None, **kw):

"""Construct a Ttk Label with parent master.

STANDARD OPTIONS

class, compound, cursor, image, style, takefocus, text,

textvariable, underline, width

WIDGET-SPECIFIC OPTIONS

anchor, background, font, foreground, justify, padding,

relief, text, wraplength

"""

Widget.__init__(self, master, "ttk::label", kw)

class Labelframe(Widget):

"""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."""

def __init__(self, master=None, **kw):

"""Construct a Ttk Labelframe with parent master.

STANDARD OPTIONS

class, cursor, style, takefocus

WIDGET-SPECIFIC OPTIONS

labelanchor, text, underline, padding, labelwidget, width,

height

"""

Widget.__init__(self, master, "ttk::labelframe", kw)

LabelFrame = Labelframe # tkinter name compatibility

class Menubutton(Widget):

"""Ttk Menubutton widget displays a textual label and/or image, and

displays a menu when pressed."""

def __init__(self, master=None, **kw):

"""Construct a Ttk Menubutton with parent master.

STANDARD OPTIONS

class, compound, cursor, image, state, style, takefocus,

text, textvariable, underline, width

WIDGET-SPECIFIC OPTIONS

direction, menu

"""

Widget.__init__(self, master, "ttk::menubutton", kw)

class Notebook(Widget):

"""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."""

def __init__(self, master=None, **kw):

"""Construct a Ttk Notebook with parent master.

STANDARD OPTIONS

class, cursor, style, takefocus

WIDGET-SPECIFIC OPTIONS

height, padding, width

TAB OPTIONS

state, sticky, padding, text, image, compound, underline

TAB IDENTIFIERS (tab_id)

The tab_id argument found in several methods may take any of

the following forms:

* An integer between zero and the number of tabs

* The name of a child window

* A positional specification of the form "@x,y", which

defines the tab

* The string "current", which identifies the

currently-selected tab

* The string "end", which returns the number of tabs (only

valid for method index)

"""

Widget.__init__(self, master, "ttk::notebook", kw)

def add(self, child, **kw):

"""Adds a new tab to the notebook.

If window is currently managed by the notebook but hidden, it is

restored to its previous position."""

self.tk.call(self._w, "add", child, *(_format_optdict(kw)))

def forget(self, tab_id):

"""Removes the tab specified by tab_id, unmaps and unmanages the

associated window."""

self.tk.call(self._w, "forget", tab_id)

def hide(self, tab_id):

"""Hides the tab specified by tab_id.

The tab will not be displayed, but the associated window remains

managed by the notebook and its configuration remembered. Hidden

tabs may be restored with the add command."""

self.tk.call(self._w, "hide", tab_id)

def identify(self, x, y):

"""Returns the name of the tab element at position x, y, or the

empty string if none."""

return self.tk.call(self._w, "identify", x, y)

def index(self, tab_id):

"""Returns the numeric index of the tab specified by tab_id, or

the total number of tabs if tab_id is the string "end"."""

return self.tk.getint(self.tk.call(self._w, "index", tab_id))

def insert(self, pos, child, **kw):

"""Inserts a pane at the specified position.

pos is either the string end, an integer index, or the name of

a managed child. If child is already managed by the notebook,

moves it to the specified position."""

self.tk.call(self._w, "insert", pos, child, *(_format_optdict(kw)))

def select(self, tab_id=None):

"""Selects the specified tab.

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."""

return self.tk.call(self._w, "select", tab_id)

def tab(self, tab_id, option=None, **kw):

"""Query or modify the options of the specific tab_id.

If kw is not given, returns a dict of the tab option values. If option

is specified, returns the value of that option. Otherwise, sets the

options to the corresponding values."""

if option is not None:

kw[option] = None

return _val_or_dict(kw, self.tk.call, self._w, "tab", tab_id)

def tabs(self):

"""Returns a list of windows managed by the notebook."""

return self.tk.splitlist(self.tk.call(self._w, "tabs") or ())

def enable_traversal(self):

"""Enable keyboard traversal for a toplevel window containing

this notebook.

This will extend the bindings for the toplevel window containing

this notebook as follows:

Control-Tab: selects the tab following the currently selected

one

Shift-Control-Tab: selects the tab preceding the currently

selected one

Alt-K: where K is the mnemonic (underlined) character of any

tab, will select that tab.

Multiple notebooks in a single toplevel may be enabled for

traversal, including nested notebooks. However, notebook traversal

only works properly if all panes are direct children of the

notebook."""

# The only, and good, difference I see is about mnemonics, which works

# after calling this method. Control-Tab and Shift-Control-Tab always

# works (here at least).

self.tk.call("ttk::notebook::enableTraversal", self._w)

class Panedwindow(Widget, tkinter.PanedWindow):

"""Ttk Panedwindow widget displays a number of subwindows, stacked

either vertically or horizontally."""

def __init__(self, master=None, **kw):

"""Construct a Ttk Panedwindow with parent master.

STANDARD OPTIONS

class, cursor, style, takefocus

WIDGET-SPECIFIC OPTIONS

orient, width, height

PANE OPTIONS

weight

"""

Widget.__init__(self, master, "ttk::panedwindow", kw)

forget = tkinter.PanedWindow.forget # overrides Pack.forget

def insert(self, pos, child, **kw):

"""Inserts a pane at the specified positions.

pos is either the string end, and integer index, or the name

of a child. If child is already managed by the paned window,

moves it to the specified position."""

self.tk.call(self._w, "insert", pos, child, *(_format_optdict(kw)))

def pane(self, pane, option=None, **kw):

"""Query or modify the options of the specified pane.

pane is either an integer index or the name of a managed subwindow.

If kw is not given, returns a dict of the pane option values. If

option is specified then the value for that option is returned.

Otherwise, sets the options to the corresponding values."""

if option is not None:

kw[option] = None

return _val_or_dict(kw, self.tk.call, self._w, "pane", pane)

def sashpos(self, index, newpos=None):

"""If newpos is specified, sets the position of sash number index.

May adjust the positions of adjacent sashes to ensure that

positions are monotonically increasing. Sash positions are further

constrained to be between 0 and the total size of the widget.

Returns the new position of sash number index."""

return self.tk.getint(self.tk.call(self._w, "sashpos", index, newpos))

PanedWindow = Panedwindow # tkinter name compatibility