Section 3: library functions
Tk_GetVisual – translate from string to visual Synopsis#include <tk.h> Visual * Tk_GetVisual(interp, tkwin, string, depthPtr, colormapPtr)ArgumentsTcl_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. int *depthPtr (out)…
Tk_GetVRootGeometry – Get location and size of virtual root for window Synopsis#include <tk.h> Tk_GetVRootGeometry(tkwin, xPtr, yPtr, widthPtr, heightPtr)ArgumentsTk_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 to store y-offset…
Tk_GetUserInactiveTime, Tk_ResetUserInactiveTime – discover user inactivity time Synopsis#include <tk.h> long Tk_GetUserInactiveTime(display) Tk_GetUserInactiveTime(display)ArgumentsDisplay *display (in) The display on which the user inactivity timer is to be queried or reset. DescriptionTk_GetUserInactiveTime returns the number of milliseconds that have passed since the last user interaction (usually via keyboard or mouse) with the respective display. On systems and displays…
Tk_GetUid, Tk_Uid – convert from string to unique identifier Synopsis#include <tk.h> Tk_Uid Tk_GetUid(string)Argumentschar *string (in) String for which the corresponding unique identifier is desired. DescriptionTk_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. A unique identifier (type…
Tk_GetSelection – retrieve the contents of a selection Synopsis#include <tk.h> int Tk_GetSelection(interp, tkwin, selection, target, proc, clientData)ArgumentsTcl_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 retrieved. Atom target…
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)ArgumentsTcl_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 which the first…
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)ArgumentsTcl_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 which the first…
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)ArgumentsTcl_Interp *interp (in) Interpreter to use for error reporting. Tk_Window tkwin (in) Window whose screen geometry determines the conversion between absolute units and…
Tk_GetRootCoords – Compute root-window coordinates of window Synopsis#include <tk.h> Tk_GetRootCoords(tkwin, xPtr, yPtr)ArgumentsTk_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 of tkwin‘s border….
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)ArgumentsTcl_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 rep will be…
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)ArgumentsTcl_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 rep will be…
Tk_GetPixmap, Tk_FreePixmap – allocate and free pixmaps Synopsis#include <tk.h> Pixmap Tk_GetPixmap(display, d, width, height, depth) Tk_FreePixmap(display, pixmap)ArgumentsDisplay *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 depth (in) Number…
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)ArgumentsTcl_Interp *interp (in) Interpreter to use for error reporting. Tk_Window tkwin (in) Window whose screen geometry determines the conversion between absolute units and…
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)ArgumentsTcl_Interp *interp (in) Interpreter to use for error reporting. Tk_Window tkwin (in) Window whose screen geometry determines the conversion between absolute units and…
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 Tk_Offset(type,…
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 Tk_Offset(type,…
Tk_GetOption – retrieve an option from the option database Synopsis#include <tk.h> Tk_Uid Tk_GetOption(tkwin, name, class)ArgumentsTk_Window tkwin (in) Token for window. const char *name (in) Name of desired option. const char *class (in) Class of desired option. Null means there is no class for this option; do lookup based on name only. DescriptionThis procedure is invoked…
Tk_MainWindow, Tk_GetNumMainWindows – functions for querying main window information Synopsis#include <tk.h> Tk_Window Tk_MainWindow(interp) int Tk_GetNumMainWindows()ArgumentsTcl_Interp *interp (in/out) Interpreter associated with the application. DescriptionA main window is a special kind of toplevel window used as the outermost window in an application. If interp is associated with a Tk application then Tk_MainWindow returns the application’s main window….
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)ArgumentsTcl_Interp *interp (in) Interpreter to use for error reporting. Tk_Window tkwin (in) Window whose screen geometry determines the conversion between absolute units and…
Tk_GetJustifyFromObj, Tk_GetJustify, Tk_NameOfJustify – translate between strings and justification styles Synopsis#include <tk.h> int Tk_GetJustifyFromObj(interp, objPtr, justifyPtr) int Tk_GetJustify(interp, string, justifyPtr) const char * Tk_NameOfJustify(justify)ArgumentsTcl_Interp *interp (in) Interpreter to use for error reporting, or NULL. Tcl_Obj *objPtr (in/out) String value contains name of justification style, one of “left”, “right”, or “center”. The internal rep will be…