Grant's CGI Framework
Documentation: Windows

Version: 2.0d6
Release Date: Tuesday, October 14, 1997
Expires no later than: December 31, 1997

Important: THIS DOCUMENTATION IS INCOMPLETE AND PROBABLY A BIT INACCURATE

It is subject to change as the API matures.
Feedback and contributions are encouraged:

grantcgi@list.nisto.com

or grant@achilles.net

Custom window support.

Initialization

CGIWindowStartup

CGIErr CGIWindowStartup ( APIData apidata )

apidata - may be NULL

Window Management

CGIWindowNew

CGIErr CGIWindowNew ( APIData apidata, char *windowTitle, SInt16 left, SInt16 top, SInt16 right, SInt16 bottom, Boolean *growable, UInt32 inUserRef, WindowPtr *outWindowPtr )

Create a new window. The window will initially not be visible, so you will have to show or otherwise activate it.

windowTitle

is a C format string (max 255 chars + null terminator).

left,top,right,bottom

the coordinates for the new window.

outWindowPtr

is set to the WindowPtr for the new window.

CGIWindowDispose

CGIErr CGIWindowDispose ( APIData apidata, WindowPtr *ioWindowPtr )

Dispose of (Close) a window. Any data associated with the window (controls, UI elements, etc.) will NOT be disposed of by this function, so should be disposed of before this call.

ioWindowPtr

must be a valid WindowPtr, and will be set to NULL.

CGIWindowShow

CGIErr CGIWindowShow ( APIData apidata, WindowPtr inWindowPtr )

Show the window.

CGIWindowHide

CGIErr CGIWindowHide ( APIData apidata, WindowPtr inWindowPtr )

Hide the window.

CGIWindowActivate

CGIErr CGIWindowActivate ( APIData apidata, WindowPtr inWindowPtr )

Bring the window to the front. Brings a plug-in window to the front. Does not make invisible windows visible. If the window can't be brought to the front, CGIErr_RequestFailed will be returned (E.g., when in a modal state).

CGIWindowUserRefGet

CGIErr CGIWindowUserRefGet ( APIData apidata, WindowPtr inWindowPtr, UInt32 *outUserRef )

CGIWindowUserRefSet

CGIErr CGIWindowUserRefSet ( APIData apidata, WindowPtr inWindowPtr, UInt32 inUserRef )