Markup for autogsdoc

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/gui/trunk@11788 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
fedor 2001-12-17 16:51:51 +00:00
parent 86eca68043
commit c51f4265da
289 changed files with 33853 additions and 23024 deletions

View file

@ -1,179 +1,217 @@
<html><head>
<title>NSBitmapImageRep</title>
</head>
<body>
<a href ="NSBezierPath.html">[Previous] </a>
<a href ="Gui.html">[Up] </a>
<a href ="NSBox.html">[Next] </a>
<h1>NSBitmapImageRep</h1>
<h3>Authors </h3>
<dl>
<dt><a href ="http://www.gnustep.org/developers/whoiswho.html">Richard Frith-Macdonald</a>
<dd>
</dl>
<p>Version: $Revision$</p>
<p>Date: $Date$</p>
<h2><a name ="cont-0">NSBitmapImageRep</a></h2>
<h2><a name ="NSBitmapImageRep">NSBitmapImageRep</a></h2>
<p><b>Declared in: </b> Gui/NSImage.h</p>
<p><b>Inherits from: </b> NSImageRep</p>
<p><b>Conforms to: </b> NSCoding
</p>
<hr>
<html>
<head>
<title>NSBitmapImageRep.m</title>
</head>
<body>
<h1>NSBitmapImageRep.m</h1>
<h3>Authors</h3>
<dl>
<dt>Adam Fedor(<a href="mailto:fedor@gnu.org"><code>
fedor@gnu.org
</code></a>)</dt>
<dd>
</dd>
</dl>
<blockquote>
Bitmap image representation. </blockquote>
<p>Copyright: (C) 1996 Free Software Foundation, Inc.</p>
<h1>
Software documentation for the NSBitmapImageRep class
</h1>
<h2><a name="class$NSBitmapImageRep">NSBitmapImageRep</a> : <a href="NSImageRep.html#class$NSImageRep">NSImageRep</a></h2>
Declared: AppKit/NSBitmapImageRep.h<br />
<p>
<h2>Instance Variables </h2>
<ul>
</ul>
<h2>Methods </h2>
<ul>
<li ><a href ="NSBitmapImageRep.html#method-4">+TIFFRepresentationOfImageRepsInArray:</a>
<li ><a href ="NSBitmapImageRep.html#method-5">+TIFFRepresentationOfImageRepsInArray:usingCompression:</a>
<li ><a href ="NSBitmapImageRep.html#method-0">+getTIFFCompressionTypes:count:</a>
<li ><a href ="NSBitmapImageRep.html#method-2">+imageRepWithData:</a>
<li ><a href ="NSBitmapImageRep.html#method-1">+imageRepsWithData:</a>
<li ><a href ="NSBitmapImageRep.html#method-3">+localizedNameForTIFFCompressionType:</a>
<li ><a href ="NSBitmapImageRep.html#method-22">-TIFFRepresentation</a>
<li ><a href ="NSBitmapImageRep.html#method-23">-TIFFRepresentationUsingCompression:factor:</a>
<li ><a href ="NSBitmapImageRep.html#method-6">-bitmapData</a>
<li ><a href ="NSBitmapImageRep.html#method-7">-bitsPerPixel</a>
<li ><a href ="NSBitmapImageRep.html#method-8">-bytesPerPlane</a>
<li ><a href ="NSBitmapImageRep.html#method-9">-bytesPerRow</a>
<li ><a href ="NSBitmapImageRep.html#method-10">-canBeCompressedUsing:</a>
<li ><a href ="NSBitmapImageRep.html#method-11">-getBitmapDataPlanes:</a>
<li ><a href ="NSBitmapImageRep.html#method-12">-getCompression:</a>
<li ><a href ="NSBitmapImageRep.html#method-13">-initWithBitmapDataPlanes:pixelsWide:pixelsHigh:bitsPerSample:samplesPerPixel:hasAlpha:isPlanar:colorSpaceName:bytesPerRow:bitsPerPixel:</a>
<li ><a href ="NSBitmapImageRep.html#method-14">-initWithBitmapHandle:</a>
<li ><a href ="NSBitmapImageRep.html#method-15">-initWithData:</a>
<li ><a href ="NSBitmapImageRep.html#method-16">-initWithFocusedViewRect:</a>
<li ><a href ="NSBitmapImageRep.html#method-17">-initWithIconHandle:</a>
<li ><a href ="NSBitmapImageRep.html#method-18">-isPlanar</a>
<li ><a href ="NSBitmapImageRep.html#method-19">-numberOfPlanes</a>
<li ><a href ="NSBitmapImageRep.html#method-20">-samplesPerPixel</a>
<li ><a href ="NSBitmapImageRep.html#method-21">-setCompression:</a>
</ul>
<hr><h2>Class Methods </h2>
<h3><a name ="method-0">getTIFFCompressionTypes:count:</a></h3>
+ (void) <b>getTIFFCompressionTypes:</b> (constNSTIFFCompression**)list <b>count:</b> (int*)numTypes;<br>
</p>
<h3>TIFFRepresentationOfImageRepsInArray:</a></h3>
+ (NSData*) <b>TIFFRepresentationOfImageRepsInArray:</b> (NSArray*)anArray;<br />
<p>
<hr>
<h3><a name ="method-1">imageRepsWithData:</a></h3>
+ (NSArray*) <b>imageRepsWithData:</b> (NSData*)bitmapData;<br>
</p>
<hr />
<h3>TIFFRepresentationOfImageRepsInArray:usingCompression:factor:</a></h3>
+ (NSData*) <b>TIFFRepresentationOfImageRepsInArray:</b> (NSArray*)anArray<b> usingCompression:</b> (NSTIFFCompression)type<b> factor:</b> (float)factor;<br />
<p>
<hr>
<h3><a name ="method-2">imageRepWithData:</a></h3>
+ (id) <b>imageRepWithData:</b> (NSData*)bitmapData;<br>
</p>
<hr />
<h3>getTIFFCompressionTypes:count:</a></h3>
+ (void) <b>getTIFFCompressionTypes:</b> (const NSTIFFCompression**)list<b> count:</b> (int*)numTypes;<br />
<p>
<hr>
<h3><a name ="method-3">localizedNameForTIFFCompressionType:</a></h3>
+ (NSString*) <b>localizedNameForTIFFCompressionType:</b> (NSTIFFCompression)compression;<br>
</p>
<hr />
<h3>imageRepWithData:</a></h3>
+ (id) <b>imageRepWithData:</b> (NSData*)tiffData;<br />
<p>
<hr>
<h3><a name ="method-4">TIFFRepresentationOfImageRepsInArray:</a></h3>
+ (NSData*) <b>TIFFRepresentationOfImageRepsInArray:</b> (NSArray*)array;<br>
</p>
<hr />
<h3>imageRepsWithData:</a></h3>
+ (NSArray*) <b>imageRepsWithData:</b> (NSData*)tiffData;<br />
<p>
<hr>
<h3><a name ="method-5">TIFFRepresentationOfImageRepsInArray:usingCompression:</a></h3>
+ (NSData*) <b>TIFFRepresentationOfImageRepsInArray:</b> (NSArray*)array <b>usingCompression:</b> (NSTIFFCompression)compression;<br>
</p>
<hr />
<h3>localizedNameForTIFFCompressionType:</a></h3>
+ (NSString*) <b>localizedNameForTIFFCompressionType:</b> (NSTIFFCompression)type;<br />
<p>
<hr>
<hr><h2>Instances Methods </h2>
<h3><a name ="method-6">bitmapData</a></h3>
- (unsigned char*) <b>bitmapData</b>;<br>
</p>
<hr />
<h3>representationOfImageRepsInArray:usingType:properties:</a></h3>
+ (NSData*) <b>representationOfImageRepsInArray:</b> (NSArray*)imageReps<b> usingType:</b> (NSBitmapImageFileType)storageType<b> properties:</b> (NSDictionary*)properties;<br />
<p>
<hr>
<h3><a name ="method-7">bitsPerPixel</a></h3>
- (int) <b>bitsPerPixel</b>;<br>
</p>
<hr />
<h3>TIFFRepresentation</a></h3>
- (NSData*) <b>TIFFRepresentation</b>;<br />
<p>
<hr>
<h3><a name ="method-8">bytesPerPlane</a></h3>
- (int) <b>bytesPerPlane</b>;<br>
</p>
<hr />
<h3>TIFFRepresentationUsingCompression:factor:</a></h3>
- (NSData*) <b>TIFFRepresentationUsingCompression:</b> (NSTIFFCompression)type<b> factor:</b> (float)factor;<br />
<p>
<hr>
<h3><a name ="method-9">bytesPerRow</a></h3>
- (int) <b>bytesPerRow</b>;<br>
</p>
<hr />
<h3>bitmapData</a></h3>
- (unsigned char*) <b>bitmapData</b>;<br />
<p>
<hr>
<h3><a name ="method-10">canBeCompressedUsing:</a></h3>
- (BOOL) <b>canBeCompressedUsing:</b> (NSTIFFCompression)compression;<br>
</p>
<hr />
<h3>bitsPerPixel</a></h3>
- (int) <b>bitsPerPixel</b>;<br />
<p>
<hr>
<h3><a name ="method-11">getBitmapDataPlanes:</a></h3>
- (void) <b>getBitmapDataPlanes:</b> (unsigned char**)data;<br>
</p>
<hr />
<h3>bytesPerPlane</a></h3>
- (int) <b>bytesPerPlane</b>;<br />
<p>
<hr>
<h3><a name ="method-12">getCompression:</a></h3>
- (void) <b>getCompression:</b> (NSTIFFCompression*)compression;<br>
</p>
<hr />
<h3>bytesPerRow</a></h3>
- (int) <b>bytesPerRow</b>;<br />
<p>
<hr>
<h3><a name ="method-13">initWithBitmapDataPlanes:pixelsWide:pixelsHigh:bitsPerSample:samplesPerPixel:hasAlpha:isPlanar:colorSpaceName:bytesPerRow:bitsPerPixel:</a></h3>
- (id) <b>initWithBitmapDataPlanes:</b> (unsigned char**)planes <b>pixelsWide:</b> (int)width <b>pixelsHigh:</b> (int)height <b>bitsPerSample:</b> (int)bps <b>samplesPerPixel:</b> (int)spp <b>hasAlpha:</b> (BOOL)alpha <b>isPlanar:</b> (BOOL)isPlanar <b>colorSpaceName:</b> (NSString*)colorSpaceName <b>bytesPerRow:</b> (int)rowBytes <b>bitsPerPixel:</b> (int)pixelBits;<br>
</p>
<hr />
<h3>canBeCompressedUsing:</a></h3>
- (BOOL) <b>canBeCompressedUsing:</b> (NSTIFFCompression)type;<br />
<p>
<hr>
<h3><a name ="method-14">initWithBitmapHandle:</a></h3>
- (id) <b>initWithBitmapHandle:</b> (void*)bitmap;<br>
</p>
<hr />
<h3>colorizeByMappingGray:toColor:blackMapping:whiteMapping:</a></h3>
- (void) <b>colorizeByMappingGray:</b> (float)midPoint<b> toColor:</b> (<a href="NSColor.html#class$NSColor">NSColor</a>*)midPointColor<b> blackMapping:</b> (<a href="NSColor.html#class$NSColor">NSColor</a>*)shadowColor<b> whiteMapping:</b> (<a href="NSColor.html#class$NSColor">NSColor</a>*)lightColor;<br />
<p>
<hr>
<h3><a name ="method-15">initWithData:</a></h3>
- (id) <b>initWithData:</b> (NSData*)bitmapData;<br>
</p>
<hr />
<h3>getBitmapDataPlanes:</a></h3>
- (void) <b>getBitmapDataPlanes:</b> (unsigned char**)data;<br />
<p>
<hr>
<h3><a name ="method-16">initWithFocusedViewRect:</a></h3>
- (id) <b>initWithFocusedViewRect:</b> (NSRect)rect;<br>
</p>
<hr />
<h3>getCompression:factor:</a></h3>
- (void) <b>getCompression:</b> (NSTIFFCompression*)type<b> factor:</b> (float*)factor;<br />
<p>
<hr>
<h3><a name ="method-17">initWithIconHandle:</a></h3>
- (id) <b>initWithIconHandle:</b> (void*)icon;<br>
</p>
<hr />
<h3>initWithBitmapDataPlanes:pixelsWide:pixelsHigh:bitsPerSample:samplesPerPixel:hasAlpha:isPlanar:colorSpaceName:bytesPerRow:bitsPerPixel:</a></h3>
- (id) <b>initWithBitmapDataPlanes:</b> (unsigned char**)planes<b> pixelsWide:</b> (int)width<b> pixelsHigh:</b> (int)height<b> bitsPerSample:</b> (int)bps<b> samplesPerPixel:</b> (int)spp<b> hasAlpha:</b> (BOOL)alpha<b> isPlanar:</b> (BOOL)isPlanar<b> colorSpaceName:</b> (NSString*)colorSpaceName<b> bytesPerRow:</b> (int)rowBytes<b> bitsPerPixel:</b> (int)pixelBits;<br />
<p>
<hr>
<h3><a name ="method-18">isPlanar</a></h3>
- (BOOL) <b>isPlanar</b>;<br>
</p>
<hr />
<h3>initWithBitmapHandle:</a></h3>
- (id) <b>initWithBitmapHandle:</b> (void*)bitmap;<br />
<p>
<hr>
<h3><a name ="method-19">numberOfPlanes</a></h3>
- (int) <b>numberOfPlanes</b>;<br>
</p>
<hr />
<h3>initWithData:</a></h3>
- (id) <b>initWithData:</b> (NSData*)tiffData;<br />
<p>
<hr>
<h3><a name ="method-20">samplesPerPixel</a></h3>
- (int) <b>samplesPerPixel</b>;<br>
</p>
<hr />
<h3>initWithFocusedViewRect:</a></h3>
- (id) <b>initWithFocusedViewRect:</b> (NSRect)rect;<br />
<p>
<hr>
<h3><a name ="method-21">setCompression:</a></h3>
- (void) <b>setCompression:</b> (NSTIFFCompression)compression;<br>
</p>
<hr />
<h3>initWithIconHandle:</a></h3>
- (id) <b>initWithIconHandle:</b> (void*)icon;<br />
<p>
<hr>
<h3><a name ="method-22">TIFFRepresentation</a></h3>
- (NSData*) <b>TIFFRepresentation</b>;<br>
</p>
<hr />
<h3>isPlanar</a></h3>
- (BOOL) <b>isPlanar</b>;<br />
<p>
<hr>
<h3><a name ="method-23">TIFFRepresentationUsingCompression:factor:</a></h3>
- (NSData*) <b>TIFFRepresentationUsingCompression:</b> (NSTIFFCompression)comp <b>factor:</b> (float)factor;<br>
</p>
<hr />
<h3>numberOfPlanes</a></h3>
- (int) <b>numberOfPlanes</b>;<br />
<p>
<hr>
</body>
</html>
</p>
<hr />
<h3>representationUsingType:properties:</a></h3>
- (NSData*) <b>representationUsingType:</b> (NSBitmapImageFileType)storageType<b> properties:</b> (NSDictionary*)properties;<br />
<p>
</p>
<hr />
<h3>samplesPerPixel</a></h3>
- (int) <b>samplesPerPixel</b>;<br />
<p>
</p>
<hr />
<h3>setCompression:factor:</a></h3>
- (void) <b>setCompression:</b> (NSTIFFCompression)type<b> factor:</b> (float)factor;<br />
<p>
</p>
<hr />
<h3>setProperty:withValue:</a></h3>
- (void) <b>setProperty:</b> (NSString*)property<b> withValue:</b> (id)value;<br />
<p>
</p>
<hr />
<h3>valueForProperty:</a></h3>
- (id) <b>valueForProperty:</b> (NSString*)property;<br />
<p>
</p>
<hr />
<h1>
Software documentation for the
NSBitmapImageRep(GNUstepExtension)
category
</h1>
<h2><a href="#class$NSBitmapImageRep">NSBitmapImageRep</a>(<a name="category$NSBitmapImageRep(GNUstepExtension)">GNUstepExtension</a>)</h2>
Declared: AppKit/NSBitmapImageRep.h<br />
<p>
</p>
<h3>imageRepsWithFile:</a></h3>
+ (NSArray*) <b>imageRepsWithFile:</b> (NSString*)filename;<br />
<p>
</p>
<hr />
</body>
</html>