cpython/Lib/tkinter/__init__.py at main · python/cpython · GitHub

Repository navigation

History

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

"""Wrapper functions for Tcl/Tk.

Tkinter provides classes which allow the display, positioning and

control of widgets. Toplevel widgets are Tk and Toplevel. Other

widgets are Frame, Label, Entry, Text, Canvas, Button, Radiobutton,

Checkbutton, Scale, Listbox, Scrollbar, OptionMenu, Spinbox,

LabelFrame and PanedWindow.

Properties of the widgets are specified with keyword arguments.

Keyword arguments have the same name as the corresponding options

under Tk.

Widgets are positioned with one of the geometry managers Place, Pack

or Grid. These managers can be called with methods place, pack, grid

available in every Widget.

Actions are bound to events by options (e.g. the command

keyword argument) or with the bind() method.

Example (Hello, World):

import tkinter

from tkinter.constants import *

tk = tkinter.Tk()

frame = tkinter.Frame(tk, relief=RIDGE, borderwidth=2)

frame.pack(fill=BOTH, expand=1)

label = tkinter.Label(frame, text="Hello, World")

label.pack(fill=X, expand=1)

button = tkinter.Button(frame, text="Exit", command=tk.destroy)

button.pack(side=BOTTOM)

tk.mainloop()

"""

import collections

import enum

import sys

import types

import _tkinter # If this fails your Python may not be configured for Tk

TclError = _tkinter.TclError

from tkinter.constants import *

import re

wantobjects = 1

_debug = False # set to True to print executed Tcl/Tk commands

TkVersion = float(_tkinter.TK_VERSION)

TclVersion = float(_tkinter.TCL_VERSION)

READABLE = _tkinter.READABLE

WRITABLE = _tkinter.WRITABLE

EXCEPTION = _tkinter.EXCEPTION

_magic_re = re.compile(r'([\\{}])')

_space_re = re.compile(r'([\s])', re.ASCII)

def _join(value):

"""Internal function."""

return ' '.join(map(_stringify, value))

def _stringify(value):

"""Internal function."""

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

if len(value) == 1:

value = _stringify(value[0])

if _magic_re.search(value):

value = '{%s}' % value

else:

value = '{%s}' % _join(value)

else:

if isinstance(value, bytes):

value = str(value, 'latin1')

else:

value = str(value)

if not value:

value = '{}'

elif _magic_re.search(value):

# add '\' before special characters and spaces

value = _magic_re.sub(r'\\\1', value)

value = value.replace('\n', r'\n')

value = _space_re.sub(r'\\\1', value)

if value[0] == '"':

value = '\\' + value

elif value[0] == '"' or _space_re.search(value):

value = '{%s}' % value

return value

def _flatten(seq):

"""Internal function."""

res = ()

for item in seq:

if isinstance(item, (tuple, list)):

res = res + _flatten(item)

elif item is not None:

res = res + (item,)

return res

try: _flatten = _tkinter._flatten

except AttributeError: pass

def _cnfmerge(cnfs):

"""Internal function."""

if isinstance(cnfs, dict):

return cnfs

elif isinstance(cnfs, (type(None), str)):

return cnfs

else:

cnf = {}

for c in _flatten(cnfs):

try:

cnf.update(c)

except (AttributeError, TypeError) as msg:

print("_cnfmerge: fallback due to:", msg)

for k, v in c.items():

cnf[k] = v

return cnf

try: _cnfmerge = _tkinter._cnfmerge

except AttributeError: pass

def _splitdict(tk, v, cut_minus=True, conv=None):

"""Return a properly formatted dict built from Tcl list pairs.

If cut_minus is True, the supposed '-' prefix will be removed from

keys. If conv is specified, it is used to convert values.

Tcl list is expected to contain an even number of elements.

"""

t = tk.splitlist(v)

if len(t) % 2:

raise RuntimeError('Tcl list representing a dict is expected '

'to contain an even number of elements')

it = iter(t)

dict = {}

for key, value in zip(it, it):

key = str(key)

if cut_minus and key[0] == '-':

key = key[1:]

if conv:

value = conv(value)

dict[key] = value

return dict

class _VersionInfoType(collections.namedtuple('_VersionInfoType',

('major', 'minor', 'micro', 'releaselevel', 'serial'))):

def __str__(self):

if self.releaselevel == 'final':

return f'{self.major}.{self.minor}.{self.micro}'

else:

return f'{self.major}.{self.minor}{self.releaselevel[0]}{self.serial}'

def _parse_version(version):

import re

m = re.fullmatch(r'(\d+)\.(\d+)([ab.])(\d+)', version)

major, minor, releaselevel, serial = m.groups()

major, minor, serial = int(major), int(minor), int(serial)

if releaselevel == '.':

micro = serial

serial = 0

releaselevel = 'final'

else:

micro = 0

releaselevel = {'a': 'alpha', 'b': 'beta'}[releaselevel]

return _VersionInfoType(major, minor, micro, releaselevel, serial)

TCL_VERSION_INFO = _parse_version(_tkinter.TCL_PATCH_LEVEL)

TK_VERSION_INFO = _parse_version(_tkinter.TK_PATCH_LEVEL)

@enum._simple_enum(enum.StrEnum)

class EventType:

KeyPress = '2'

Key = KeyPress

KeyRelease = '3'

ButtonPress = '4'

Button = ButtonPress

ButtonRelease = '5'

Motion = '6'

Enter = '7'

Leave = '8'

FocusIn = '9'

FocusOut = '10'

Keymap = '11' # undocumented

Expose = '12'

GraphicsExpose = '13' # undocumented

NoExpose = '14' # undocumented

Visibility = '15'

Create = '16'

Destroy = '17'

Unmap = '18'

Map = '19'

MapRequest = '20'

Reparent = '21'

Configure = '22'

ConfigureRequest = '23'

Gravity = '24'

ResizeRequest = '25'

Circulate = '26'

CirculateRequest = '27'

Property = '28'

SelectionClear = '29' # undocumented

SelectionRequest = '30' # undocumented

Selection = '31' # undocumented

Colormap = '32'

ClientMessage = '33' # undocumented

Mapping = '34' # undocumented

VirtualEvent = '35' # undocumented

Activate = '36'

Deactivate = '37'

MouseWheel = '38'

class Event:

"""Container for the properties of an event.

Instances of this type are generated if one of the following events occurs:

KeyPress, KeyRelease - for keyboard events

ButtonPress, ButtonRelease, Motion, Enter, Leave, MouseWheel - for mouse events

Visibility, Unmap, Map, Expose, FocusIn, FocusOut, Circulate,

Colormap, Gravity, Reparent, Property, Destroy, Activate,

Deactivate - for window events.

If a callback function for one of these events is registered

using bind, bind_all, bind_class, or tag_bind, the callback is

called with an Event as first argument. It will have the

following attributes (in braces are the event types for which

the attribute is valid):

serial - serial number of event

num - mouse button pressed (ButtonPress, ButtonRelease)

focus - whether the window has the focus (Enter, Leave)

height - height of the exposed window (Configure, Expose)

width - width of the exposed window (Configure, Expose)

keycode - keycode of the pressed key (KeyPress, KeyRelease)

state - state of the event as a number (ButtonPress, ButtonRelease,

Enter, KeyPress, KeyRelease,

Leave, Motion)

state - state as a string (Visibility)

time - when the event occurred

x - x-position of the mouse

y - y-position of the mouse

x_root - x-position of the mouse on the screen

(ButtonPress, ButtonRelease, KeyPress, KeyRelease, Motion)

y_root - y-position of the mouse on the screen

(ButtonPress, ButtonRelease, KeyPress, KeyRelease, Motion)

char - pressed character (KeyPress, KeyRelease)

send_event - see X/Windows documentation

keysym - keysym of the event as a string (KeyPress, KeyRelease)

keysym_num - keysym of the event as a number (KeyPress, KeyRelease)

type - type of the event as a number

widget - widget in which the event occurred

delta - delta of wheel movement (MouseWheel)

detail - certain fixed strings (see Tcl/Tk documentation)

(Enter, Leave, FocusIn, FocusOut, ConfigureRequest)

user_data - data string which was passed to event_generate() or empty

string (VirtualEvent)

"""

def __repr__(self):

attrs = {k: v for k, v in self.__dict__.items() if v != '??'}

if not self.char:

del attrs['char']

elif self.char != '??':

attrs['char'] = repr(self.char)

if not getattr(self, 'send_event', True):

del attrs['send_event']

if self.state == 0:

del attrs['state']

elif isinstance(self.state, int):

state = self.state

mods = ('Shift', 'Lock', 'Control',

'Mod1', 'Mod2', 'Mod3', 'Mod4', 'Mod5',

'Button1', 'Button2', 'Button3', 'Button4', 'Button5')

s = []

for i, n in enumerate(mods):

if state & (1 << i):

s.append(n)

state = state & ~((1<< len(mods)) - 1)

if state or not s:

s.append(hex(state))

attrs['state'] = '|'.join(s)

if self.delta == 0:

del attrs['delta']

# widget usually is known

# serial and time are not very interesting

# keysym_num duplicates keysym

# x_root and y_root mostly duplicate x and y

keys = ('send_event',

'state', 'keysym', 'keycode', 'char',

'num', 'delta', 'focus',

'x', 'y', 'width', 'height')

return '<%s event%s>' % (

getattr(self.type, 'name', self.type),

''.join(' %s=%s' % (k, attrs[k]) for k in keys if k in attrs)

)

__class_getitem__ = classmethod(types.GenericAlias)

_support_default_root = True

_default_root = None

def NoDefaultRoot():

"""Inhibit setting of default root window.

Call this function to inhibit that the first instance of

Tk is used for windows without an explicit parent window.

"""

global _support_default_root, _default_root

_support_default_root = False

# Delete, so any use of _default_root will immediately raise an exception.

# Rebind before deletion, so repeated calls will not fail.

_default_root = None

del _default_root

def _get_default_root(what=None):

if not _support_default_root:

raise RuntimeError("No master specified and tkinter is "

"configured to not support default root")

if _default_root is None:

if what:

raise RuntimeError(f"Too early to {what}: no default root window")

root = Tk()

assert _default_root is root

return _default_root

def _get_temp_root():

global _support_default_root

if not _support_default_root:

raise RuntimeError("No master specified and tkinter is "

"configured to not support default root")

root = _default_root

if root is None:

assert _support_default_root

_support_default_root = False

root = Tk()

_support_default_root = True

assert _default_root is None

root.withdraw()

root._temporary = True

return root

def _destroy_temp_root(master):

if getattr(master, '_temporary', False):

try:

master.destroy()

except TclError:

pass

def _tkerror(err):

"""Internal function."""

pass

def _exit(code=0):

"""Internal function. Calling it will raise the exception SystemExit."""

try:

code = int(code)

except ValueError:

pass

raise SystemExit(code)

_varnum = 0

class Variable:

"""Class to define value holders for e.g. buttons.

Subclasses StringVar, IntVar, DoubleVar, BooleanVar are specializations

that constrain the type of the value returned from get()."""

_default = ""

_tk = None

_tclCommands = None

def __init__(self, master=None, value=None, name=None):

"""Construct a variable

MASTER can be given as master widget.

VALUE is an optional value (defaults to "")

NAME is an optional Tcl name (defaults to PY_VARnum).

If NAME matches an existing variable and VALUE is omitted

then the existing value is retained.

"""

# check for type of NAME parameter to override weird error message

# raised from Modules/_tkinter.c:SetVar like:

# TypeError: setvar() takes exactly 3 arguments (2 given)

if name is not None and not isinstance(name, str):

raise TypeError("name must be a string")

global _varnum

if master is None:

master = _get_default_root('create variable')

self._root = master._root()

self._tk = master.tk

if name:

self._name = name

else:

self._name = 'PY_VAR' + repr(_varnum)

_varnum += 1

if value is not None:

self.initialize(value)

elif not self._tk.getboolean(self._tk.call("info", "exists", self._name)):

self.initialize(self._default)

def __del__(self):

"""Unset the variable in Tcl."""

if self._tk is None:

return

if self._tk.getboolean(self._tk.call("info", "exists", self._name)):

self._tk.globalunsetvar(self._name)

if self._tclCommands is not None:

for name in self._tclCommands:

self._tk.deletecommand(name)

self._tclCommands = None

def __str__(self):

"""Return the name of the variable in Tcl."""

return self._name

def set(self, value):

"""Set the variable to VALUE."""

return self._tk.globalsetvar(self._name, value)

initialize = set

def get(self):

"""Return value of variable."""

return self._tk.globalgetvar(self._name)

def _register(self, callback):

f = CallWrapper(callback, None, self._root).__call__

cbname = repr(id(f))

try:

callback = callback.__func__

except AttributeError:

pass

try:

cbname = cbname + callback.__name__

except AttributeError:

pass

self._tk.createcommand(cbname, f)

if self._tclCommands is None:

self._tclCommands = []

self._tclCommands.append(cbname)

return cbname

def trace_add(self, mode, callback):

"""Define a trace callback for the variable.

Mode is one of "read", "write", "unset", or a list or tuple of

such strings.

Callback must be a function which is called when the variable is

read, written or unset.

Return the name of the callback.

"""

cbname = self._register(callback)

self._tk.call('trace', 'add', 'variable',

self._name, mode, (cbname,))

return cbname

def trace_remove(self, mode, cbname):

"""Delete the trace callback for a variable.

Mode is one of "read", "write", "unset" or a list or tuple of

such strings. Must be same as were specified in trace_add().

cbname is the name of the callback returned from trace_add().

"""

self._tk.call('trace', 'remove', 'variable',

self._name, mode, cbname)

for m, ca in self.trace_info():

if self._tk.splitlist(ca)[0] == cbname:

break

else:

self._tk.deletecommand(cbname)

try:

self._tclCommands.remove(cbname)

except ValueError:

pass

def trace_info(self):

"""Return all trace callback information."""

splitlist = self._tk.splitlist

return [(splitlist(k), v) for k, v in map(splitlist,

splitlist(self._tk.call('trace', 'info', 'variable', self._name)))]

def trace_variable(self, mode, callback):

"""Define a trace callback for the variable.

MODE is one of "r", "w", "u" for read, write, undefine.

CALLBACK must be a function which is called when

the variable is read, written or undefined.

Return the name of the callback.

This deprecated method wraps a deprecated Tcl method removed

in Tcl 9.0 and will be removed in Python 3.17. Use trace_add()

instead.

"""

import warnings

warnings.warn(

"trace_variable() is deprecated and will be removed in Python "

"3.17; use trace_add() instead. It is not supported with "

"Tcl 9.",

DeprecationWarning, stacklevel=2)

cbname = self._register(callback)

self._tk.call("trace", "variable", self._name, mode, cbname)

return cbname

trace = trace_variable

def trace_vdelete(self, mode, cbname):

"""Delete the trace callback for a variable.

MODE is one of "r", "w", "u" for read, write, undefine.

CBNAME is the name of the callback returned from trace_variable or trace.

This deprecated method wraps a deprecated Tcl method removed

in Tcl 9.0 and will be removed in Python 3.17. Use trace_remove()

instead.

"""

import warnings

warnings.warn(

"trace_vdelete() is deprecated and will be removed in Python "

"3.17; use trace_remove() instead. It is not supported with "

"Tcl 9.",

DeprecationWarning, stacklevel=2)

self._tk.call("trace", "vdelete", self._name, mode, cbname)

cbname = self._tk.splitlist(cbname)[0]

for m, ca in self.trace_info():

if self._tk.splitlist(ca)[0] == cbname:

break

else:

self._tk.deletecommand(cbname)

try:

self._tclCommands.remove(cbname)

except ValueError:

pass

def trace_vinfo(self):

"""Return all trace callback information.

This deprecated method wraps a deprecated Tcl method removed

in Tcl 9.0 and will be removed in Python 3.17. Use trace_info()

instead.

"""

import warnings

warnings.warn(

"trace_vinfo() is deprecated and will be removed in Python "

"3.17; use trace_info() instead. It is not supported with "

"Tcl 9.",

DeprecationWarning, stacklevel=2)

return [self._tk.splitlist(x) for x in self._tk.splitlist(

self._tk.call("trace", "vinfo", self._name))]

def __eq__(self, other):

if not isinstance(other, Variable):

return NotImplemented

return (self._name == other._name

and self.__class__.__name__ == other.__class__.__name__

and self._tk == other._tk)

class StringVar(Variable):

"""Value holder for strings variables."""

_default = ""

def __init__(self, master=None, value=None, name=None):

"""Construct a string variable.

MASTER can be given as master widget.

VALUE is an optional value (defaults to "")

NAME is an optional Tcl name (defaults to PY_VARnum).

If NAME matches an existing variable and VALUE is omitted

then the existing value is retained.

"""

Variable.__init__(self, master, value, name)

def get(self):

"""Return value of variable as string."""

value = self._tk.globalgetvar(self._name)

if isinstance(value, str):

return value

return str(value)

class IntVar(Variable):

"""Value holder for integer variables."""

_default = 0

def __init__(self, master=None, value=None, name=None):

"""Construct an integer variable.

MASTER can be given as master widget.

VALUE is an optional value (defaults to 0)

NAME is an optional Tcl name (defaults to PY_VARnum).

If NAME matches an existing variable and VALUE is omitted

then the existing value is retained.

"""

Variable.__init__(self, master, value, name)

def get(self):

"""Return the value of the variable as an integer."""

value = self._tk.globalgetvar(self._name)

try:

return self._tk.getint(value)

except (TypeError, TclError):

return int(self._tk.getdouble(value))

class DoubleVar(Variable):

"""Value holder for float variables."""

_default = 0.0

def __init__(self, master=None, value=None, name=None):

"""Construct a float variable.

MASTER can be given as master widget.

VALUE is an optional value (defaults to 0.0)

NAME is an optional Tcl name (defaults to PY_VARnum).

If NAME matches an existing variable and VALUE is omitted

then the existing value is retained.

"""

Variable.__init__(self, master, value, name)

def get(self):

"""Return the value of the variable as a float."""

return self._tk.getdouble(self._tk.globalgetvar(self._name))

class BooleanVar(Variable):

"""Value holder for boolean variables."""

_default = False

def __init__(self, master=None, value=None, name=None):

"""Construct a boolean variable.

MASTER can be given as master widget.

VALUE is an optional value (defaults to False)

NAME is an optional Tcl name (defaults to PY_VARnum).

If NAME matches an existing variable and VALUE is omitted

then the existing value is retained.

"""

Variable.__init__(self, master, value, name)

def set(self, value):

"""Set the variable to VALUE."""

return self._tk.globalsetvar(self._name, self._tk.getboolean(value))

initialize = set

def get(self):

"""Return the value of the variable as a bool."""

try:

return self._tk.getboolean(self._tk.globalgetvar(self._name))

except TclError:

raise ValueError("invalid literal for getboolean()")

def mainloop(n=0):

"""Run the main loop of Tcl."""

_get_default_root('run the main loop').tk.mainloop(n)

getint = int

getdouble = float

def getboolean(s):

"""Convert Tcl object to True or False."""

try:

return _get_default_root('use getboolean()').tk.getboolean(s)

except TclError:

raise ValueError("invalid literal for getboolean()")

# Methods defined on both toplevel and interior widgets

class Misc:

"""Internal class.

Base class which defines methods common for interior widgets."""

# used for generating child widget names

_last_child_ids = None

# XXX font command?

_tclCommands = None

def destroy(self):

"""Internal function.

Delete all Tcl commands created for

this widget in the Tcl interpreter."""

if self._tclCommands is not None:

for name in self._tclCommands:

self.tk.deletecommand(name)

self._tclCommands = None

def deletecommand(self, name):

"""Internal function.

Delete the Tcl command provided in NAME."""

self.tk.deletecommand(name)

try:

self._tclCommands.remove(name)

except ValueError:

pass

def tk_strictMotif(self, boolean=None):

"""Set Tcl internal variable, whether the look and feel

should adhere to Motif.

A parameter of 1 means adhere to Motif (e.g. no color

change if mouse passes over slider).

Returns the set value."""

return self.tk.getboolean(self.tk.call(

'set', 'tk_strictMotif', boolean))

def tk_bisque(self):

"""Change the color scheme to light brown as used in Tk 3.6 and before."""

self.tk.call('tk_bisque')

def tk_setPalette(self, *args, **kw):

"""Set a new color scheme for all widget elements.

A single color as argument will cause that all colors of Tk

widget elements are derived from this.

Alternatively several keyword parameters and its associated

colors can be given. The following keywords are valid:

activeBackground, foreground, selectColor,

activeForeground, highlightBackground, selectBackground,

background, highlightColor, selectForeground,

disabledForeground, insertBackground, troughColor."""

self.tk.call(('tk_setPalette',)

+ _flatten(args) + _flatten(list(kw.items())))

def tk_appname(self, name=None):

"""Query or set the name used to communicate with this application

through the send command.

With no argument, return the current name; otherwise change it to NAME

and return the actual name set (which may have a suffix appended to

keep it unique)."""

if name is None:

return self.tk.call('tk', 'appname')

return self.tk.call('tk', 'appname', name)

def tk_useinputmethods(self, boolean=None, *, displayof=0):

"""Query or set whether Tk uses the X Input Methods (XIM) for filtering

events, and return the resulting state.

This is significant only on X11; if XIM support is not available it

always returns False."""

args = ('tk', 'useinputmethods') + self._displayof(displayof)

if boolean is not None:

args += (boolean,)

return self.tk.getboolean(self.tk.call(args))

def tk_caret(self, *, x=None, y=None, height=None):

"""Set or query the caret location for this widget's display.

The caret is the per-display insertion position used for global focus

indication (for accessibility) and for placing the input method

(XIM or IME) window. With no argument, return the current location as

a dictionary with keys 'x', 'y' and 'height'; otherwise update the

given coordinates."""

args = ('tk', 'caret', self._w)

for option, value in (('-x', x), ('-y', y), ('-height', height)):

if value is not None:

args += (option, value)

if len(args) > 3:

self.tk.call(args)

else:

values = self.tk.splitlist(self.tk.call(args))

return {values[i][1:]: self.tk.getint(values[i + 1])

for i in range(0, len(values), 2)}

def tk_scaling(self, number=None, *, displayof=0):

"""Query or set the scaling factor used by Tk to convert between

physical units and pixels.

The scaling factor is the number of pixels per point on the display,

where a point is 1/72 inch. With no argument, return the current

factor; otherwise set it to the floating-point NUMBER."""

args = ('tk', 'scaling') + self._displayof(displayof)

if number is not None:

self.tk.call(args + (number,))

else:

return self.tk.getdouble(self.tk.call(args))

def tk_inactive(self, reset=False, *, displayof=0):

"""Return the number of milliseconds since the last time the user

interacted with the system, or -1 if the windowing system does not

support this.

If RESET is true, reset the inactivity timer to zero instead and

return None."""

args = ('tk', 'inactive') + self._displayof(displayof)

if reset:

self.tk.call(args + ('reset',))

else:

return self.tk.getint(self.tk.call(args))

def wait_variable(self, name):

"""Wait until the variable is modified.

A parameter of type IntVar, StringVar, DoubleVar or

BooleanVar must be given."""

self.tk.call('tkwait', 'variable', name)

waitvar = wait_variable # XXX b/w compat

def wait_window(self, window=None):

"""Wait until a WIDGET is destroyed.

If no parameter is given self is used."""

if window is None:

window = self

self.tk.call('tkwait', 'window', window._w)

def wait_visibility(self, window=None):

"""Wait until the visibility of a WIDGET changes

(e.g. it appears).

If no parameter is given self is used."""

if window is None:

window = self

self.tk.call('tkwait', 'visibility', window._w)

def setvar(self, name, value):

"""Set Tcl variable NAME to VALUE."""

self.tk.setvar(name, value)

def getvar(self, name):

"""Return value of Tcl variable NAME."""

return self.tk.getvar(name)

def getint(self, s):

try:

return self.tk.getint(s)

except TclError as exc:

raise ValueError(str(exc))

def getdouble(self, s):

try:

return self.tk.getdouble(s)

except TclError as exc:

raise ValueError(str(exc))

def getboolean(self, s):

"""Return a boolean value for Tcl boolean values true and false given as parameter."""

try:

return self.tk.getboolean(s)

except TclError:

raise ValueError("invalid literal for getboolean()")

def focus_set(self):

"""Direct input focus to this widget.

If the application currently does not have the focus

this widget will get the focus if the application gets

the focus through the window manager."""

self.tk.call('focus', self._w)

focus = focus_set # XXX b/w compat?

def focus_force(self):

"""Direct input focus to this widget even if the

application does not have the focus. Use with

caution!"""

self.tk.call('focus', '-force', self._w)

def focus_get(self):

"""Return the widget which has currently the focus in the

application.

Use focus_displayof to allow working with several

displays. Return None if application does not have

the focus."""

name = self.tk.call('focus')

if name == 'none' or not name: return None

try:

return self._nametowidget(name)

except KeyError:

return None

def focus_displayof(self):

"""Return the widget which has currently the focus on the

display where this widget is located.

Return None if the application does not have the focus."""

name = self.tk.call('focus', '-displayof', self._w)

if name == 'none' or not name: return None

try:

return self._nametowidget(name)

except KeyError:

return None

def focus_lastfor(self):

"""Return the widget which would have the focus if top level

for this widget gets the focus from the window manager."""

name = self.tk.call('focus', '-lastfor', self._w)

if name == 'none' or not name: return None

try:

return self._nametowidget(name)

except KeyError:

return None

def tk_focusFollowsMouse(self):

"""The widget under mouse will get automatically focus. Can not

be disabled easily."""

self.tk.call('tk_focusFollowsMouse')

def tk_focusNext(self):

"""Return the next widget in the focus order which follows

widget which has currently the focus.

The focus order first goes to the next child, then to

the children of the child recursively and then to the

next sibling which is higher in the stacking order. A

widget is omitted if it has the takefocus option set

to 0."""

name = self.tk.call('tk_focusNext', self._w)

if not name: return None

return self._nametowidget(name)

def tk_focusPrev(self):

"""Return previous widget in the focus order. See tk_focusNext for details."""

name = self.tk.call('tk_focusPrev', self._w)

if not name: return None

return self._nametowidget(name)

def after(self, ms, func=None, *args, **kw):

"""Call function once after given time.

MS specifies the time in milliseconds. FUNC gives the

function which shall be called. Additional parameters

are given as parameters to the function call. Return

identifier to cancel scheduling with after_cancel."""

if func is None:

# I'd rather use time.sleep(ms*0.001)

self.tk.call('after', ms)

return None

else:

def callit():

try:

func(*args, **kw)

finally:

try:

self.deletecommand(name)

except TclError:

pass

try:

callit.__name__ = func.__name__

except AttributeError:

# Required for callable classes (bpo-44404)

callit.__name__ = type(func).__name__

name = self._register(callit)

return self.tk.call('after', ms, name)

def after_idle(self, func, *args, **kw):

"""Call FUNC once if the Tcl main loop has no event to

process.

Return an identifier to cancel the scheduling with

after_cancel."""

return self.after('idle', func, *args, **kw)

def after_cancel(self, id):

"""Cancel scheduling of function identified with ID.

Identifier returned by after or after_idle must be

given as first parameter.

"""

if not id:

raise ValueError('id must be a valid identifier returned from '

'after or after_idle')

try:

data = self.tk.call('after', 'info', id)

script = self.tk.splitlist(data)[0]

self.deletecommand(script)

except TclError:

View remainder of file in raw view

cpython/Lib/tkinter/init.py at main · python/cpython · GitHub

Navigation Menu

Repository navigation

init.py

init.py

cpython/Lib/tkinter/__init__.py at main · python/cpython · GitHub

Navigation Menu

Repository navigation

Expand file tree

Breadcrumbs

__init__.py

Latest commit

History

Breadcrumbs

__init__.py

File metadata and controls

Footer

Footer navigation

cpython/Lib/tkinter/init.py at main · python/cpython · GitHub

init.py

init.py