(Preliminary Documentation) Copyright ã1994 by NeXT Computer, Inc.  All Rights Reserved.

NSHelpPanel 

Inherits From:	NSPanel : NSWindow : NSResponder : NSObject 

Declared In:	appkit/NSHelpPanel.h 

Accessing the Help Panel

+ (NSHelpPanel *)sharedHelpPanel	Creates, if necessary, and returns the NSHelpPanel object. 
+ (NSHelpPanel *)sharedHelpPanelWithDirectory:(NSString *)helpDirectory
	Creates, if necessary, and returns the NSHelpPanel object.  If the panel is created, it loads the help directory specified by helpDirectory.  The help directory must reside in the main bundle.  If a Help panel already exists but has loaded a help directory other than helpDirectory, a second panel will be created.

Managing the Contents

+ (void)setHelpDirectory:(NSString *)helpDirectory	Initializes the panel to display the help text found in helpDirectory.  By default, the receiver looks for a directory named ªHelpº.
- (void)addSupplement:(NSString *)helpDirectory	 
inPath:(NSString *)supplementPath	Append additional help entries to the Help panel's table of contents.
- (NSString *)helpDirectory	Returns the absolute path of the help directory. 
- (NSString *)helpFile	Returns the path of the currently loaded help file. 

Attaching Help to Objects 

+ attachHelpFile:(NSString *)filename	Associates the help file filename and markerName with
markerName:(NSString *)markerName		anObject. 
to:anObject
+ detachHelpFrom:anObject	Removes any help information associated with anObject. 

Showing Help 

- (void)showFile:(NSString *)filename	Causes the panel to display the help contained in filename
atMarker:(NSString *)markerName		at markerName. 
- (BOOL)showHelpAttachedTo:(id)anObject	Causes the panel to display help attached to anObject. 

Printing 

- (void)print:(id)sender	Prints the currently displayed help text.