Teek::Widget Class

bind(event, *subs, &block)

Bind an event on this widget.

Parameters

• event String — Tk event name
• subs Array<Symbol, String> — substitution codes

Returns void

@yield called when the event fires

View source ▼

def bind(event, *subs, &block)
  @app.bind(@path, event, *subs, &block)
end

command(*args, **kwargs)

Invoke a widget subcommand. Prepends the widget path as the Tcl command.

Parameters

• args — positional arguments
• kwargs — keyword arguments mapped to -key value pairs; any Proc value (e.g. command:) is tracked and released if reconfigured or when this widget is destroyed

Returns String — the Tcl result

btn.command(:configure, text: 'New')  # => .ttkbutton1 configure -text {New}
btn.command(:invoke)                  # => .ttkbutton1 invoke

View source ▼

def command(*args, **kwargs)
  @app.command(@path, *args, **kwargs)
end

destroy

Destroy this widget and all its children.

Returns void

View source ▼

def destroy
  @app.destroy(@path)
end

exist?

Check if this widget still exists in the Tk interpreter.

Returns Boolean

View source ▼

def exist?
  @app.winfo.exists?(@path)
end

grab_release

Release a grab previously set on this window. See Window#grab_release.

Returns void

View source ▼

def grab_release
  window.grab_release
end

grab_set(global: false)

Grab input on this window. See Window#grab_set.

Parameters

• global Boolean

Returns void

View source ▼

def grab_set(global: false)
  window.grab_set(global: global)
end

grid(**kwargs)

Grid this widget.

Parameters

• kwargs — options passed to the Tk grid command

Returns self

View source ▼

def grid(**kwargs)
  @app.command(:grid, @path, **kwargs)
  self
end

height

Returns Integer — current height in pixels

View source ▼

def height
  @app.winfo.height(@path)
end

initialize(app, path)

Returns Widget — a new instance of Widget

View source ▼

def initialize(app, path)
  @app = app
  @path = path
end

modal(global: false, &block)

Make this window modal. See Window#modal.

Parameters

• global Boolean

Returns void

@yield optional - runs with the grab and focus already set

View source ▼

def modal(global: false, &block)
  window.modal(global: global, &block)
end

on_close(&block)

Register a handler for this window’s close button (WM_DELETE_WINDOW). Meant for toplevels; see Window#on_close for the full behavior.

Returns void

@yield called when the window's close button is pressed

View source ▼

def on_close(&block)
  window.on_close(&block)
end

pack(**kwargs)

Pack this widget.

Parameters

• kwargs — options passed to the Tk pack command

Returns self

View source ▼

def pack(**kwargs)
  @app.command(:pack, @path, **kwargs)
  self
end

to_s

Returns String — the Tcl widget path

View source ▼

def to_s
  @path
end

unbind(event)

Remove an event binding from this widget.

Parameters

• event String — Tk event name

Returns void

View source ▼

def unbind(event)
  @app.unbind(@path, event)
end

width

Returns Integer — current width in pixels

View source ▼

def width
  @app.winfo.width(@path)
end

window

This widget as a Window - the window-scoped counterpart covering wm subcommands and composite behaviors (on_close, grab_set/ grab_release, modal). Meant for toplevels.

Returns Window

View source ▼

def window
  @app.window(@path)
end