Inside Macintosh: OpenDoc Class Reference /

Part 1 - Classes and Methods / ODArbitrator

AcquireFocusOwner

The AcquireFocusOwner method returns a reference to the frame that owns the specified exclusive focus.

ODFrame AcquireFocusOwner (in ODTypeToken focus);

focus

A tokenized string representing the focus type to be acquired, 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.

A part can obtain a reference to the owner of a specified exclusive focus by calling this method. This method looks up the focus module for the given focus and calls that focus module's AcquireFocusOwner method. If the focus is not registered, then the focus has no focus module and this method is never called.

This method increments the reference count of the returned frame. When you have finished using that frame, you should call its Release method.

SEE ALSO

The ODFocusType type (page 889).
The ODTypeToken type (page 877).
The ODFocusModule::AcquireFocusOwner method (page 268).
The ODSession::Tokenize method (page 622).
Listing 2-30 on page 86 in OpenDoc Cookbook.