Inside Macintosh: OpenDoc Class Reference /

Part 1 - Classes and Methods / ODArbitrator

IsFocusRegistered

The IsFocusRegistered method returns a Boolean value that indicates whether the specified focus is registered.

ODBoolean IsFocusRegistered (in ODTypeToken focus);

focus

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

return value

kODTrue if the specified focus is registered, 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.

A focus is registered if it has a focus module.

SEE ALSO

The ODFocusType type (page 889).
The ODTypeToken type (page 877).
The ODSession::Tokenize method (page 622).