Inside Macintosh: OpenDoc Class Reference /

Part 1 - Classes and Methods / ODWindowState

CreateCanvas

The CreateCanvas method creates a canvas object.

ODCanvas CreateCanvas (in ODGraphicsSystem graphicsSystem,
                       in ODPlatformCanvas platformCanvas,
                       in ODBoolean isDynamic,
                       in ODBoolean isOffscreen);

graphicsSystem

A 16-bit value specifying the graphics system you want to use for this canvas. Valid graphics systems are platform dependent.

platformCanvas

A 32-bit value identifying the graphics-system-specific drawing structure to assign to the canvas, or kODNULL for no drawing structure. Valid values for platformCanvas are graphics-system-dependent.

isDynamic

kODTrue if the canvas is to be dynamic, otherwise kODFalse.

isOffscreen

kODTrue if the canvas is to be offscreen, otherwise kODFalse.

return value

A reference to the newly created canvas object.

DISCUSSION

Your part calls this method to create a canvas object that will not be attached to any facet. To create a canvas to attach to a particular facet, you should call that facet's CreateCanvas method instead of this method.

On the Mac OS platform, the graphics system may be either QuickDraw (kODQuickDraw) or QuickDraw GX (kODQuickDrawGX). For QuickDraw, the platform canvas should be a QuickDraw graphics port (type GrafPtr); for QuickDraw GX, it should be a QuickDraw GX view port object (type gxViewPort).

SEE ALSO

The ODGraphicsSystem type (page 883).
The ODFacet::CreateCanvas method (page 237).
The ODCanvas class (page 62).
"Adding and Removing Canvases" on page 134 in OpenDoc Programmer's Guide.
Table 11-1 on page 466 in OpenDoc Programmer's Guide.