Inside Macintosh: OpenDoc Class Reference /

Part 1 - Classes and Methods / ODFocusModule

TransferFocusOwnership

The TransferFocusOwnership method should transfer ownership of the specified focus from one frame to another frame.

void TransferFocusOwnership (in ODTypeToken focus,
                             in ODFrame transferringFrame, 
                             in ODFrame newOwner);

focus

A tokenized string representing the focus type to be transferred, expressed as a 32-bit value.

transferringFrame

A reference to a frame relinquishing ownership of the focus; it does not have to be the current owner of the focus.

newOwner

A reference to a frame obtaining ownership of the focus.

DISCUSSION

The focus parameter must be the tokenized form of one of the focus constants (kODClipboardFocus, kODKeyFocus, kODMenuFocus, kODModalFocus, kODMouseFocus, kODScrollingFocus, or kODSelectionFocus) or the tokenized form of a part-specific focus type. You can call the session object's Tokenize method to obtain a token corresponding to one of these constants.

OpenDoc calls this method. This method should record, in this focus module's internal structures, the transfer of focus ownership.

OVERRIDING

If you subclass ODFocusModule, you must override this method. Your override method must not call its inherited method; that is, your override method must implement this method's functionality completely.

SEE ALSO

The ODFocusType type (page 889).
The ODTypeToken type (page 877).
The ODSession::Tokenize method (page 622).
"Creating a Focus Module" on page 448 in OpenDoc Programmer's Guide.