Teek API Documentation

Teek::Winfo Class

Thin, typed wrapper around Tk’s winfo command family - one method per subquery, coerced to the right Ruby type, reached via App#winfo.

Grouped behind a single accessor instead of a dozen-plus flat App methods, since winfo is itself one big, well-known Tcl command namespace - knowing Tcl’s winfo width gets you to #width directly. Every method accepts a path String or anything that responds to to_s with one (a Widget, for instance).

Inherits: Object

Instance Methods ↑

class_name(path)

Parameters
  • path String, Widget

Returns String — the Tk widget class (e.g. "TButton", "Frame")

View source ▼ 
def class_name(path)
  query('class', path)
end
GitHub

exists?(path)

Parameters
  • path String, Widget

Returns Boolean — whether a window currently exists at path

View source ▼ 
def exists?(path)
  query('exists', path) == '1'
end
GitHub

height(path)

Parameters
  • path String, Widget

Returns Integer — current height in pixels

View source ▼ 
def height(path)
  query('height', path).to_i
end
GitHub

initialize(app)

Returns Winfo — a new instance of Winfo

@api private

View source ▼ 
def initialize(app)
  @app = app
end
GitHub

ismapped?(path)

Parameters
  • path String, Widget

Returns Boolean — whether the window is currently mapped (actually displayed)

View source ▼ 
def ismapped?(path)
  query('ismapped', path) == '1'
end
GitHub

pointerx(path '.')

Parameters
  • path String, Widget — any window on the same screen (default: the root window)

Returns Integer — the mouse pointer's current x coordinate, in screen pixels

View source ▼ 
def pointerx(path = '.')
  query('pointerx', path).to_i
end
GitHub

pointery(path '.')

Parameters
  • path String, Widget — any window on the same screen (default: the root window)

Returns Integer — the mouse pointer's current y coordinate, in screen pixels

View source ▼ 
def pointery(path = '.')
  query('pointery', path).to_i
end
GitHub

reqheight(path)

Parameters
  • path String, Widget

Returns Integer — requested (natural) height in pixels

View source ▼ 
def reqheight(path)
  query('reqheight', path).to_i
end
GitHub

reqwidth(path)

Parameters
  • path String, Widget

Returns Integer — requested (natural) width in pixels

View source ▼ 
def reqwidth(path)
  query('reqwidth', path).to_i
end
GitHub

rootx(path)

Parameters
  • path String, Widget

Returns Integer — x coordinate of the window's top-left corner, in screen pixels

View source ▼ 
def rootx(path)
  query('rootx', path).to_i
end
GitHub

rooty(path)

Parameters
  • path String, Widget

Returns Integer — y coordinate of the window's top-left corner, in screen pixels

View source ▼ 
def rooty(path)
  query('rooty', path).to_i
end
GitHub

width(path)

Parameters
  • path String, Widget

Returns Integer — current width in pixels

View source ▼ 
def width(path)
  query('width', path).to_i
end
GitHub

x(path)

Parameters
  • path String, Widget

Returns Integer — x coordinate relative to the parent widget

View source ▼ 
def x(path)
  query('x', path).to_i
end
GitHub

y(path)

Parameters
  • path String, Widget

Returns Integer — y coordinate relative to the parent widget

View source ▼ 
def y(path)
  query('y', path).to_i
end
GitHub