RevealFrame

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

RevealFrame
The RevealFrame method should make the specified embedded frame visible by scrolling it into view.
ODBoolean RevealFrame (in ODFrame embeddedFrame, 
                       in ODShape revealShape);
embeddedFrame
A reference to an embedded frame of this part.
revealShape
A reference to a shape object, expressed in frame coordinates, that indicates the portion of the frame to be revealed.
return value
kODTrue if this part was able to reveal the frame, otherwise kODFalse.

DISCUSSION
An embedded part calls this part's RevealFrame method when it needs to become visible, such as in conjunction with a keyboard event that requires an undisplayed area of a window to scroll into view.
Your part's RevealFrame method should scroll one of your part's display frames, if necessary, to make the specified embedded frame visible. If your part has no visible display frames, it should ask its containing part to reveal one of them. If your part has no display frames, or if your part's containing frame cannot reveal the display frame, your method should open a frame in a new window.

OVERRIDING
When you subclass ODPart, you can override this method. Your override method must not call its inherited method; that is, your override method must implement this method's functionality completely. This method needs to be implemented only by container parts.

EXCEPTIONS

kODErrCannotEmbed
This part does not support embedding.
kODErrInvalidFrame
The specified frame is not an embedded frame of this part.

SEE ALSO
The ODFrame::AcquireContainingFrame method (page 301).
Table 2-1 on page 89 in OpenDoc Programmer's Guide.
"Revealing the Source of a Link" on page 392 in OpenDoc Programmer's Guide.