Inside Macintosh: OpenDoc Class Reference /

Part 1 - Classes and Methods / ODFrame

RequestFrameShape

The RequestFrameShape method requests a new frame shape for this frame.

ODShape RequestFrameShape (in ODShape shape, 
                           in ODCanvas biasCanvas);

shape

A reference to the requested shape, expressed in frame coordinates.

biasCanvas

kODNULL if the geometry is in platform-normal coordinates, otherwise a reference to the canvas object to whose coordinate space the geometry is biased.

return value

A reference to the new frame shape, expressed in frame coordinates.

DISCUSSION

Your part calls its display frame's RequestFrameShape method when it wants to resize the display frame. This method in turn calls the RequestFrameShape method of this frame's containing part. The containing part returns a reference to the shape object it allows the display frame to have. This frame stores the shape as its new frame shape and returns the shape to your part so that your part knows what the new shape is.

Your part must not modify the frame shape; only this frame's containing part can modify the frame shape.

This method increments the reference count of the returned shape object. When you have finished using that shape object, you should call its Release method.

EXCEPTIONS

kODErrIllegalNullShapeInput

The shape parameter is null.

SEE ALSO

The ODFrame::ChangeFrameShape method (page 306).
The ODFrame::AcquireFrameShape method (page 302).
The ODPart::RequestFrameShape method (page 544).
Listing 2-14 on page 61 in OpenDoc Cookbook.
"Resizing a Display Frame" on page 109 in OpenDoc Programmer's Guide.
"View Type" on page 155 in OpenDoc Programmer's Guide.