Up

NSWorkspace

Authors

Scott Christley( scottc@net-community.com )
Richard Frith-Macdonald( richard@brainstorm.co.uk )
Fred Kiefer( FredKiefer@gmx.de )
Workspace class

Copyright: (C) 1996-1999, 2001 Free Software Foundation, Inc.


Contents -

  1. Software documentation for the NSWorkspace class
  2. Software documentation for the NSWorkspace(GNUstep) category

Software documentation for the NSWorkspace class

NSWorkspace : NSObject

Declared in:
AppKit/NSWorkspace.h
Standards:

Description forthcoming.

Method summary

sharedWorkspace

+ (NSWorkspace*) sharedWorkspace;

Description forthcoming.


checkForRemovableMedia

- (void) checkForRemovableMedia;

Description forthcoming.


extendPowerOffBy:

- (int) extendPowerOffBy: (int)requested;

Description forthcoming.


fileSystemChanged

- (BOOL) fileSystemChanged;

Description forthcoming.


findApplications

- (void) findApplications;

Updates Registered Services and File Types


fullPathForApplication:

- (NSString*) fullPathForApplication: (NSString*)appName;

Given an application name, return the full path for that application.
This method looks for the application in standard locations, and if not found there, according to MacOS-X documentation, returns nil.
If the supplied application name is an absolute path, returns that path irrespective of whether such an application exists or not. This is not the docmented debavior in the MacOS-X documentation, but is the MacOS-X implemented behavior.
If the appName has an extension, it is used, otherwise in GNUstep the standard app, debug, and profile extensions * are tried.


getFileSystemInfoForPath:isRemovable:isWritable:isUnmountable:description:type:

- (BOOL) getFileSystemInfoForPath: (NSString*)fullPath isRemovable: (BOOL*)removableFlag isWritable: (BOOL*)writableFlag isUnmountable: (BOOL*)unmountableFlag description: (NSString**)description type: (NSString**)fileSystemType;

Description forthcoming.


getInfoForFile:application:type:

- (BOOL) getInfoForFile: (NSString*)fullPath application: (NSString**)appName type: (NSString**)type;

Description forthcoming.


hideOtherApplications

- (void) hideOtherApplications;

Description forthcoming.


iconForFile:

- (NSImage*) iconForFile: (NSString*)aPath;

Description forthcoming.


iconForFileType:

- (NSImage*) iconForFileType: (NSString*)fileType;

Description forthcoming.


iconForFiles:

- (NSImage*) iconForFiles: (NSArray*)pathArray;

Description forthcoming.


isFilePackageAtPath:

- (BOOL) isFilePackageAtPath: (NSString*)fullPath;

Description forthcoming.


launchApplication:

- (BOOL) launchApplication: (NSString*)appName;

Calls -launchApplication:showIcon:autolaunch: with arguments set to show the icon but not set it up as an autolaunch.


launchApplication:showIcon:autolaunch:

- (BOOL) launchApplication: (NSString*)appName showIcon: (BOOL)showIcon autolaunch: (BOOL)autolaunch;

Launches the specified application (unless it is alreeady running)


mountNewRemovableMedia

- (NSArray*) mountNewRemovableMedia;

Description forthcoming.


mountedLocalVolumePaths

- (NSArray*) mountedLocalVolumePaths;

Description forthcoming.


mountedRemovableMedia

- (NSArray*) mountedRemovableMedia;

Description forthcoming.


noteFileSystemChanged

- (void) noteFileSystemChanged;

Description forthcoming.


noteFileSystemChanged:

- (void) noteFileSystemChanged: (NSString*)path;

Description forthcoming.


noteUserDefaultsChanged

- (void) noteUserDefaultsChanged;

Simply makes a note that the user defaults database has changed.


notificationCenter

- (NSNotificationCenter*) notificationCenter;

Returns the workspace notification center


openFile:

- (BOOL) openFile: (NSString*)fullPath;

Description forthcoming.


openFile:fromImage:at:inView:

- (BOOL) openFile: (NSString*)fullPath fromImage: (NSImage*)anImage at: (NSPoint)point inView: (NSView*)aView;

Description forthcoming.


openFile:withApplication:

- (BOOL) openFile: (NSString*)fullPath withApplication: (NSString*)appName;

Description forthcoming.


openFile:withApplication:andDeactivate:

- (BOOL) openFile: (NSString*)fullPath withApplication: (NSString*)appName andDeactivate: (BOOL)flag;

Description forthcoming.


openTempFile:

- (BOOL) openTempFile: (NSString*)fullPath;

Description forthcoming.


openURL:

- (BOOL) openURL: (NSURL*)url;

Description forthcoming.


performFileOperation:source:destination:files:tag:

- (BOOL) performFileOperation: (NSString*)operation source: (NSString*)source destination: (NSString*)destination files: (NSArray*)files tag: (int*)tag;

Description forthcoming.


selectFile:inFileViewerRootedAtPath:

- (BOOL) selectFile: (NSString*)fullPath inFileViewerRootedAtPath: (NSString*)rootFullpath;

Description forthcoming.


slideImage:from:to:

- (void) slideImage: (NSImage*)image from: (NSPoint)fromPoint to: (NSPoint)toPoint;

Animating an Image- slides it from one point on the screen to another.


unmountAndEjectDeviceAtPath:

- (BOOL) unmountAndEjectDeviceAtPath: (NSString*)path;

Description forthcoming.


userDefaultsChanged

- (BOOL) userDefaultsChanged;

Returns a flag to say if the defaults database has changed since the last time this method was called.


Software documentation for the NSWorkspace(GNUstep) category

NSWorkspace(GNUstep)

Declared in:
AppKit/NSWorkspace.h
Standards:

Description forthcoming.

Method summary

appIconForApp:

- (NSImage*) appIconForApp: (NSString*)appName;

Returns the application icon for the given app. Or null if none defined or appName is not a valid application name.


bundleForApp:

- (NSBundle*) bundleForApp: (NSString*)appName;

Returns the application bundle for the named application. Accepts either a full path to an app or just the name. The extension (.app,.debug, .profile) is optional, but if provided it will be used.
Returns nil if the specified app does not exist as requested.


getBestAppInRole:forExtension:

- (NSString*) getBestAppInRole: (NSString*)role forExtension: (NSString*)ext;

Returns the 'best' application to open a file with the specified extension using the given role . If the role is nil then apps which can edit are preferred but viewers are also acceptable. Uses a user preferred app or picks any good match.


getBestIconForExtension:

- (NSString*) getBestIconForExtension: (NSString*)ext;

Returns the path set for the icon matching the image by -setBestIcon:forExtension:


infoForExtension:

- (NSDictionary*) infoForExtension: (NSString*)ext;

Gets the applications cache (generated by the make_services tool) and looks up the special entry that contains a dictionary of all file extensions recognised by GNUstep applications. Then finds the dictionary of applications that can handle our file and returns it.


locateApplicationBinary:

- (NSString*) locateApplicationBinary: (NSString*)appName;

Requires the path to an application wrapper as an argument, and returns the full path to the executable.


setBestApp:inRole:forExtension:

- (void) setBestApp: (NSString*)appName inRole: (NSString*)role forExtension: (NSString*)ext;

Sets up a user preference for which app should be used to open files of the specified extension.


setBestIcon:forExtension:

- (void) setBestIcon: (NSString*)iconPath forExtension: (NSString*)ext;

Sets up a user preference for which icon should be used to represent the specified file extension.



Up