CreateEmbeddedFacet

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

CreateEmbeddedFacet
The CreateEmbeddedFacet method creates a facet for the specified frame embedded in this facet.
ODFacet CreateEmbeddedFacet (
                        in ODFrame frame,
                        in ODShape clipShape,
                        in ODTransform externalTransform,
                        in ODCanvas canvas,
                        in ODCanvas biasCanvas,
                        in ODFacet siblingFacet,
                        in ODFramePosition position);
frame
A reference to a frame for this facet.
clipShape
A reference to an initial clip shape for this facet.
externalTransform
A reference to an initial external transform for this facet.
canvas
A reference to a canvas this facet should draw to, or kODNULL if identical to the canvas associated with the containing facet.
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.
siblingFacet
A reference to an existing embedded facet of this facet, or kODNULL if the embedded facet does not exist.
position
The desired position of the new facet relative to the sibling facet. The value of position must be one of the following: kODFrameInFront or kODFrameBehind. If the sibling facet is set to kODNULL, the new facet is placed in front of (kODFrameInFront) or behind all (kODFrameBehind) its sibling facets.
return value
A reference to a new facet object.

DISCUSSION
This facet's part calls this method to create a facet for one of its embedded frames. This method in turn calls its frame's FacetAdded method, which in turn calls the FacetAdded method associated with the frame's part to notify the part that a facet has been added to one of its display frames.

EXCEPTIONS

kODErrCanvasHasNoOwner
The offscreen canvas has no owner.
kODErrInvalidFacet
The specified sibling facet is not an embedded facet of this facet.
kODErrUnsupportedFramePositionCode
The specified position is not a valid position code.

SEE ALSO
The ODFramePosition type (page 882).
The ODFrame::FacetAdded method (page 319).
The ODPart::FacetAdded method (page 514).
"Adding a Facet" on page 122 in OpenDoc Programmer's Guide.
"Drawing When a Window is Scrolled" on page 160 in OpenDoc Programmer's Guide.
Table 11-1 on page 466 in OpenDoc Programmer's Guide.