Teek::Window Class

deiconify

Show the window (map it if withdrawn/iconified).

Returns void

View source ▼

def deiconify
  @app.tcl_invoke('wm', 'deiconify', @path)
end

geometry

Returns String — geometry string (e.g. "400x30000")

View source ▼

def geometry
  @app.tcl_invoke('wm', 'geometry', @path)
end

grab_release

Release a grab previously set with #grab_set. Safe to call even if the window never held the grab - Tk itself treats that as a no-op.

Returns void

View source ▼

def grab_release
  @app.tcl_invoke('grab', 'release', @path)
  nil
end

grab_set(global: false)

Set the input grab on the window - while held, mouse and keyboard events outside it (and its descendants) are redirected to it, the building block #modal uses. grab is its own Tcl command family, separate from wm.

Parameters

• global Boolean — a global grab blocks input to every other application too, not just this one - almost never what you want; local (the default) is scoped to this application.

Returns void

View source ▼

def grab_set(global: false)
  args = ['grab', 'set']
  args << '-global' if global
  args << @path
  @app.tcl_invoke(*args)
  nil
end

initialize(app, path)

Returns Window — a new instance of Window

@api private

View source ▼

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

modal(global: false)

Make the window modal: grabs input and sets focus on it immediately. Release it explicitly with #grab_release (typically from the window’s own dismiss/close handling) when the dialog is done - the grab is NOT released automatically just because this method returns, since a modal dialog is meant to stay grabbed for its whole visible lifetime, not just its setup.

Two safety nets guard against a stuck grab locking out the rest of the display: if the window is destroyed while still grabbed (a crash mid-modal, or just forgetting to call #grab_release first), a

Parameters

• global Boolean — see #grab_set

Returns void

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

settings = app.window(settings_path)
settings.modal { settings.deiconify }
# ... later, from the window's own on_close/dismiss handler ...
settings.grab_release

View source ▼

def modal(global: false)
  grab_set(global: global)
  # -force: a modal dialog should own keyboard focus immediately, not
  # merely be first in line whenever the app next happens to get it
  # (plain `focus` only takes effect once the app already has input
  # focus at the OS/WM level).
  @app.tcl_invoke('focus', '-force', @path)
  @app.bind(@path, 'Destroy') { grab_release }
  yield if block_given?
  nil
rescue
  grab_release
  raise
end

on_close(&block)

Register a handler for the window manager’s close button (WM_DELETE_WINDOW - the titlebar close box, Cmd-W, Alt-F4, etc., depending on platform).

Tk’s own default behavior (destroy the window) only applies when nothing else has claimed this protocol - setting a handler here replaces it, so the block is entirely responsible for deciding whether the window actually closes. Call App#destroy yourself if you want it to; do nothing (or show a confirmation first) if you don’t.

Returns void

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

# Confirm before quitting
app.window.on_close { app.destroy('.') if app.message_box(message: 'Quit?', type: :yesno) == :yes }

# A toplevel that just hides instead of closing
app.window(settings_window).on_close { app.window(settings_window).withdraw }

wm protocol |

View source ▼

def on_close(&block)
  cb = @app.register_callback(block, relay_break_continue: false)
  @app.callback_registry.reconcile([:wm_protocol, @path]) { |before| before.merge('WM_DELETE_WINDOW' => cb) }
  @app.tcl_eval("wm protocol #{@path} WM_DELETE_WINDOW {ruby_callback #{cb}}")
end

resizable

Returns Array(Boolean, Boolean) — [width_resizable, height_resizable]

View source ▼

def resizable
  parts = @app.tcl_invoke('wm', 'resizable', @path).split
  [@app.tcl_to_bool(parts[0]), @app.tcl_to_bool(parts[1])]
end

set_geometry(value)

Parameters

• value String — new geometry (e.g. "400x300", "400x30010050")

Returns String — the geometry

View source ▼

def set_geometry(value)
  @app.tcl_invoke('wm', 'geometry', @path, value.to_s)
end

set_resizable(width, height)

Parameters

• width Boolean — allow horizontal resize
• height Boolean — allow vertical resize

Returns void

View source ▼

def set_resizable(width, height)
  @app.tcl_invoke('wm', 'resizable', @path, @app.bool_to_tcl(width), @app.bool_to_tcl(height))
end

set_title(value)

Parameters

• value String — new title

Returns String — the title

View source ▼

def set_title(value)
  @app.tcl_invoke('wm', 'title', @path, value.to_s)
end

title

Returns String — the window's current title

View source ▼

def title
  @app.tcl_invoke('wm', 'title', @path)
end

to_s

Returns String — the Tk window path

View source ▼

def to_s
  @path
end

withdraw

Hide the window without destroying it.

Returns void

View source ▼

def withdraw
  @app.tcl_invoke('wm', 'withdraw', @path)
end