PtBlockWindow()

Block a given window

Synopsis:

PtBlockedList_t *PtBlockWindow( 
                    PtWidget_t *window,
                    unsigned short cursor,
                    PgColor_t cursor_color );

Library:

ph

Description:

PtBlockWindow() blocks the given window (if not NULL).

If cursor isn't zero, this function sets the window's cursor to that value and its cursor color to cursor_color (if different from Pg_TRANSPARENT). Ph_CURSOR_NOINPUT is a typical choice for the cursor; for a list of the other cursors, see <photon/PhCursor.h>.

Returns:

A pointer to a control structure that can be passed to PtUnblockWindows() to undo the changes, or NULL if an error occurred or there was nothing to do.

Classification:

Photon

See also:

ApModalWait(), PgColor_t, PtBlockAllWindows(), PtMakeModal(), PtUnblockWindows()

“Modal dialogs” in the Window Management chapter of the Photon Programmer's Guide