Inside Macintosh: OpenDoc Class Reference /

Part 1 - Classes and Methods / ODFocusModule

IsFocusExclusive

The IsFocusExclusive method should return a Boolean value that indicates whether the specified focus is exclusive.

ODBoolean IsFocusExclusive (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 exclusive, 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.

Foci may be exclusive or nonexclusive. All of the standard foci defined by OpenDoc are exclusive, meaning that only one frame at a time can own the focus. If you create a new kind of focus, you can make it nonexclusive, meaning that several frames could share ownership of it.

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 ODSession::Tokenize method (page 622).
"Focus Modules for Nonexlusive Foci" on page 450 in OpenDoc Programmer's Guide.