Shape_QueryVersion(3)

NAME
Shape_GetBbox, Shape_GetShapeRectanglesObj, Shape_QueryVersion, Shape_ExtensionPresent - get info about a shaping or the shaping subsystem

SYNOPSIS
#include <shape.h>

int
Shape_GetBbox(interp, tkwin, getClip, valid, x1, y1, x2, y2)

int
Shape_GetShapeRectanglesObj(interp, tkwin, getClip)

int
Shape_QueryVersion(tkwin, majorPtr, minorPtr)

int
Shape_ExtensionPresent(tkwin)

ARGUMENTS
Interpreter to use for error reporting and providing the result from Shape_GetShapeRectanglesObj. Token for window to query the shaping of. Whether to use the clipping shape of the window (see MODIFICATION TARGETS in the Shape_MoveShape(3) manual page for a discussion.) Whether a valid bounding box is present for the shape of the window. The x-coordinate of the left side of the bounding box. The y-coordinate of the top side of the bounding box. The x-coordinate of the right side of the bounding box. The y-coordinate of the bottom side of the bounding box. The major version of the X Shaped Window extension installed on the XServer. The minor version of the X Shaped Window extension installed on the XServer.

DESCRIPTION
Shape_GetBbox queries the bounding box of the bounding shape (or the clipping shape if IgetClip is set) of the given window (specified by tkwin.) If a shape is defined for the window, the flag indicated by valid is set and the bounds are passed in x1, y1, x2 and y2. If no shape is defined for the window, the flag is reset instead. In both cases, TCL_OK is returned from the function. If an error occurs, a message is left in the specified interpreter and TCL_ERROR is returned; valid is not modified in this case. Shape_GetShapeRectanglesObj queries the bounding shape (or the clipping shape if IgetClip is set) of the given window (specified by tkwin.) If the shape is successfully queried, a description of the shape in terms of a list of rectangles (each rectangle being represented by a list of four elements identifying the coordinates of that rectangle) is placed in the interpreter, interp, and TCL_OK is returned. If an error occurs, a suitable message is placed in the interpreter, and TCL_ERROR is returned. Shape_QueryVersion queries the version of the XShape extension installed on the (display of the) XServer which window tkwin exists on. The result is non-zero (true) if the query was successful (in which case the variables identified by majorVersion and minorVersion are updated to contain the version number details) and zero (false) if the query failed. Dummy values are returned under Windows. Shape_ExtensionPresent queries whether the XShape extension is installed on the XServer which window tkwin exists on, returning a non-zero (true) value if this is the case. This function always succeeds on Windows due to the way the linking works. This function is normally only called during the initialisation of the extension.

AUTHOR
Donal K. Fellows <fellowsd@cs.man.ac.uk>

SEE ALSO
shape(n), Shape_MoveShape(3), Shape_RenderTextAsRectangles(3)