module Tk::Winfo
Public Instance Methods
Returns a decimal string giving the integer identifier for the atom whose name is name
. If no atom exists with the name
then a new one is created. If window
is given then the atom is looked up on the display of window
; otherwise it is looked up on the display of the application's main window.
# File lib/ffi-tk/command/winfo.rb, line 257 def atom(name, window = None) if None == window Tk.execute(:winfo, :atom, name) else Tk.execute(:winfo, :atom, '-displayof', window, name) end end
Returns the textual name for the atom whose integer identifier is id
. If window
is given then the identifier is looked up on the display of window
; otherwise it is looked up on the display of the application's main window. This command is the inverse of the [atom] method. It generates an error if no such atom exists.
# File lib/ffi-tk/command/winfo.rb, line 271 def atomname(id, window = None) if None == window Tk.execute(:winfo, :atomname, id).to_s else Tk.execute(:winfo, :atomname, '-displayof', window, id).to_s end end
Returns a decimal string giving the number of cells in the color map for window.
# File lib/ffi-tk/command/winfo.rb, line 281 def cells(window) Tk.execute(:winfo, :cells, window) end
Returns a list containing the path names of all the children of window. Top-level windows are returned as children of their logical parents. The list is in stacking order, with the lowest window first, except for Top-level windows which are not returned in stacking order. Use the wm stackorder command to query the stacking order of Top-level windows.
# File lib/ffi-tk/command/winfo.rb, line 291 def children(window) Tk.execute(:winfo, :children, window).to_a end
Returns the class name for window.
Note: this shadows the class method, so we call it class_name.
# File lib/ffi-tk/command/winfo.rb, line 298 def class_name(window) Tk.execute(:winfo, :class, window).to_s end
Returns true if the colormap for window is known to be full, false otherwise. The colormap for a window is “known” to be full if the last attempt to allocate a new color on that window failed and this application has not freed any colors in the colormap since the failed allocation.
# File lib/ffi-tk/command/winfo.rb, line 307 def colormapfull(window) Tk.execute(:winfo, :colormapfull, window).to_boolean end
Returns the path name for the window containing the point given by root_x
and root_y
. root_x
and root_y
are specified in screen units (i.e. any form acceptable to Tk_GetPixels) in the coordinate system of the root window (if a virtual-root window manager is in use then the coordinate system of the virtual root window is used). If window
is given then the coordinates refer to the screen containing window; otherwise they refer to the screen of the application's main window. If no window in this application contains the point then nil is returned. In selecting the containing window, children are given higher priority than parents and among siblings the highest one in the stacking order is chosen.
# File lib/ffi-tk/command/winfo.rb, line 324 def containing(root_x, root_y, window = None) if None == window Tk.execute(:winfo, :containing, root_x, root_y).to_s? else Tk.execute(:winfo, :containing, '-displayof', window, root_x, root_y) end end
Returns a decimal string giving the depth of window (number of bits per pixel).
# File lib/ffi-tk/command/winfo.rb, line 334 def depth(window) Tk.execute(:winfo, :depth, window) end
Returns true if there exists a window named window, false if no such window exists.
# File lib/ffi-tk/command/winfo.rb, line 340 def exists(window) Tk.execute(:winfo, :exists, window).to_boolean end
Returns a floating-point value giving the number of pixels in window corresponding to the distance given by number. Number may be specified in any of the forms acceptable to Tk_GetScreenMM, such as “2.0c” or “1i”. The return value may be fractional; for an integer value, use winfo pixels.
# File lib/ffi-tk/command/winfo.rb, line 350 def fpixels(window, number) Tk.execute(:winfo, :fpixels, window, number) end
Returns the geometry for window, in the form widthxheight+x+y. All dimensions are in pixels.
# File lib/ffi-tk/command/winfo.rb, line 356 def geometry(window) TkGeometry.new(Tk.execute(:winfo, :geometry, window)) end
Returns a decimal string giving window's height in pixels. When a window is first created its height will be 1 pixel; the height will eventually be changed by a geometry manager to fulfill the window's needs. If you need the true height immediately after creating a widget, invoke update to force the geometry manager to arrange it, or use winfo reqheight to get the window's requested height instead of its actual height.
# File lib/ffi-tk/command/winfo.rb, line 367 def height(window) Tk.execute(:winfo, :height, window) end
Returns a hexadecimal string giving a low-level platform-specific identifier for window. On Unix platforms, this is the X window identifier. Under Windows, this is the Windows HWND. On the Macintosh the value has no meaning outside Tk
.
# File lib/ffi-tk/command/winfo.rb, line 376 def id(window) Tk.execute(:winfo, :id, window).to_s end
Returns a list whose members are the names of all Tcl interpreters (e.g. all Tk-based applications) currently registered for a particular display. If the -displayof option is given then the return value refers to the display of window; otherwise it refers to the display of the application's main window.
# File lib/ffi-tk/command/winfo.rb, line 385 def interps(window = None) if None == window Tk.execute(:winfo, :interps).to_a else Tk.execute(:winfo, :interps, '-displayof', window).to_a end end
Returns true if window is currently mapped, false otherwise.
# File lib/ffi-tk/command/winfo.rb, line 394 def ismapped(window) Tk.execute(:winfo, :ismapped, window).to_boolean end
Returns the name of the geometry manager currently responsible for window, or an empty string if window is not managed by any geometry manager. The name is usually the name of the Tcl command for the geometry manager, such as pack or place. If the geometry manager is a widget, such as canvases or text, the name is the widget's class command, such as canvas.
# File lib/ffi-tk/command/winfo.rb, line 404 def manager(window) Tk.execute(:winfo, :manager, window) end
Returns window's name (i.e. its name within its parent, as opposed to its full path name). `Winfo.name('.')` will return the name of the application.
# File lib/ffi-tk/command/winfo.rb, line 411 def name(window) Tk.execute(:winfo, :name, window).to_s end
Returns the path name of window
's parent, or nil if window
is the main window of the application.
# File lib/ffi-tk/command/winfo.rb, line 417 def parent(window) Tk.execute(:winfo, :parent, window) end
Returns the path name of the window whose X identifier is id
. id
must be a decimal, hexadecimal, or octal integer and must correspond to a window in the invoking application. If window
is given then the identifier is looked up on the display of window; otherwise it is looked up on the display of the application's main window.
# File lib/ffi-tk/command/winfo.rb, line 427 def pathname(id, window = None) if None == window Tk.execute(:winfo, :pathname, id).to_s else Tk.execute(:winfo, :pathname, '-displayo', window, id).to_s end end
Returns the number of pixels in window corresponding to the distance given by number. Number may be specified in any of the forms acceptable to Tk_GetPixels, such as “2.0c” or “1i”. The result is rounded to the nearest integer value; for a fractional result, use winfo fpixels.
# File lib/ffi-tk/command/winfo.rb, line 441 def pixels(window, number) Tk.execute(:winfo, :pixels, window, number).to_i end
If the mouse pointer is on the same screen as window, returns the pointer's x coordinate, measured in pixels in the screen's root window. If a virtual root window is in use on the screen, the position is measured in the virtual root. If the mouse pointer is not on the same screen as window then -1 is returned.
# File lib/ffi-tk/command/winfo.rb, line 451 def pointerx(window) Tk.execute(:winfo, :pointerx, window).to_i end
If the mouse pointer is on the same screen as window, returns a list with two elements, which are the pointer's x and y coordinates measured in pixels in the screen's root window. If a virtual root window is in use on the screen, the position is computed in the virtual root. If the mouse pointer is not on the same screen as window then both of the returned coordinates are -1.
# File lib/ffi-tk/command/winfo.rb, line 462 def pointerxy(window) Tk.execute(:winfo, :pointerxy, window).to_a(&:to_i) end
If the mouse pointer is on the same screen as window, returns the pointer's y coordinate, measured in pixels in the screen's root window. If a virtual root window is in use on the screen, the position is computed in the virtual root. If the mouse pointer is not on the same screen as window then -1 is returned.
# File lib/ffi-tk/command/winfo.rb, line 472 def pointery(window) Tk.execute(:winfo, :pointery, window).to_i end
Returns a decimal string giving window's requested height, in pixels. This is the value used by window's geometry manager to compute its geometry.
# File lib/ffi-tk/command/winfo.rb, line 479 def reqheight(window) Tk.execute(:winfo, :reqheight, window) end
Returns a decimal string giving window's requested width, in pixels. This is the value used by window's geometry manager to compute its geometry.
# File lib/ffi-tk/command/winfo.rb, line 486 def reqwidth(window) Tk.execute(:winfo, :reqwidth, window) end
Returns a list containing three decimal values in the range 0 to 65535, which are the red, green, and blue intensities that correspond to color in the window given by window. Color may be specified in any of the forms acceptable for a color option.
# File lib/ffi-tk/command/winfo.rb, line 494 def rgb(window, color) Tk.execute(:winfo, :rgb, window, color).split.map(&:to_i) end
Returns a decimal string giving the x-coordinate, in the root window of the screen, of the upper-left corner of window's border (or window if it has no border).
# File lib/ffi-tk/command/winfo.rb, line 501 def rootx(window) Tk.execute(:winfo, :rootx, window) end
Returns a decimal string giving the y-coordinate, in the root window of the screen, of the upper-left corner of window's border (or window if it has no border).
# File lib/ffi-tk/command/winfo.rb, line 508 def rooty(window) Tk.execute(:winfo, :rooty, window) end
Returns the name of the screen associated with window, in the form displayName.screenIndex.
# File lib/ffi-tk/command/winfo.rb, line 514 def screen(window) Tk.execute(:winfo, :screen, window) end
Returns a decimal string giving the number of cells in the default color map for window's screen.
# File lib/ffi-tk/command/winfo.rb, line 520 def screencells(window) Tk.execute(:winfo, :screencells, window) end
Returns a decimal string giving the depth of the root window of window's screen (number of bits per pixel).
# File lib/ffi-tk/command/winfo.rb, line 526 def screendepth(window) Tk.execute(:winfo, :screendepth, window) end
Returns a decimal string giving the height of window's screen, in pixels.
# File lib/ffi-tk/command/winfo.rb, line 531 def screenheight(window) Tk.execute(:winfo, :screenheight, window) end
Returns a decimal string giving the height of window's screen, in millimeters.
# File lib/ffi-tk/command/winfo.rb, line 537 def screenmmheight(window) Tk.execute(:winfo, :screenmmheight, window) end
Returns a decimal string giving the width of window's screen, in millimeters.
# File lib/ffi-tk/command/winfo.rb, line 543 def screenmmwidth(window) Tk.execute(:winfo, :screenmmwidth, window) end
Returns one of the following strings to indicate the default visual class for window's screen: directcolor, grayscale, pseudocolor, staticcolor, staticgray, or truecolor.
# File lib/ffi-tk/command/winfo.rb, line 550 def screenvisual(window) Tk.execute(:winfo, :screenvisual, window).to_sym end
Returns a decimal string giving the width of window's screen, in pixels.
# File lib/ffi-tk/command/winfo.rb, line 555 def screenwidth(window) Tk.execute(:winfo, :screenwidth, window) end
Returns a string containing information about the server for window's display. The exact format of this string may vary from platform to platform. For X servers the string has the form:
"XmajorRminor vendor vendorVersion"
where major and minor are the version and revision numbers provided by the server (e.g., X11R5), vendor is the name of the vendor for the server, and vendorRelease is an integer release number provided by the server.
# File lib/ffi-tk/command/winfo.rb, line 566 def server(window) Tk.execute(:winfo, :server, window) end
Returns the path name of the top-of-hierarchy window containing window. In standard Tk
this will always be a toplevel widget, but extensions may create other kinds of top-of-hierarchy widgets.
# File lib/ffi-tk/command/winfo.rb, line 573 def toplevel(window) Tk.execute(:winfo, :toplevel, window).to_s end
Returns true if window and all of its ancestors up through the nearest toplevel window are mapped. Returns false if any of these windows are not mapped.
# File lib/ffi-tk/command/winfo.rb, line 580 def viewable(window) Tk.execute(:winfo, :viewable, window).to_boolean end
Returns one of the following strings to indicate the visual class for window:
:directcolor, :grayscale, :pseudocolor, :staticcolor, :staticgray, :truecolor
# File lib/ffi-tk/command/winfo.rb, line 588 def visual(window) Tk.execute(:winfo, :visual, window).to_sym end
Returns the X identifier for the visual for window.
# File lib/ffi-tk/command/winfo.rb, line 593 def visualid(window) Tk.execute(:winfo, :visualid, window).to_s end
Returns a list whose elements describe the visuals available for window's screen. Each element consists of a visual class followed by an integer depth. The class has the same form as returned by winfo visual. The depth gives the number of bits per pixel in the visual. In addition, if the includeids argument is provided, then the depth is followed by the X identifier for the visual.
# File lib/ffi-tk/command/winfo.rb, line 603 def visualsavailable(window, includeids = None) if None == includeids list = Tk.execute(:winfo, :visualsavailable, window).to_a list.uniq.map do |string| klass, depth = string.split [klass, depth.to_i] end else list = Tk.execute(:winfo, :visualsavailable, window, :includeids).to_a list.uniq.map do |string| klass, depth, id = string.split [klass, depth.to_i, id] end end end
Returns the height of the virtual root window associated with window if there is one; otherwise returns the height of window's screen.
# File lib/ffi-tk/command/winfo.rb, line 621 def vrootheight(window) Tk.execute(:winfo, :vrootheight, window) end
Returns the width of the virtual root window associated with window if there is one; otherwise returns the width of window's screen.
# File lib/ffi-tk/command/winfo.rb, line 627 def vrootwidth(window) Tk.execute(:winfo, :vrootwidth, window) end
Returns the x-offset of the virtual root window associated with window, relative to the root window of its screen. This is normally either zero or negative. Returns 0 if there is no virtual root window for window.
# File lib/ffi-tk/command/winfo.rb, line 635 def vrootx(window) Tk.execute(:winfo, :vrootx, window) end
Returns the y-offset of the virtual root window associated with window, relative to the root window of its screen. This is normally either zero or negative. Returns 0 if there is no virtual root window for window.
# File lib/ffi-tk/command/winfo.rb, line 643 def vrooty(window) Tk.execute(:winfo, :vrooty, window) end
Returns a decimal string giving window's width in pixels. When a window is first created its width will be 1 pixel; the width will eventually be changed by a geometry manager to fulfill the window's needs. If you need the true width immediately after creating a widget, invoke update to force the geometry manager to arrange it, or use winfo reqwidth to get the window's requested width instead of its actual width.
# File lib/ffi-tk/command/winfo.rb, line 653 def width(window) Tk.execute(:winfo, :width, window) end
@see Winfo.atom
# File lib/ffi-tk/command/winfo.rb, line 5 def winfo_atom(name) Winfo.atom(name, self) end
@see Winfo.atomname
# File lib/ffi-tk/command/winfo.rb, line 10 def winfo_atomname(id) Winfo.atomname(id, self) end
@see Winfo.cells
# File lib/ffi-tk/command/winfo.rb, line 15 def winfo_cells Winfo.cells(self) end
@see Winfo.children
# File lib/ffi-tk/command/winfo.rb, line 20 def winfo_children Winfo.children(self) end
@see Winfo.class_name
# File lib/ffi-tk/command/winfo.rb, line 25 def winfo_class Winfo.class_name(self) end
@see Winfo.colormapfull
# File lib/ffi-tk/command/winfo.rb, line 30 def winfo_colormapfull Winfo.colormapfull(self) end
@see Winfo.containing
# File lib/ffi-tk/command/winfo.rb, line 35 def winfo_containing(root_x, root_y) Winfo.containing(root_x, root_y, self) end
@see Winfo.depth
# File lib/ffi-tk/command/winfo.rb, line 40 def winfo_depth Winfo.depth(self) end
@see Winfo.exists
# File lib/ffi-tk/command/winfo.rb, line 45 def winfo_exists Winfo.exists(self) end
@see Winfo.fpixels
# File lib/ffi-tk/command/winfo.rb, line 50 def winfo_fpixels(number) Winfo.fpixels(self, number) end
@see Winfo.geometry
# File lib/ffi-tk/command/winfo.rb, line 55 def winfo_geometry Winfo.geometry(self) end
@see Winfo.height
# File lib/ffi-tk/command/winfo.rb, line 60 def winfo_height Winfo.height(self) end
@see Winfo.id
# File lib/ffi-tk/command/winfo.rb, line 65 def winfo_id Winfo.id(self) end
@see Winfo.interps
# File lib/ffi-tk/command/winfo.rb, line 70 def winfo_interps Winfo.interps(self) end
@see Winfo.ismapped
# File lib/ffi-tk/command/winfo.rb, line 75 def winfo_ismapped Winfo.ismapped(self) end
@see Winfo.manager
# File lib/ffi-tk/command/winfo.rb, line 80 def winfo_manager Winfo.manager(self) end
@see Winfo.name
# File lib/ffi-tk/command/winfo.rb, line 85 def winfo_name Winfo.name(self) end
@see Winfo.parent
# File lib/ffi-tk/command/winfo.rb, line 90 def winfo_parent Winfo.parent(self) end
@see Winfo.pathname
# File lib/ffi-tk/command/winfo.rb, line 95 def winfo_pathname(id) Winfo.pathname(id, self) end
@see Winfo.pixels
# File lib/ffi-tk/command/winfo.rb, line 100 def winfo_pixels(number) Winfo.pixels(self, number) end
@see Winfo.pointerx
# File lib/ffi-tk/command/winfo.rb, line 105 def winfo_pointerx Winfo.pointerx(self) end
@see Winfo.pointerxy
# File lib/ffi-tk/command/winfo.rb, line 110 def winfo_pointerxy Winfo.pointerxy(self) end
@see Winfo.pointery
# File lib/ffi-tk/command/winfo.rb, line 115 def winfo_pointery Winfo.pointery(self) end
@see Winfo.reqheight
# File lib/ffi-tk/command/winfo.rb, line 120 def winfo_reqheight Winfo.reqheight(self) end
@see Winfo.reqwidth
# File lib/ffi-tk/command/winfo.rb, line 125 def winfo_reqwidth Winfo.reqwidth(self) end
@see Winfo.rgb
# File lib/ffi-tk/command/winfo.rb, line 130 def winfo_rgb(color) Winfo.rgb(self, color) end
@see Winfo.rootx
# File lib/ffi-tk/command/winfo.rb, line 135 def winfo_rootx Winfo.rootx(self) end
@see Winfo.rooty
# File lib/ffi-tk/command/winfo.rb, line 140 def winfo_rooty Winfo.rooty(self) end
@see Winfo.screen
# File lib/ffi-tk/command/winfo.rb, line 145 def winfo_screen Winfo.screen(self) end
@see Winfo.screencells
# File lib/ffi-tk/command/winfo.rb, line 150 def winfo_screencells Winfo.screencells(self) end
@see Winfo.screendepth
# File lib/ffi-tk/command/winfo.rb, line 155 def winfo_screendepth Winfo.screendepth(self) end
@see Winfo.screenheight
# File lib/ffi-tk/command/winfo.rb, line 160 def winfo_screenheight Winfo.screenheight(self) end
@see Winfo.screenmmheight
# File lib/ffi-tk/command/winfo.rb, line 165 def winfo_screenmmheight Winfo.screenmmheight(self) end
@see Winfo.screenmmwidth
# File lib/ffi-tk/command/winfo.rb, line 170 def winfo_screenmmwidth Winfo.screenmmwidth(self) end
@see Winfo.screenvisual
# File lib/ffi-tk/command/winfo.rb, line 175 def winfo_screenvisual Winfo.screenvisual(self) end
@see Winfo.screenwidth
# File lib/ffi-tk/command/winfo.rb, line 180 def winfo_screenwidth Winfo.screenwidth(self) end
@see Winfo.server
# File lib/ffi-tk/command/winfo.rb, line 185 def winfo_server Winfo.server(self) end
@see Winfo.toplevel
# File lib/ffi-tk/command/winfo.rb, line 190 def winfo_toplevel Winfo.toplevel(self) end
@see Winfo.viewable
# File lib/ffi-tk/command/winfo.rb, line 195 def winfo_viewable Winfo.viewable(self) end
@see Winfo.visual
# File lib/ffi-tk/command/winfo.rb, line 200 def winfo_visual Winfo.visual(self) end
@see Winfo.visualid
# File lib/ffi-tk/command/winfo.rb, line 205 def winfo_visualid Winfo.visualid(self) end
# File lib/ffi-tk/command/winfo.rb, line 210 def winfo_visualsavailable(includeids = None) Winfo.visualsavailable(self, includeids) end
@see Winfo.vrootheight
# File lib/ffi-tk/command/winfo.rb, line 215 def winfo_vrootheight Winfo.vrootheight(self) end
@see Winfo.vrootwidth
# File lib/ffi-tk/command/winfo.rb, line 220 def winfo_vrootwidth Winfo.vrootwidth(self) end
@see Winfo.vrootx
# File lib/ffi-tk/command/winfo.rb, line 225 def winfo_vrootx Winfo.vrootx(self) end
@see Winfo.vrooty
# File lib/ffi-tk/command/winfo.rb, line 230 def winfo_vrooty Winfo.vrooty(self) end
@see Winfo.width
# File lib/ffi-tk/command/winfo.rb, line 235 def winfo_width Winfo.width(self) end
@see Winfo.x
# File lib/ffi-tk/command/winfo.rb, line 240 def winfo_x Winfo.x(self) end
@see Winfo.y
# File lib/ffi-tk/command/winfo.rb, line 245 def winfo_y Winfo.y(self) end
Returns a decimal string giving the x-coordinate, in window's parent, of the upper-left corner of window's border (or window if it has no border).
# File lib/ffi-tk/command/winfo.rb, line 659 def x(window) Tk.execute(:winfo, :x, window) end
Returns a decimal string giving the y-coordinate, in window's parent, of the upper-left corner of window's border (or window if it has no border).
# File lib/ffi-tk/command/winfo.rb, line 665 def y(window) Tk.execute(:winfo, :y, window) end