mirror of
https://github.com/gnustep/libs-gui.git
synced 2025-04-26 05:50:55 +00:00
05bdcda840
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/gui/trunk@12233 72102866-910b-0410-8b05-ffd578937521
532 lines
17 KiB
XML
532 lines
17 KiB
XML
<?xml version="1.0"?>
|
|
<!DOCTYPE gsdoc PUBLIC "-//GNUstep//DTD gsdoc 0.6.7//EN" "http://www.gnustep.org/gsdoc-0_6_7.xml">
|
|
<gsdoc base="NSWorkspace" up="Gui">
|
|
<head>
|
|
<title>NSWorkspace</title>
|
|
<author name="Scott Christley">
|
|
<email address="scottc@net-community.com">
|
|
scottc@net-community.com
|
|
</email>
|
|
</author>
|
|
<author name="Richard Frith-Macdonald">
|
|
<email address="richard@brainstorm.co.uk">
|
|
richard@brainstorm.co.uk
|
|
</email>
|
|
</author>
|
|
<author name="Fred Kiefer">
|
|
<email address="FredKiefer@gmx.de">
|
|
FredKiefer@gmx.de
|
|
</email>
|
|
</author>
|
|
<abstract>Workspace class</abstract>
|
|
<copy>1996-1999, 2001 Free Software Foundation, Inc.</copy>
|
|
</head>
|
|
<body>
|
|
<front><contents /></front>
|
|
<chapter>
|
|
<heading>
|
|
Software documentation for the NSWorkspace class
|
|
</heading>
|
|
<class name="NSWorkspace" super="NSObject">
|
|
<declared>AppKit/NSWorkspace.h</declared>
|
|
<desc>
|
|
<em>Description forthcoming.</em>
|
|
</desc>
|
|
<method type="NSWorkspace*" factory="yes">
|
|
<sel>sharedWorkspace</sel>
|
|
<desc>
|
|
<em>Description forthcoming.</em>
|
|
</desc>
|
|
<standards>
|
|
<GNUstep /> <MacOS-X /> <OpenStep />
|
|
</standards>
|
|
</method>
|
|
<method type="void">
|
|
<sel>checkForRemovableMedia</sel>
|
|
<desc>
|
|
<em>Description forthcoming.</em>
|
|
</desc>
|
|
<standards>
|
|
<GNUstep /> <MacOS-X /> <OpenStep />
|
|
</standards>
|
|
</method>
|
|
<method type="int">
|
|
<sel>extendPowerOffBy:</sel>
|
|
<arg type="int">requested</arg>
|
|
<desc>
|
|
<em>Description forthcoming.</em>
|
|
</desc>
|
|
<standards>
|
|
<GNUstep /> <MacOS-X /> <OpenStep />
|
|
</standards>
|
|
</method>
|
|
<method type="BOOL">
|
|
<sel>fileSystemChanged</sel>
|
|
<desc>
|
|
<em>Description forthcoming.</em>
|
|
</desc>
|
|
<standards>
|
|
<GNUstep /> <MacOS-X /> <OpenStep />
|
|
</standards>
|
|
</method>
|
|
<method type="void">
|
|
<sel>findApplications</sel>
|
|
<desc>
|
|
Updates Registered Services and File Types
|
|
</desc>
|
|
<standards>
|
|
<GNUstep /> <MacOS-X /> <OpenStep />
|
|
</standards>
|
|
</method>
|
|
<method type="NSString*">
|
|
<sel>fullPathForApplication:</sel>
|
|
<arg type="NSString*">appName</arg>
|
|
<desc>
|
|
<em>Description forthcoming.</em>
|
|
</desc>
|
|
<standards>
|
|
<GNUstep /> <MacOS-X /> <OpenStep />
|
|
</standards>
|
|
</method>
|
|
<method type="BOOL">
|
|
<sel>getFileSystemInfoForPath:</sel>
|
|
<arg type="NSString*">fullPath</arg>
|
|
<sel>isRemovable:</sel>
|
|
<arg type="BOOL*">removableFlag</arg>
|
|
<sel>isWritable:</sel>
|
|
<arg type="BOOL*">writableFlag</arg>
|
|
<sel>isUnmountable:</sel>
|
|
<arg type="BOOL*">unmountableFlag</arg>
|
|
<sel>description:</sel>
|
|
<arg type="NSString**">description</arg>
|
|
<sel>type:</sel>
|
|
<arg type="NSString**">fileSystemType</arg>
|
|
<desc>
|
|
<em>Description forthcoming.</em>
|
|
</desc>
|
|
<standards>
|
|
<GNUstep /> <MacOS-X /> <OpenStep />
|
|
</standards>
|
|
</method>
|
|
<method type="BOOL">
|
|
<sel>getInfoForFile:</sel>
|
|
<arg type="NSString*">fullPath</arg>
|
|
<sel>application:</sel>
|
|
<arg type="NSString**">appName</arg>
|
|
<sel>type:</sel>
|
|
<arg type="NSString**">type</arg>
|
|
<desc>
|
|
<em>Description forthcoming.</em>
|
|
</desc>
|
|
<standards>
|
|
<GNUstep /> <MacOS-X /> <OpenStep />
|
|
</standards>
|
|
</method>
|
|
<method type="void">
|
|
<sel>hideOtherApplications</sel>
|
|
<desc>
|
|
<em>Description forthcoming.</em>
|
|
</desc>
|
|
<standards>
|
|
<GNUstep /> <MacOS-X /> <OpenStep />
|
|
</standards>
|
|
</method>
|
|
<method type="NSImage*">
|
|
<sel>iconForFile:</sel>
|
|
<arg type="NSString*">aPath</arg>
|
|
<desc>
|
|
<em>Description forthcoming.</em>
|
|
</desc>
|
|
<standards>
|
|
<GNUstep /> <MacOS-X /> <OpenStep />
|
|
</standards>
|
|
</method>
|
|
<method type="NSImage*">
|
|
<sel>iconForFileType:</sel>
|
|
<arg type="NSString*">fileType</arg>
|
|
<desc>
|
|
<em>Description forthcoming.</em>
|
|
</desc>
|
|
<standards>
|
|
<GNUstep /> <MacOS-X /> <OpenStep />
|
|
</standards>
|
|
</method>
|
|
<method type="NSImage*">
|
|
<sel>iconForFiles:</sel>
|
|
<arg type="NSArray*">pathArray</arg>
|
|
<desc>
|
|
<em>Description forthcoming.</em>
|
|
</desc>
|
|
<standards>
|
|
<GNUstep /> <MacOS-X /> <OpenStep />
|
|
</standards>
|
|
</method>
|
|
<method type="BOOL">
|
|
<sel>isFilePackageAtPath:</sel>
|
|
<arg type="NSString*">fullPath</arg>
|
|
<desc>
|
|
<em>Description forthcoming.</em>
|
|
</desc>
|
|
<standards>
|
|
<NotOpenStep /> <GNUstep /> <MacOS-X />
|
|
</standards>
|
|
</method>
|
|
<method type="BOOL">
|
|
<sel>launchApplication:</sel>
|
|
<arg type="NSString*">appName</arg>
|
|
<desc>
|
|
Calls
|
|
<ref type="method" id="-launchApplication:showIcon:autolaunch:">-launchApplication:showIcon:autolaunch:</ref> with arguments set to show the icon but not set it up as an autolaunch.
|
|
</desc>
|
|
<standards>
|
|
<GNUstep /> <MacOS-X /> <OpenStep />
|
|
</standards>
|
|
</method>
|
|
<method type="BOOL">
|
|
<sel>launchApplication:</sel>
|
|
<arg type="NSString*">appName</arg>
|
|
<sel>showIcon:</sel>
|
|
<arg type="BOOL">showIcon</arg>
|
|
<sel>autolaunch:</sel>
|
|
<arg type="BOOL">autolaunch</arg>
|
|
<desc>
|
|
Launches the specified application (unless it is
|
|
alreeady running)
|
|
</desc>
|
|
<standards>
|
|
<GNUstep /> <MacOS-X /> <OpenStep />
|
|
</standards>
|
|
</method>
|
|
<method type="NSArray*">
|
|
<sel>mountNewRemovableMedia</sel>
|
|
<desc>
|
|
<em>Description forthcoming.</em>
|
|
</desc>
|
|
<standards>
|
|
<GNUstep /> <MacOS-X /> <OpenStep />
|
|
</standards>
|
|
</method>
|
|
<method type="NSArray*">
|
|
<sel>mountedLocalVolumePaths</sel>
|
|
<desc>
|
|
<em>Description forthcoming.</em>
|
|
</desc>
|
|
<standards>
|
|
<NotOpenStep /> <GNUstep /> <MacOS-X />
|
|
</standards>
|
|
</method>
|
|
<method type="NSArray*">
|
|
<sel>mountedRemovableMedia</sel>
|
|
<desc>
|
|
<em>Description forthcoming.</em>
|
|
</desc>
|
|
<standards>
|
|
<GNUstep /> <MacOS-X /> <OpenStep />
|
|
</standards>
|
|
</method>
|
|
<method type="void">
|
|
<sel>noteFileSystemChanged</sel>
|
|
<desc>
|
|
<em>Description forthcoming.</em>
|
|
</desc>
|
|
<standards>
|
|
<GNUstep /> <MacOS-X /> <OpenStep />
|
|
</standards>
|
|
</method>
|
|
<method type="void">
|
|
<sel>noteFileSystemChanged:</sel>
|
|
<arg type="NSString*">path</arg>
|
|
<desc>
|
|
<em>Description forthcoming.</em>
|
|
</desc>
|
|
<standards>
|
|
<NotOpenStep /> <GNUstep /> <MacOS-X />
|
|
</standards>
|
|
</method>
|
|
<method type="void">
|
|
<sel>noteUserDefaultsChanged</sel>
|
|
<desc>
|
|
Simply makes a note that the user defaults database
|
|
has changed.
|
|
</desc>
|
|
<standards>
|
|
<GNUstep /> <MacOS-X /> <OpenStep />
|
|
</standards>
|
|
</method>
|
|
<method type="NSNotificationCenter*">
|
|
<sel>notificationCenter</sel>
|
|
<desc>
|
|
Returns the workspace notification center
|
|
</desc>
|
|
<standards>
|
|
<GNUstep /> <MacOS-X /> <OpenStep />
|
|
</standards>
|
|
</method>
|
|
<method type="BOOL">
|
|
<sel>openFile:</sel>
|
|
<arg type="NSString*">fullPath</arg>
|
|
<desc>
|
|
<em>Description forthcoming.</em>
|
|
</desc>
|
|
<standards>
|
|
<GNUstep /> <MacOS-X /> <OpenStep />
|
|
</standards>
|
|
</method>
|
|
<method type="BOOL">
|
|
<sel>openFile:</sel>
|
|
<arg type="NSString*">fullPath</arg>
|
|
<sel>fromImage:</sel>
|
|
<arg type="NSImage*">anImage</arg>
|
|
<sel>at:</sel>
|
|
<arg type="NSPoint">point</arg>
|
|
<sel>inView:</sel>
|
|
<arg type="NSView*">aView</arg>
|
|
<desc>
|
|
<em>Description forthcoming.</em>
|
|
</desc>
|
|
<standards>
|
|
<GNUstep /> <MacOS-X /> <OpenStep />
|
|
</standards>
|
|
</method>
|
|
<method type="BOOL">
|
|
<sel>openFile:</sel>
|
|
<arg type="NSString*">fullPath</arg>
|
|
<sel>withApplication:</sel>
|
|
<arg type="NSString*">appName</arg>
|
|
<desc>
|
|
<em>Description forthcoming.</em>
|
|
</desc>
|
|
<standards>
|
|
<GNUstep /> <MacOS-X /> <OpenStep />
|
|
</standards>
|
|
</method>
|
|
<method type="BOOL">
|
|
<sel>openFile:</sel>
|
|
<arg type="NSString*">fullPath</arg>
|
|
<sel>withApplication:</sel>
|
|
<arg type="NSString*">appName</arg>
|
|
<sel>andDeactivate:</sel>
|
|
<arg type="BOOL">flag</arg>
|
|
<desc>
|
|
<em>Description forthcoming.</em>
|
|
</desc>
|
|
<standards>
|
|
<GNUstep /> <MacOS-X /> <OpenStep />
|
|
</standards>
|
|
</method>
|
|
<method type="BOOL">
|
|
<sel>openTempFile:</sel>
|
|
<arg type="NSString*">fullPath</arg>
|
|
<desc>
|
|
<em>Description forthcoming.</em>
|
|
</desc>
|
|
<standards>
|
|
<GNUstep /> <MacOS-X /> <OpenStep />
|
|
</standards>
|
|
</method>
|
|
<method type="BOOL">
|
|
<sel>openURL:</sel>
|
|
<arg type="NSURL*">url</arg>
|
|
<desc>
|
|
<em>Description forthcoming.</em>
|
|
</desc>
|
|
<standards>
|
|
<NotOpenStep /> <GNUstep /> <MacOS-X />
|
|
</standards>
|
|
</method>
|
|
<method type="BOOL">
|
|
<sel>performFileOperation:</sel>
|
|
<arg type="NSString*">operation</arg>
|
|
<sel>source:</sel>
|
|
<arg type="NSString*">source</arg>
|
|
<sel>destination:</sel>
|
|
<arg type="NSString*">destination</arg>
|
|
<sel>files:</sel>
|
|
<arg type="NSArray*">files</arg>
|
|
<sel>tag:</sel>
|
|
<arg type="int*">tag</arg>
|
|
<desc>
|
|
<em>Description forthcoming.</em>
|
|
</desc>
|
|
<standards>
|
|
<GNUstep /> <MacOS-X /> <OpenStep />
|
|
</standards>
|
|
</method>
|
|
<method type="BOOL">
|
|
<sel>selectFile:</sel>
|
|
<arg type="NSString*">fullPath</arg>
|
|
<sel>inFileViewerRootedAtPath:</sel>
|
|
<arg type="NSString*">rootFullpath</arg>
|
|
<desc>
|
|
<em>Description forthcoming.</em>
|
|
</desc>
|
|
<standards>
|
|
<GNUstep /> <MacOS-X /> <OpenStep />
|
|
</standards>
|
|
</method>
|
|
<method type="void">
|
|
<sel>slideImage:</sel>
|
|
<arg type="NSImage*">image</arg>
|
|
<sel>from:</sel>
|
|
<arg type="NSPoint">fromPoint</arg>
|
|
<sel>to:</sel>
|
|
<arg type="NSPoint">toPoint</arg>
|
|
<desc>
|
|
Animating an Image- slides it from one point on
|
|
the screen to another.
|
|
</desc>
|
|
<standards>
|
|
<GNUstep /> <MacOS-X /> <OpenStep />
|
|
</standards>
|
|
</method>
|
|
<method type="BOOL">
|
|
<sel>unmountAndEjectDeviceAtPath:</sel>
|
|
<arg type="NSString*">path</arg>
|
|
<desc>
|
|
<em>Description forthcoming.</em>
|
|
</desc>
|
|
<standards>
|
|
<GNUstep /> <MacOS-X /> <OpenStep />
|
|
</standards>
|
|
</method>
|
|
<method type="BOOL">
|
|
<sel>userDefaultsChanged</sel>
|
|
<desc>
|
|
Returns a flag to say if the defaults database has
|
|
changed since the last time this method was called.
|
|
</desc>
|
|
<standards>
|
|
<GNUstep /> <MacOS-X /> <OpenStep />
|
|
</standards>
|
|
</method>
|
|
<standards>
|
|
<GNUstep /> <MacOS-X /> <OpenStep />
|
|
</standards>
|
|
</class>
|
|
</chapter>
|
|
<chapter>
|
|
<heading>
|
|
Software documentation for the NSWorkspace(GNUstep)
|
|
category
|
|
</heading>
|
|
<category name="GNUstep" class="NSWorkspace">
|
|
<declared>AppKit/NSWorkspace.h</declared>
|
|
<desc>
|
|
<em>Description forthcoming.</em>
|
|
</desc>
|
|
<method type="NSImage*">
|
|
<sel>appIconForApp:</sel>
|
|
<arg type="NSString*">appName</arg>
|
|
<desc>
|
|
Returns the application icon for the given app. Or
|
|
null if none defined or <var>appName</var> is not a
|
|
valid application name.
|
|
</desc>
|
|
<standards>
|
|
<NotOpenStep /> <NotMacOS-X /> <GNUstep />
|
|
</standards>
|
|
</method>
|
|
<method type="NSBundle*">
|
|
<sel>bundleForApp:</sel>
|
|
<arg type="NSString*">appName</arg>
|
|
<desc>
|
|
Returns the application bundle for the named
|
|
application.
|
|
</desc>
|
|
<standards>
|
|
<NotOpenStep /> <NotMacOS-X /> <GNUstep />
|
|
</standards>
|
|
</method>
|
|
<method type="NSString*">
|
|
<sel>getBestAppInRole:</sel>
|
|
<arg type="NSString*">role</arg>
|
|
<sel>forExtension:</sel>
|
|
<arg type="NSString*">ext</arg>
|
|
<desc>
|
|
Returns the 'best' application to open a file with
|
|
the specified extension using the given <var>role</var>
|
|
. If the <var>role</var> is <code>nil</code> then apps
|
|
which can edit are preferred but viewers are also
|
|
acceptable. Uses a user preferred app or picks
|
|
any good match.
|
|
</desc>
|
|
<standards>
|
|
<NotOpenStep /> <NotMacOS-X /> <GNUstep />
|
|
</standards>
|
|
</method>
|
|
<method type="NSString*">
|
|
<sel>getBestIconForExtension:</sel>
|
|
<arg type="NSString*">ext</arg>
|
|
<desc>
|
|
Returns the path set for the icon matching the
|
|
image by
|
|
<ref type="method" id="-setBestIcon:forExtension:">
|
|
-setBestIcon:forExtension:
|
|
</ref>
|
|
</desc>
|
|
<standards>
|
|
<NotOpenStep /> <NotMacOS-X /> <GNUstep />
|
|
</standards>
|
|
</method>
|
|
<method type="NSDictionary*">
|
|
<sel>infoForExtension:</sel>
|
|
<arg type="NSString*">ext</arg>
|
|
<desc>
|
|
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.
|
|
</desc>
|
|
<standards>
|
|
<NotOpenStep /> <NotMacOS-X /> <GNUstep />
|
|
</standards>
|
|
</method>
|
|
<method type="NSString*">
|
|
<sel>locateApplicationBinary:</sel>
|
|
<arg type="NSString*">appName</arg>
|
|
<desc>
|
|
Requires the path to an application wrapper as an
|
|
argument, and returns the full path to the
|
|
executable.
|
|
</desc>
|
|
<standards>
|
|
<NotOpenStep /> <NotMacOS-X /> <GNUstep />
|
|
</standards>
|
|
</method>
|
|
<method type="void">
|
|
<sel>setBestApp:</sel>
|
|
<arg type="NSString*">appName</arg>
|
|
<sel>inRole:</sel>
|
|
<arg type="NSString*">role</arg>
|
|
<sel>forExtension:</sel>
|
|
<arg type="NSString*">ext</arg>
|
|
<desc>
|
|
Sets up a user preference for which app should be used
|
|
to open files of the specified extension.
|
|
</desc>
|
|
<standards>
|
|
<NotOpenStep /> <NotMacOS-X /> <GNUstep />
|
|
</standards>
|
|
</method>
|
|
<method type="void">
|
|
<sel>setBestIcon:</sel>
|
|
<arg type="NSString*">iconPath</arg>
|
|
<sel>forExtension:</sel>
|
|
<arg type="NSString*">ext</arg>
|
|
<desc>
|
|
Sets up a user preference for which icon should be
|
|
used to represent the specified file extension.
|
|
</desc>
|
|
<standards>
|
|
<NotOpenStep /> <NotMacOS-X /> <GNUstep />
|
|
</standards>
|
|
</method>
|
|
<standards>
|
|
<NotOpenStep /> <NotMacOS-X /> <GNUstep />
|
|
</standards>
|
|
</category>
|
|
</chapter>
|
|
</body>
|
|
</gsdoc>
|