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

Chapter 7 - Classes and Methods

CyberServiceMenu

Superclasses

ODObject

Subclasses

none

An object of the CyberServiceMenu class is used to represent the Cyberdog service-related menus that a Cyberdog display part adds to the menu bar.

Description

The CyberServiceMenu class represents the Cyberdog menu and all of the menus added to the menu bar by all Cyberdog services. A single service menu object represents the Cyberdog menu as well as all of the menus added to the menu bar by all Cyberdog services.

A Cyberdog display part can choose to add these service-related menus to the menu bar when the part gets the menu focus. If you want to display the Cyberdog menu and service-specific menus when your Cyberdog display part has the menu focus, you should create and initialize a single CyberServiceMenu object when you initialize your display part. Every display part that wants to display the service-related menus must create a service menu object. In addition, your display part needs to do the following things:

• When your display part handles kODEvtMenu events, it should call DoCommand to give Cyberdog services the opportunity to handle their own menu commands.
• When your display part adjusts menus, it should call Adjust to allow Cyberdog services to adjust their menus.
• When your display part acquires the menu focus, it should call MenuFocusAcquired to allow Cyberdog services to install their menus. When your display part loses the menu focus, it should call MenuFocusLost to allow Cyberdog services to remove their menus.

Each service menu object has a base menu command ID, which should be in the range allowed by OpenDoc. All service-related menu commands are specified as offsets from a service menu object's base command ID. As a display part developer, you specify the base menu command ID to be used for the service menu object when you call ICyberServiceMenu to initialize the object. For more information on registering menu command IDs with OpenDoc, see the chapter on windows and menus in OpenDoc Programmer's Guide.

Do not subclass this class.

Methods

This section presents summary descriptions of the CyberServiceMenu methods grouped according to purpose, followed by detailed descriptions.

Initialization and Cleanup

ICyberServiceMenu

Initializes this Cyberdog service menu object.

Modifying Menus

Adjust

Adjusts the menus represented by this Cyberdog service menu object.

MenuFocusAcquired

Notifies this Cyberdog service menu object that its associated display part has acquired the focus.

MenuFocusLost

Notifies this Cyberdog service menu object that its associated display part has lost the focus.

Performing Menu Commands

DoCommand

Handles a menu event for this Cyberdog service menu object.

---

Methods

Adjust

DoCommand

ICyberServiceMenu

MenuFocusAcquired

MenuFocusLost