2000-02-28 16:33:27 +00:00
|
|
|
<?xml version="1.0"?>
|
2001-12-17 16:51:51 +00:00
|
|
|
<!DOCTYPE gsdoc PUBLIC "-//GNUstep//DTD gsdoc 0.6.7//EN" "http://www.gnustep.org/gsdoc-0_6_7.xml">
|
|
|
|
|
<gsdoc base="NSImage" next="NSImageCell" prev="NSHelpManager" up="NSActionCell">
|
2000-02-28 16:33:27 +00:00
|
|
|
<head>
|
|
|
|
|
<title>NSImage</title>
|
2001-12-17 16:51:51 +00:00
|
|
|
<author name="Adam Fedor">
|
|
|
|
|
<email address="fedor@colorado.edu">
|
|
|
|
|
fedor@colorado.edu
|
|
|
|
|
</email>
|
2000-02-28 16:33:27 +00:00
|
|
|
</author>
|
2001-12-17 16:51:51 +00:00
|
|
|
<abstract>Load, manipulate and display images</abstract>
|
|
|
|
|
<copy>1996 Free Software Foundation, Inc.</copy>
|
2000-02-28 16:33:27 +00:00
|
|
|
</head>
|
|
|
|
|
<body>
|
|
|
|
|
<chapter>
|
2001-12-17 16:51:51 +00:00
|
|
|
<heading>
|
|
|
|
|
Software documentation for the NSImage class
|
|
|
|
|
</heading>
|
2000-02-28 16:33:27 +00:00
|
|
|
<class name="NSImage" super="NSObject">
|
2001-12-17 16:51:51 +00:00
|
|
|
<declared>AppKit/NSImage.h</declared>
|
2000-02-28 16:33:27 +00:00
|
|
|
<conform>NSCoding</conform>
|
2001-12-17 16:51:51 +00:00
|
|
|
<conform>NSCopying</conform>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
2000-02-29 11:01:41 +00:00
|
|
|
<method type="BOOL" factory="yes">
|
|
|
|
|
<sel>canInitWithPasteboard:</sel>
|
|
|
|
|
<arg type="NSPasteboard*">pasteboard</arg>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="NSArray*" factory="yes">
|
|
|
|
|
<sel>imageFileTypes</sel>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="id" factory="yes">
|
|
|
|
|
<sel>imageNamed:</sel>
|
2001-12-17 16:51:51 +00:00
|
|
|
<arg type="NSString*">aName</arg>
|
2000-02-29 11:01:41 +00:00
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="NSArray*" factory="yes">
|
|
|
|
|
<sel>imagePasteboardTypes</sel>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="NSArray*" factory="yes">
|
|
|
|
|
<sel>imageUnfilteredFileTypes</sel>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="NSArray*" factory="yes">
|
|
|
|
|
<sel>imageUnfilteredPasteboardTypes</sel>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
2001-12-17 16:51:51 +00:00
|
|
|
<method type="NSData*">
|
|
|
|
|
<sel>TIFFRepresentation</sel>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="NSData*">
|
|
|
|
|
<sel>TIFFRepresentationUsingCompression:</sel>
|
|
|
|
|
<arg type="NSTIFFCompression">comp</arg>
|
|
|
|
|
<sel>factor:</sel>
|
|
|
|
|
<arg type="float">aFloat</arg>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
2000-02-29 11:01:41 +00:00
|
|
|
<method type="void">
|
|
|
|
|
<sel>addRepresentation:</sel>
|
|
|
|
|
<arg type="NSImageRep*">imageRep</arg>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="void">
|
|
|
|
|
<sel>addRepresentations:</sel>
|
2001-12-17 16:51:51 +00:00
|
|
|
<arg type="NSArray*">imageRepArray</arg>
|
2000-02-29 11:01:41 +00:00
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="NSColor*">
|
|
|
|
|
<sel>backgroundColor</sel>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="NSImageRep*">
|
|
|
|
|
<sel>bestRepresentationForDevice:</sel>
|
|
|
|
|
<arg type="NSDictionary*">deviceDescription</arg>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="BOOL">
|
|
|
|
|
<sel>cacheDepthMatchesImageDepth</sel>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="void">
|
|
|
|
|
<sel>compositeToPoint:</sel>
|
|
|
|
|
<arg type="NSPoint">aPoint</arg>
|
|
|
|
|
<sel>fromRect:</sel>
|
|
|
|
|
<arg type="NSRect">aRect</arg>
|
|
|
|
|
<sel>operation:</sel>
|
|
|
|
|
<arg type="NSCompositingOperation">op</arg>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="void">
|
|
|
|
|
<sel>compositeToPoint:</sel>
|
|
|
|
|
<arg type="NSPoint">aPoint</arg>
|
2001-12-17 16:51:51 +00:00
|
|
|
<sel>fromRect:</sel>
|
|
|
|
|
<arg type="NSRect">srcRect</arg>
|
2000-02-29 11:01:41 +00:00
|
|
|
<sel>operation:</sel>
|
|
|
|
|
<arg type="NSCompositingOperation">op</arg>
|
2001-12-17 16:51:51 +00:00
|
|
|
<sel>fraction:</sel>
|
|
|
|
|
<arg type="float">delta</arg>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="void">
|
|
|
|
|
<sel>compositeToPoint:</sel>
|
|
|
|
|
<arg type="NSPoint">aPoint</arg>
|
|
|
|
|
<sel>operation:</sel>
|
|
|
|
|
<arg type="NSCompositingOperation">op</arg>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="void">
|
|
|
|
|
<sel>compositeToPoint:</sel>
|
|
|
|
|
<arg type="NSPoint">aPoint</arg>
|
|
|
|
|
<sel>operation:</sel>
|
|
|
|
|
<arg type="NSCompositingOperation">op</arg>
|
|
|
|
|
<sel>fraction:</sel>
|
|
|
|
|
<arg type="float">delta</arg>
|
2000-02-29 11:01:41 +00:00
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="id">
|
|
|
|
|
<sel>delegate</sel>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="void">
|
|
|
|
|
<sel>dissolveToPoint:</sel>
|
|
|
|
|
<arg type="NSPoint">aPoint</arg>
|
|
|
|
|
<sel>fraction:</sel>
|
|
|
|
|
<arg type="float">aFloat</arg>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="void">
|
|
|
|
|
<sel>dissolveToPoint:</sel>
|
|
|
|
|
<arg type="NSPoint">aPoint</arg>
|
|
|
|
|
<sel>fromRect:</sel>
|
|
|
|
|
<arg type="NSRect">aRect</arg>
|
|
|
|
|
<sel>fraction:</sel>
|
|
|
|
|
<arg type="float">aFloat</arg>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
2001-12-17 16:51:51 +00:00
|
|
|
<method type="void">
|
|
|
|
|
<sel>drawAtPoint:</sel>
|
|
|
|
|
<arg type="NSPoint">point</arg>
|
|
|
|
|
<sel>fromRect:</sel>
|
|
|
|
|
<arg type="NSRect">srcRect</arg>
|
|
|
|
|
<sel>operation:</sel>
|
|
|
|
|
<arg type="NSCompositingOperation">op</arg>
|
|
|
|
|
<sel>fraction:</sel>
|
|
|
|
|
<arg type="float">delta</arg>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="void">
|
|
|
|
|
<sel>drawInRect:</sel>
|
|
|
|
|
<arg type="NSRect">dstRect</arg>
|
|
|
|
|
<sel>fromRect:</sel>
|
|
|
|
|
<arg type="NSRect">srcRect</arg>
|
|
|
|
|
<sel>operation:</sel>
|
|
|
|
|
<arg type="NSCompositingOperation">op</arg>
|
|
|
|
|
<sel>fraction:</sel>
|
|
|
|
|
<arg type="float">delta</arg>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
2000-02-29 11:01:41 +00:00
|
|
|
<method type="BOOL">
|
|
|
|
|
<sel>drawRepresentation:</sel>
|
|
|
|
|
<arg type="NSImageRep*">imageRep</arg>
|
2001-12-17 16:51:51 +00:00
|
|
|
<sel>inRect:</sel>
|
|
|
|
|
<arg type="NSRect">aRect</arg>
|
2000-02-29 11:01:41 +00:00
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="id">
|
|
|
|
|
<sel>initByReferencingFile:</sel>
|
2001-12-17 16:51:51 +00:00
|
|
|
<arg type="NSString*">fileName</arg>
|
2000-02-29 11:01:41 +00:00
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="id">
|
|
|
|
|
<sel>initWithBitmapHandle:</sel>
|
|
|
|
|
<arg type="void*">bitmap</arg>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="id">
|
|
|
|
|
<sel>initWithContentsOfFile:</sel>
|
2001-12-17 16:51:51 +00:00
|
|
|
<arg type="NSString*">fileName</arg>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="id">
|
|
|
|
|
<sel>initWithContentsOfURL:</sel>
|
|
|
|
|
<arg type="NSURL*">anURL</arg>
|
2000-02-29 11:01:41 +00:00
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="id">
|
|
|
|
|
<sel>initWithData:</sel>
|
|
|
|
|
<arg type="NSData*">data</arg>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="id">
|
|
|
|
|
<sel>initWithIconHandle:</sel>
|
|
|
|
|
<arg type="void*">icon</arg>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="id">
|
|
|
|
|
<sel>initWithPasteboard:</sel>
|
|
|
|
|
<arg type="NSPasteboard*">pasteboard</arg>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="id">
|
|
|
|
|
<sel>initWithSize:</sel>
|
|
|
|
|
<arg type="NSSize">aSize</arg>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="BOOL">
|
|
|
|
|
<sel>isCachedSeparately</sel>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="BOOL">
|
|
|
|
|
<sel>isDataRetained</sel>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="BOOL">
|
|
|
|
|
<sel>isFlipped</sel>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="BOOL">
|
|
|
|
|
<sel>isValid</sel>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="void">
|
|
|
|
|
<sel>lockFocus</sel>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="void">
|
|
|
|
|
<sel>lockFocusOnRepresentation:</sel>
|
2001-12-17 16:51:51 +00:00
|
|
|
<arg type="NSImageRep*">imageRep</arg>
|
2000-02-29 11:01:41 +00:00
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="BOOL">
|
|
|
|
|
<sel>matchesOnMultipleResolution</sel>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="NSString*">
|
|
|
|
|
<sel>name</sel>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="BOOL">
|
|
|
|
|
<sel>prefersColorMatch</sel>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="void">
|
|
|
|
|
<sel>recache</sel>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="void">
|
|
|
|
|
<sel>removeRepresentation:</sel>
|
|
|
|
|
<arg type="NSImageRep*">imageRep</arg>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="NSArray*">
|
|
|
|
|
<sel>representations</sel>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="BOOL">
|
|
|
|
|
<sel>scalesWhenResized</sel>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="void">
|
|
|
|
|
<sel>setBackgroundColor:</sel>
|
|
|
|
|
<arg type="NSColor*">aColor</arg>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="void">
|
|
|
|
|
<sel>setCacheDepthMatchesImageDepth:</sel>
|
|
|
|
|
<arg type="BOOL">flag</arg>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="void">
|
|
|
|
|
<sel>setCachedSeparately:</sel>
|
|
|
|
|
<arg type="BOOL">flag</arg>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="void">
|
|
|
|
|
<sel>setDataRetained:</sel>
|
|
|
|
|
<arg type="BOOL">flag</arg>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="void">
|
|
|
|
|
<sel>setDelegate:</sel>
|
|
|
|
|
<arg type="id">anObject</arg>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="void">
|
|
|
|
|
<sel>setFlipped:</sel>
|
|
|
|
|
<arg type="BOOL">flag</arg>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="void">
|
|
|
|
|
<sel>setMatchesOnMultipleResolution:</sel>
|
|
|
|
|
<arg type="BOOL">flag</arg>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="BOOL">
|
|
|
|
|
<sel>setName:</sel>
|
2001-12-17 16:51:51 +00:00
|
|
|
<arg type="NSString*">string</arg>
|
2000-02-29 11:01:41 +00:00
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="void">
|
|
|
|
|
<sel>setPrefersColorMatch:</sel>
|
|
|
|
|
<arg type="BOOL">flag</arg>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="void">
|
|
|
|
|
<sel>setScalesWhenResized:</sel>
|
|
|
|
|
<arg type="BOOL">flag</arg>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="void">
|
|
|
|
|
<sel>setSize:</sel>
|
|
|
|
|
<arg type="NSSize">aSize</arg>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="void">
|
|
|
|
|
<sel>setUsesEPSOnResolutionMismatch:</sel>
|
|
|
|
|
<arg type="BOOL">flag</arg>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="NSSize">
|
|
|
|
|
<sel>size</sel>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="void">
|
|
|
|
|
<sel>unlockFocus</sel>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="BOOL">
|
|
|
|
|
<sel>usesEPSOnResolutionMismatch</sel>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
2001-12-17 16:51:51 +00:00
|
|
|
</class>
|
|
|
|
|
</chapter>
|
|
|
|
|
<chapter>
|
|
|
|
|
<heading>
|
|
|
|
|
Software documentation for the
|
|
|
|
|
NSBundle(NSImageAdditions) category
|
|
|
|
|
</heading>
|
|
|
|
|
<category name="NSImageAdditions" class="NSBundle">
|
|
|
|
|
<declared>AppKit/NSImage.h</declared>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
<method type="NSString*">
|
|
|
|
|
<sel>pathForImageResource:</sel>
|
|
|
|
|
<arg type="NSString*">name</arg>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
</category>
|
|
|
|
|
</chapter>
|
|
|
|
|
<chapter>
|
|
|
|
|
<heading>
|
|
|
|
|
Software documentation for the GSImageDelegateProtocol
|
|
|
|
|
protocol
|
|
|
|
|
</heading>
|
|
|
|
|
<protocol name="GSImageDelegateProtocol">
|
|
|
|
|
<declared>AppKit/NSImage.h</declared>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
2000-02-29 11:01:41 +00:00
|
|
|
<method type="NSImage*">
|
|
|
|
|
<sel>imageDidNotDraw:</sel>
|
|
|
|
|
<arg type="id">sender</arg>
|
2001-12-17 16:51:51 +00:00
|
|
|
<sel>inRect:</sel>
|
|
|
|
|
<arg type="NSRect">aRect</arg>
|
2000-02-29 11:01:41 +00:00
|
|
|
<desc>
|
|
|
|
|
</desc>
|
2000-02-28 18:37:00 +00:00
|
|
|
</method>
|
2001-12-17 16:51:51 +00:00
|
|
|
</protocol>
|
2000-02-28 16:33:27 +00:00
|
|
|
</chapter>
|
|
|
|
|
</body>
|
|
|
|
|
</gsdoc>
|
