AbortRelinquishFocus

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

AbortRelinquishFocus
The AbortRelinquishFocus method should cancel the request for the frame to relinquish ownership of the specified exclusive focus.
void AbortRelinquishFocus (in ODTypeToken focus, 
                           in ODFrame requestingFrame);
focus
A tokenized string representing the focus type that was to be relinquished, expressed as a 32-bit value.
requestingFrame
A reference to a frame that originally requested 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, which in turns calls the AbortRelinquishFocus method of the part that owns the focus. This method should give those focus owners who have indicated willingness to relinquish the focus an opportunity to back out of changes initiated when OpenDoc first called the part's BeginRelinquishFocus method.

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::BeginRelinquishFocus method (page 269).
The ODFocusModule::CommitRelinquishFocus method (page 270).
The ODPart::AbortRelinquishFocus method (page 475).
The ODPart::BeginRelinquishFocus method (page 482).
The ODSession::Tokenize method (page 622).
"Creating a Focus Module" on page 448 in OpenDoc Programmer's Guide.