Manual Pages for UNIX Darwin command on man winfo

winfo(n) Tk Built-In Commands winfo(n)

NAME

winfo - Return window-related information

SYNOPSIS

wwiinnffoo option ?arg arg ...?

DESCRIPTION

The wwiinnffoo command is used to retrieve information about windows managed by Tk. It can take any of a number of different forms, depending on the option argument. The legal forms are:

wwiinnffoo aattoomm ?-ddiissppllaayyooff window? name

Returns a decimal string giving the integer identifier for the atom whose name is name. If no atom exists with the name name

then a new one is created. If the -ddiissppllaayyooff option 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.

wwiinnffoo aattoommnnaammee ?-ddiissppllaayyooff window? id

Returns the textual name for the atom whose integer identifier

is id. If the -ddiissppllaayyooff option 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 wwiinnffoo aattoomm command. It generates an error if no such atom exists. wwiinnffoo cceellllss window Returns a decimal string giving the number of cells in the color map for window. wwiinnffoo cchhiillddrreenn window Returns a list containing the path names of all the children of

window. Top-level windows are returned as children of their log-

ical 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 wwmm ssttaacckkoorrddeerr command to

query the stacking order of Top-level windows.

wwiinnffoo ccllaassss window Returns the class name for window. wwiinnffoo ccoolloorrmmaappffuullll window

Returns 1 if the colormap for window is known to be full, 0 oth-

erwise. 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 hasn't freed any colors in the colormap since the failed allocation.

wwiinnffoo ccoonnttaaiinniinngg ?-ddiissppllaayyooff window? rootX rootY

Returns the path name for the window containing the point given by rootX and rootY. RootX and rootY are specified in screen

units (i.e. any form acceptable to TTkkGGeettPPiixxeellss) in the coordi-

nate 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 the -ddiissppllaayyooff option is given then the coordi-

nates 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 an empty

string is returned. In selecting the containing window, chil-

dren are given higher priority than parents and among siblings the highest one in the stacking order is chosen. wwiinnffoo ddeepptthh window Returns a decimal string giving the depth of window (number of bits per pixel). wwiinnffoo eexxiissttss window Returns 1 if there exists a window named window, 0 if no such window exists. wwiinnffoo ffppiixxeellss window number

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 TTkkGGeettSSccrreeeennMMMM, such as ``2.0c'' or ``1i''. The return value may be fractional; for an integer value, use wwiinnffoo ppiixxeellss. wwiinnffoo ggeeoommeettrryy window Returns the geometry for window, in the form widthxxheight++x++y. All dimensions are in pixels. wwiinnffoo hheeiigghhtt window 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 ful-

fill the window's needs. If you need the true height immedi-

ately after creating a widget, invoke uuppddaattee to force the geome-

try manager to arrange it, or use wwiinnffoo rreeqqhheeiigghhtt to get the window's requested height instead of its actual height. wwiinnffoo iidd window

Returns a hexadecimal string giving a low-level platform-spe- |

cific 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.

wwiinnffoo iinntteerrppss ?-ddiissppllaayyooff window?

Returns a list whose members are the names of all Tcl inter-

preters (e.g. all Tk-based applications) currently registered

for a particular display. If the -ddiissppllaayyooff option is given

then the return value refers to the display of window; other-

wise it refers to the display of the application's main window. wwiinnffoo iissmmaappppeedd window Returns 11 if window is currently mapped, 00 otherwise. wwiinnffoo mmaannaaggeerr window Returns the name of the geometry manager currently responsible for window, or an empty string if window isn't managed by any

geometry manager. The name is usually the name of the Tcl com-

mand for the geometry manager, such as ppaacckk or ppllaaccee. If the geometry manager is a widget, such as canvases or text, the name is the widget's class command, such as ccaannvvaass. wwiinnffoo nnaammee window Returns window's name (i.e. its name within its parent, as opposed to its full path name). The command wwiinnffoo nnaammee .. will return the name of the application. wwiinnffoo ppaarreenntt window Returns the path name of window's parent, or an empty string if window is the main window of the application.

wwiinnffoo ppaatthhnnaammee ?-ddiissppllaayyooff window? id

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 the

-ddiissppllaayyooff option 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. wwiinnffoo ppiixxeellss window number

Returns the number of pixels in window corresponding to the dis-

tance given by number. Number may be specified in any of the forms acceptable to TTkkGGeettPPiixxeellss, such as ``2.0c'' or ``1i''.

The result is rounded to the nearest integer value; for a frac-

tional result, use wwiinnffoo ffppiixxeellss. wwiinnffoo ppooiinntteerrxx window 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 isn't on the same screen as window then -1 is returned.

wwiinnffoo ppooiinntteerrxxyy window 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 coordi-

nates measured in pixels in the screen's root window. If a vir-

tual root window is in use on the screen, the position is com-

puted in the virtual root. If the mouse pointer isn't on the same screen as window then both of the returned coordinates are

-1.

wwiinnffoo ppooiinntteerryy window 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 isn't on the same screen as window then -1 is returned.

wwiinnffoo rreeqqhheeiigghhtt window 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. wwiinnffoo rreeqqwwiiddtthh window 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. wwiinnffoo rrggbb window color Returns a list containing three decimal values, 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. wwiinnffoo rroooottxx window

Returns a decimal string giving the x-coordinate, in the root

window of the screen, of the upper-left corner of window's bor-

der (or window if it has no border). wwiinnffoo rroooottyy window

Returns a decimal string giving the y-coordinate, in the root

window of the screen, of the upper-left corner of window's bor-

der (or window if it has no border). wwiinnffoo ssccrreeeenn window Returns the name of the screen associated with window, in the form displayName.screenIndex. wwiinnffoo ssccrreeeenncceellllss window Returns a decimal string giving the number of cells in the default color map for window's screen. wwiinnffoo ssccrreeeennddeepptthh window Returns a decimal string giving the depth of the root window of window's screen (number of bits per pixel). wwiinnffoo ssccrreeeennhheeiigghhtt window Returns a decimal string giving the height of window's screen, in pixels. wwiinnffoo ssccrreeeennmmmmhheeiigghhtt window Returns a decimal string giving the height of window's screen, in millimeters. wwiinnffoo ssccrreeeennmmmmwwiiddtthh window Returns a decimal string giving the width of window's screen, in millimeters. wwiinnffoo ssccrreeeennvviissuuaall window Returns one of the following strings to indicate the default

visual class for window's screen: ddiirreeccttccoolloorr, ggrraayyssccaallee, ppsseeuu-

ddooccoolloorr, ssttaattiiccccoolloorr, ssttaattiiccggrraayy, or ttrruueeccoolloorr. wwiinnffoo ssccrreeeennwwiiddtthh window Returns a decimal string giving the width of window's screen, in pixels. wwiinnffoo sseerrvveerr window 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 ``XXmajorRRminor vendor vendorVersion'' where major and minor are the version and revision numbers provided by the server (e.g., XX1111RR55), vendor is the name of the vendor for the server, and vendorRelease is an integer release number provided by the server. wwiinnffoo ttoopplleevveell window

Returns the path name of the top-level window containing window.

wwiinnffoo vviieewwaabbllee window Returns 1 if window and all of its ancestors up through the nearest toplevel window are mapped. Returns 0 if any of these windows are not mapped. wwiinnffoo vviissuuaall window Returns one of the following strings to indicate the visual

class for window: ddiirreeccttccoolloorr, ggrraayyssccaallee, ppsseeuuddooccoolloorr, ssttaattiicc-

ccoolloorr, ssttaattiiccggrraayy, or ttrruueeccoolloorr. wwiinnffoo vviissuuaalliidd window Returns the X identifier for the visual for window. wwiinnffoo vviissuuaallssaavvaaiillaabbllee window ?iinncclluuddeeiiddss? Returns a list whose elements describe the visuals available for

window's screen. Each element consists of a visual class fol-

lowed by an integer depth. The class has the same form as returned by wwiinnffoo vviissuuaall. The depth gives the number of bits

per pixel in the visual. In addition, if the iinncclluuddeeiiddss argu-

ment is provided, then the depth is followed by the X identifier for the visual. wwiinnffoo vvrrooootthheeiigghhtt window Returns the height of the virtual root window associated with

window if there is one; otherwise returns the height of win-

dow's screen. wwiinnffoo vvrroooottwwiiddtthh window Returns the width of the virtual root window associated with window if there is one; otherwise returns the width of window's screen. wwiinnffoo vvrroooottxx window

Returns the x-offset of the virtual root window associated with

window, relative to the root window of its screen. This is nor-

mally either zero or negative. Returns 0 if there is no virtual root window for window. wwiinnffoo vvrroooottyy window

Returns the y-offset of the virtual root window associated with

window, relative to the root window of its screen. This is nor-

mally either zero or negative. Returns 0 if there is no virtual root window for window. wwiinnffoo wwiiddtthh window 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 uuppddaattee to force the geometry manager to arrange it, or use wwiinnffoo rreeqqwwiiddtthh to get the window's requested width instead of its actual width. wwiinnffoo xx window

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). wwiinnffoo yy window

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). KKEEYYWWOORRDDSS atom, children, class, geometry, height, identifier, information, interpreters, mapped, parent, path name, screen, virtual root, width, window