RegisterWindowForFrame

Inside Macintosh: OpenDoc Class Reference /: Part 1 - Classes and Methods / ODWindowState

RegisterWindowForFrame
The RegisterWindowForFrame method creates a window object for the specified platform-specific window and root frame.
ODWindow RegisterWindowForFrame (
                           in ODPlatformWindow newWindow,
                           in ODFrame frame,
                           in ODBoolean isRootWindow,
                           in ODBoolean isResizable,
                           in ODBoolean isFloating,
                           in ODBoolean shouldSave,
                           in ODBoolean shouldDispose,
                           in ODFrame sourceFrame);
newWindow
A 32-bit value identifying a platform-specific window. On the Mac OS platform, this parameter is a window pointer (type WindowPtr).
frame
A reference to the root frame of the window object.
isRootWindow
kODTrue if the window object is to be a root window, otherwise kODFalse.
isResizable
kODTrue if the window object is to be resizable, otherwise kODFalse.
isFloating
kODTrue if the window object is to be a floating window, otherwise kODFalse.
shouldSave
kODTrue if the window object is to be saved in its draft, otherwise kODFalse.
shouldDispose
kODTrue if the platform window should be disposed of when the window object is deleted, otherwise kODFalse.
sourceFrame
A reference to the frame from which the window object was opened (used when an embedded frame is opened into a window), or kODNULL if the frame does not exist.
return value
A reference to the newly created window object.

DISCUSSION
Your part calls this method to re-create the windows of an existing document. You should create the platform-specific window as invisible. After calling this method, you should call the Show method of the returned window to make it visible.
This method initializes the reference count of the returned window. When you have finished using that window, you should call its Release method.

EXCEPTIONS

kODErrCannotCreateWindow
There is not enough memory to create the new window object.

SEE ALSO
The ODWindow::Show method (page 837).
The ODWindowState::RegisterWindow method (page 864).
Listing 2-8 on page 51 in OpenDoc Cookbook.
"Creating and Registering a Window" on page 224 in OpenDoc Programmer's Guide.
"The Open Method of Your Part Editor" on page 228 in OpenDoc Programmer's Guide.
Table 11-1 on page 466 in OpenDoc Programmer's Guide.