libs-gui/Headers/AppKit/NSHelpManager.h
Fred Kiefer 53381f6992 Some more #include -> #import replacement.
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/gui/trunk@30036 72102866-910b-0410-8b05-ffd578937521
2010-03-25 21:30:28 +00:00

86 lines
2.3 KiB
Objective-C

/*
NSHelpManager.m
Description...
Copyright (C) 1999 Free Software Foundation, Inc.
Author: Pedro Ivo Andrade Tavares <ptavares@iname.com>
Date: 1999
This file is part of the GNUstep GUI Library.
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; see the file COPYING.LIB.
If not, see <http://www.gnu.org/licenses/> or write to the
Free Software Foundation, 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef __GNUstep_H_NSHelpManager
#define __GNUstep_H_NSHelpManager
#import <GNUstepBase/GSVersionMacros.h>
#import <Foundation/NSBundle.h>
#import <Foundation/NSGeometry.h>
#import <AppKit/NSApplication.h>
@class NSAttributedString;
@class NSString;
@class NSMapTable;
@interface NSBundle (NSHelpManager)
- (NSString *)pathForHelpResource:(NSString *)fileName;
- (NSAttributedString *)contextHelpForKey:(NSString *)key;
@end
@interface NSApplication (NSHelpManager)
- (void) showHelp: (id) sender;
- (void) activateContextHelpMode: (id) sender;
@end
@interface NSHelpManager: NSObject
{
@private
NSMapTable* contextHelpTopics;
}
//
// Class methods
//
+ (NSHelpManager*)sharedHelpManager;
+ (BOOL)isContextHelpModeActive;
+ (void)setContextHelpModeActive: (BOOL) flag;
//
// Instance methods
//
- (NSAttributedString*) contextHelpForObject: (id)object;
- (void) removeContextHelpForObject: (id)object;
- (void)setContextHelp:(NSAttributedString *)help forObject:(id)object;
- (void) setContextHelp: (NSAttributedString*) help withObject: (id) object;
- (BOOL) showContextHelpForObject: (id)object locationHint: (NSPoint) point;
@end
// Notifications
APPKIT_EXPORT NSString* NSContextHelpModeDidActivateNotification;
APPKIT_EXPORT NSString* NSContextHelpModeDidDeactivateNotification;
#endif // GNUstep_H_NSHelpManager