AcquireFocusOwner

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

AcquireFocusOwner
The AcquireFocusOwner method should return a reference to the frame that owns the specified exclusive focus.
ODFrame AcquireFocusOwner (in ODTypeToken focus);
focus
A tokenized string representing the focus type whose owner is desired, expressed as a 32-bit value.
return value
A reference to the frame that owns the specified exclusive focus, or kODNULL if the focus is not owned by any frame.

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. A part can obtain a reference to the owner of a specified exclusive focus by calling the arbitrator's AcquireFocusOwner method, which in turn calls this method. If the focus is not registered, then the focus has no focus module and this method is never called.
Before returning the frame object, your override method should call the frame object's Acquire method. When the caller has finished using the returned frame object, it should call the frame object's Release 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 ODArbitrator::AcquireFocusOwner method (page 268).
The ODSession::Tokenize method (page 622).
"Creating a Focus Module" on page 448 in OpenDoc Programmer's Guide.