Inside Macintosh: OpenDoc Class Reference /

Part 1 - Classes and Methods / ODFocusModule

BeginRelinquishFocus

The BeginRelinquishFocus method should return a Boolean value that indicates whether the current owner of the specified exclusive focus is willing to give up ownership of the focus.

ODBoolean BeginRelinquishFocus (
                              in ODTypeToken focus, 
                              in ODFrame requestingFrame);

focus

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

requestingFrame

A reference to the frame requesting ownership of the focus.

return value

kODTrue if the current owner of the specified exclusive focus is willing to give up ownership of the focus, otherwise kODFalse.

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, which in turns calls the BeginRelinquishFocus method of the part that owns the focus. If the part's BeginRelinquishFocus method returns kODTrue (the typical case), this method should return kODTrue; if the part's BeginRelinquishFocus method returns kODFalse, this method should return kODFalse.

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 ODFocusModule::AbortRelinquishFocus method (page 267).
The ODFocusModule::CommitRelinquishFocus method (page 270).
The ODPart::BeginRelinquishFocus method (page 482).
The ODSession::Tokenize method (page 622).