Section 3: library functions
Tk_IdToWindow – Find Tk’s window information for an X window Synopsis #include <tk.h> Tk_Window Tk_IdToWindow(display, window) Arguments Display *display (in) X display containing the window. Window window (in) X id for window. Description Given an X window identifier and the X display it corresponds to, this procedure returns the corresponding Tk_Window handle. If there is…
Tk_WindowId, Tk_Parent, Tk_Display, Tk_DisplayName, Tk_ScreenNumber, Tk_Screen, Tk_X, Tk_Y, Tk_Width, Tk_Height, Tk_Changes, Tk_Attributes, Tk_IsContainer, Tk_IsEmbedded, Tk_IsMapped, Tk_IsTopLevel, Tk_ReqWidth, Tk_ReqHeight, Tk_MinReqWidth, Tk_MinReqHeight, Tk_InternalBorderLeft, Tk_InternalBorderRight, Tk_InternalBorderTop, Tk_InternalBorderBottom, Tk_Visual, Tk_Depth, Tk_Colormap, Tk_Interp – retrieve information from Tk’s local data structure Synopsis #include <tk.h> Window Tk_WindowId(tkwin) Tk_Window Tk_Parent(tkwin) Display * Tk_Display(tkwin) const char * Tk_DisplayName(tkwin) int Tk_ScreenNumber(tkwin) Screen * Tk_Screen(tkwin)…
Tk_HandleEvent – invoke event handlers for window system events Synopsis #include <tk.h> Tk_HandleEvent(eventPtr) Arguments XEvent *eventPtr (in) Pointer to X event to dispatch to relevant handler(s). It is important that all unused fields of the structure be set to zero. Description Tk_HandleEvent is a lower-level procedure that deals with window events. It is called by…
Tk_HWNDToWindow – Find Tk’s window information for a Windows window Synopsis #include <tkPlatDecls.h> Tk_Window Tk_HWNDToWindow(hwnd) Arguments HWND hwnd (in) Windows handle for the window. Description Given a Windows HWND window identifier, this procedure returns the corresponding Tk_Window handle. If there is no Tk_Window corresponding to hwnd then NULL is returned. Keywords Windows window id
Tk_Grab, Tk_Ungrab – manipulate grab state in an application Synopsis #include <tk.h> int Tk_Grab(interp, tkwin, grabGlobal) void Tk_Ungrab(tkwin) Arguments Tcl_Interp *interp (in) Interpreter to use for error reporting Tk_Window tkwin (in) Window on whose behalf the pointer is to be grabbed or released int grabGlobal (in) Boolean indicating whether the grab is global or application…
Tk_GetVisual – translate from string to visual Synopsis #include <tk.h> Visual * Tk_GetVisual(interp, tkwin, string, depthPtr, colormapPtr) Arguments Tcl_Interp *interp (in) Interpreter to use for error reporting. Tk_Window tkwin (in) Token for window in which the visual will be used. const char *string (in) String that identifies the desired visual. See below for valid formats….
Tk_GetVRootGeometry – Get location and size of virtual root for window Synopsis #include <tk.h> Tk_GetVRootGeometry(tkwin, xPtr, yPtr, widthPtr, heightPtr) Arguments Tk_Window tkwin (in) Token for window whose virtual root is to be queried. int xPtr (out) Points to word in which to store x-offset of virtual root. int yPtr (out) Points to word in which…
Tk_GetUserInactiveTime, Tk_ResetUserInactiveTime – discover user inactivity time Synopsis #include <tk.h> long Tk_GetUserInactiveTime(display) Tk_GetUserInactiveTime(display) Arguments Display *display (in) The display on which the user inactivity timer is to be queried or reset. Description Tk_GetUserInactiveTime returns the number of milliseconds that have passed since the last user interaction (usually via keyboard or mouse) with the respective display….
Tk_GetUid, Tk_Uid – convert from string to unique identifier Synopsis #include <tk.h> Tk_Uid Tk_GetUid(string) Arguments char *string (in) String for which the corresponding unique identifier is desired. Description Tk_GetUid returns the unique identifier corresponding to string. Unique identifiers are similar to atoms in Lisp, and are used in Tk to speed up comparisons and searches….
Tk_GetSelection – retrieve the contents of a selection Synopsis #include <tk.h> int Tk_GetSelection(interp, tkwin, selection, target, proc, clientData) Arguments Tcl_Interp *interp (in) Interpreter to use for reporting errors. Tk_Window tkwin (in) Window on whose behalf to retrieve the selection (determines display from which to retrieve). Atom selection (in) The name of the selection to be…
Tk_GetScrollInfo, Tk_GetScrollInfoObj – parse arguments for scrolling commands Synopsis #include <tk.h> int Tk_GetScrollInfo(interp, argc, argv, dblPtr, intPtr) int Tk_GetScrollInfoObj(interp, objc, objv, dblPtr, intPtr) Arguments Tcl_Interp *interp (in) Interpreter to use for error reporting. int argc (in) Number of strings in argv array. const char *argv[] (in) Argument strings. These represent the entire widget command, of…
Tk_GetScrollInfo, Tk_GetScrollInfoObj – parse arguments for scrolling commands Synopsis #include <tk.h> int Tk_GetScrollInfo(interp, argc, argv, dblPtr, intPtr) int Tk_GetScrollInfoObj(interp, objc, objv, dblPtr, intPtr) Arguments Tcl_Interp *interp (in) Interpreter to use for error reporting. int argc (in) Number of strings in argv array. const char *argv[] (in) Argument strings. These represent the entire widget command, of…
Tk_GetPixelsFromObj, Tk_GetPixels, Tk_GetMMFromObj, Tk_GetScreenMM – translate between strings and screen units Synopsis #include <tk.h> int Tk_GetPixelsFromObj(interp, tkwin, objPtr, intPtr) int Tk_GetPixels(interp, tkwin, string, intPtr) int Tk_GetMMFromObj(interp, tkwin, objPtr, doublePtr) int Tk_GetScreenMM(interp, tkwin, string, doublePtr) Arguments Tcl_Interp *interp (in) Interpreter to use for error reporting. Tk_Window tkwin (in) Window whose screen geometry determines the conversion between…
Tk_GetRootCoords – Compute root-window coordinates of window Synopsis #include <tk.h> Tk_GetRootCoords(tkwin, xPtr, yPtr) Arguments Tk_Window tkwin (in) Token for window. int *xPtr (out) Pointer to location in which to store root-window x-coordinate corresponding to left edge of tkwin‘s border. int *yPtr (out) Pointer to location in which to store root-window y-coordinate corresponding to top edge…
Tk_GetReliefFromObj, Tk_GetRelief, Tk_NameOfRelief – translate between strings and relief values Synopsis #include <tk.h> int Tk_GetReliefFromObj(interp, objPtr, reliefPtr) int Tk_GetRelief(interp, name, reliefPtr) const char * Tk_NameOfRelief(relief) Arguments Tcl_Interp *interp (in) Interpreter to use for error reporting. Tcl_Obj *objPtr (in/out) String value contains name of relief, one of “flat”, “groove”, “raised”, “ridge”, “solid”, or “sunken”; the internal…
Tk_GetReliefFromObj, Tk_GetRelief, Tk_NameOfRelief – translate between strings and relief values Synopsis #include <tk.h> int Tk_GetReliefFromObj(interp, objPtr, reliefPtr) int Tk_GetRelief(interp, name, reliefPtr) const char * Tk_NameOfRelief(relief) Arguments Tcl_Interp *interp (in) Interpreter to use for error reporting. Tcl_Obj *objPtr (in/out) String value contains name of relief, one of “flat”, “groove”, “raised”, “ridge”, “solid”, or “sunken”; the internal…
Tk_GetPixmap, Tk_FreePixmap – allocate and free pixmaps Synopsis #include <tk.h> Pixmap Tk_GetPixmap(display, d, width, height, depth) Tk_FreePixmap(display, pixmap) Arguments Display *display (in) X display for the pixmap. Drawable d (in) Pixmap or window where the new pixmap will be used for drawing. int width (in) Width of pixmap. int height (in) Height of pixmap. int…
Tk_GetPixelsFromObj, Tk_GetPixels, Tk_GetMMFromObj, Tk_GetScreenMM – translate between strings and screen units Synopsis #include <tk.h> int Tk_GetPixelsFromObj(interp, tkwin, objPtr, intPtr) int Tk_GetPixels(interp, tkwin, string, intPtr) int Tk_GetMMFromObj(interp, tkwin, objPtr, doublePtr) int Tk_GetScreenMM(interp, tkwin, string, doublePtr) Arguments Tcl_Interp *interp (in) Interpreter to use for error reporting. Tk_Window tkwin (in) Window whose screen geometry determines the conversion between…
Tk_GetPixelsFromObj, Tk_GetPixels, Tk_GetMMFromObj, Tk_GetScreenMM – translate between strings and screen units Synopsis #include <tk.h> int Tk_GetPixelsFromObj(interp, tkwin, objPtr, intPtr) int Tk_GetPixels(interp, tkwin, string, intPtr) int Tk_GetMMFromObj(interp, tkwin, objPtr, doublePtr) int Tk_GetScreenMM(interp, tkwin, string, doublePtr) Arguments Tcl_Interp *interp (in) Interpreter to use for error reporting. Tk_Window tkwin (in) Window whose screen geometry determines the conversion between…
Tk_CreateOptionTable, Tk_DeleteOptionTable, Tk_InitOptions, Tk_SetOptions, Tk_FreeSavedOptions, Tk_RestoreSavedOptions, Tk_GetOptionValue, Tk_GetOptionInfo, Tk_FreeConfigOptions, Tk_Offset – process configuration options Synopsis #include <tk.h> Tk_OptionTable Tk_CreateOptionTable(interp, templatePtr) Tk_DeleteOptionTable(optionTable) int Tk_InitOptions(interp, recordPtr, optionTable, tkwin) int Tk_SetOptions(interp, recordPtr, optionTable, objc, objv, tkwin, savePtr, maskPtr) Tk_FreeSavedOptions(savedPtr) Tk_RestoreSavedOptions(savedPtr) Tcl_Obj * Tk_GetOptionValue(interp, recordPtr, optionTable, namePtr, tkwin) Tcl_Obj * Tk_GetOptionInfo(interp, recordPtr, optionTable, namePtr, tkwin) Tk_FreeConfigOptions(recordPtr, optionTable, tkwin) int…