This is Module.rtf in view mode; [Download] [Up]
Release 2.5, Copyright ©1997 by Sean Luke. All Rights Reserved. Module Subclass Of: Object Declared In: Module.h Class Description All modules you create should subclass from Module. Module contains two data items that are defined when the instance is initialized: TheModuleController is the instance that "speaks" to modules, using the protocol ModuleProtocol You don't need to know anything more about the Module Controller other than that it is responsible for loading, maintaining, and communicating with modules, and that it is your gateway to communicating with Resound. You send messages to and receive messages from TheModuleController in order to manipulate sound information in Resound. TheModuleMenuNode is the root node of your node tree for menu items you want to create in Resound's Modules menu. This is initially set to NULLÐyou are responsible for setting it a ModuleMenuNode, and setting up that node and its subnodes. For more information on this, see ModuleMenuNode.h . Always set up menu node information by overriding init, but remember to call [super init] first. There are three chief methods in Module: init: where you set up your ModuleMenuNode. See above. setModuleControllerTo: Resound calls this to set up TheModuleController. You should ignore this call. getModuleMenuNode: Resound calls this to get your ModuleMenuNode. It is called soon after init:, so be sure to have your node set up by then. In addition, Module provides overridable auxillary methods to automatically inform your module about changes in the system. Instance Variables id <ModuleProtocol> TheModuleController; id TheModuleMenuNode; TheModuleController The Module's interface object to Resound. TheModuleMenuNode The root ModuleMenuNode for the Module. Method Types Object Maintenance ± free ± init Informing the Module ± soundDidChange ± nowPlaying ± nowRecording ± didPlay ± didRecord Resound's Private API Setup ± getModuleMenuNode ± setModuleControllerTo: Instance Methods didPlay - didPlay Informs the module that a sound has just finished playing. didRecord - didRecord Informs the module that a sound has just finished recording. getModuleMenuNode: - getModuleMenuNode A private method for Resound, which returns TheModuleMenuNode. free - free Frees the Module. This also frees TheModuleMenuNode and all of its subsidiary ModuleMenuNodes you have set up; you don't have to free them yourself. init - init Initializes the Module. You should override this method to set up your ModuleMenuNodes. However, unlike standard NeXTSTEP practice, be certain to call [super init] before anything else. nowPlaying - nowPlaying Informs the module that a sound is now playing. nowRecording - nowRecording Informs the module that a sound is now recording. setModuleControllerTo: - setModuleControllerTo:theModuleController A private method for Resound, which sets TheModuleController upon dynamic loading of the module. Don't fool with this. soundDidChange - soundDidChange Informs the module that the current sound may have changed. Note: This may be called twice for the same sound change.
These are the contents of the former NiCE NeXT User Group NeXTSTEP/OpenStep software archive, currently hosted by Netfuture.ch.