Legacy Document

Inside Macintosh: Cyberdog Programmer's Kit / Part 3 - Cyberdog Reference

Chapter 7 - Classes and Methods / CyberSession

ObtainOpener

Retrieves an opener part to be used for the duration of the opening process for a Cyberdog item.

ODPart ObtainOpener (in ODPart openerPart, 
in ODType openerKind, 
in CyberItem item, 
in ParameterSet openParams);

openerPart

The opener part to obtain.

openerKind

The desired OpenDoc part kind of the opener part to be obtained.

item

The CyberItem object that is being opened.

openParams

The ParameterSet object associated with opening process.

return value

An opener part for the CyberItem object.

DISCUSSION

You call this method to obtain an opener part to serve as placeholder in the user interface when the opening process for a Cyberdog item is asynchronous. This method creates an opener part if it needs to and then calls the opener part's BeginOpening method, which adds the opener part to the parameter set.

If you already have an opener part, you can obtain it by passing it to the method in the openerPart parameter. If you pass kODNULL for the openerPart parameter, the method creates a new opener part of the kind specified by the openerKind parameter (kOpenerPartKind or kNavigatorKind, for example). You can set the openerKind parameter to kODNULL if you have no preference for a particular part kind.

This method may return an opener part that is different from the one that is passed in as a parameter. For example, if the opener part passed into ObtainOpener is a navigator and the user has turned off the Browse in Place menu item, the method may return a different navigator.

Do not subclass this class.

SEE ALSO

The CyberOpenerPartExtension::BeginOpening method (page 271).