Loading...
Searching...
No Matches
OFImageFormatHandler Class Reference
A handler for an image format. More...
#include <ObjFW/ObjFW.h>
Inheritance diagram for OFImageFormatHandler:
Instance Methods | |
| (instancetype) | - initWithImageFormat: |
| Initializes the handler for the specified image format. | |
| (OFMutableImage *) | - readImageFromStream: |
| Creates a new image from the specified stream. | |
| (void) | - writeImage:toStream:options: |
| Writes the specified image to the specified stream with the specified options. | |
| Instance Methods inherited from OFObject | |
| (instancetype) | - init |
| Initializes an already allocated object. | |
| (nullable OFMethodSignature *) | - methodSignatureForSelector: |
| Returns the method signature for the specified selector. | |
| (void) | - dealloc |
| Deallocates the object. | |
| (void) | - performSelector:afterDelay: |
| Performs the specified selector after the specified delay. | |
| (void) | - performSelector:withObject:afterDelay: |
| Performs the specified selector with the specified object after the specified delay. | |
| (void) | - performSelector:withObject:withObject:afterDelay: |
| Performs the specified selector with the specified objects after the specified delay. | |
| (void) | - performSelector:withObject:withObject:withObject:afterDelay: |
| Performs the specified selector with the specified objects after the specified delay. | |
| (void) | - performSelector:withObject:withObject:withObject:withObject:afterDelay: |
| Performs the specified selector with the specified objects after the specified delay. | |
| (void) | - performSelector:onThread:waitUntilDone: |
| Performs the specified selector on the specified thread. | |
| (void) | - performSelector:onThread:withObject:waitUntilDone: |
| Performs the specified selector on the specified thread with the specified object. | |
| (void) | - performSelector:onThread:withObject:withObject:waitUntilDone: |
| Performs the specified selector on the specified thread with the specified objects. | |
| (void) | - performSelector:onThread:withObject:withObject:withObject:waitUntilDone: |
| Performs the specified selector on the specified thread with the specified objects. | |
| (void) | - performSelector:onThread:withObject:withObject:withObject:withObject:waitUntilDone: |
| Performs the specified selector on the specified thread with the specified objects. | |
| (void) | - performSelectorOnMainThread:waitUntilDone: |
| Performs the specified selector on the main thread. | |
| (void) | - performSelectorOnMainThread:withObject:waitUntilDone: |
| Performs the specified selector on the main thread with the specified object. | |
| (void) | - performSelectorOnMainThread:withObject:withObject:waitUntilDone: |
| Performs the specified selector on the main thread with the specified objects. | |
| (void) | - performSelectorOnMainThread:withObject:withObject:withObject:waitUntilDone: |
| Performs the specified selector on the main thread with the specified objects. | |
| (void) | - performSelectorOnMainThread:withObject:withObject:withObject:withObject:waitUntilDone: |
| Performs the specified selector on the main thread with the specified objects. | |
| (void) | - performSelector:onThread:afterDelay: |
| Performs the specified selector on the specified thread after the specified delay. | |
| (void) | - performSelector:onThread:withObject:afterDelay: |
| Performs the specified selector on the specified thread with the specified object after the specified delay. | |
| (void) | - performSelector:onThread:withObject:withObject:afterDelay: |
| Performs the specified selector on the specified thread with the specified objects after the specified delay. | |
| (void) | - performSelector:onThread:withObject:withObject:withObject:afterDelay: |
| Performs the specified selector on the specified thread with the specified objects after the specified delay. | |
| (void) | - performSelector:onThread:withObject:withObject:withObject:withObject:afterDelay: |
| Performs the specified selector on the specified thread with the specified objects after the specified delay. | |
| (nullable id) | - forwardingTargetForSelector: |
| This method is called when resolveClassMethod: or resolveInstanceMethod: returned false. It should return a target to which the message should be forwarded. | |
| (void) | - doesNotRecognizeSelector: |
| Handles messages which are not understood by the receiver. | |
| Instance Methods inherited from <OFObject> | |
| (unsigned long) | - hash |
| Returns a hash for the object. | |
| (unsigned int) | - retainCount |
| Returns the retain count. | |
| (bool) | - isProxy |
| Returns whether the object is a proxy object. | |
| (bool) | - isKindOfClass: |
| Returns a boolean whether the object is of the specified kind. | |
| (bool) | - isMemberOfClass: |
| Returns a boolean whether the object is a member of the specified class. | |
| (bool) | - respondsToSelector: |
| Returns a boolean whether the object responds to the specified selector. | |
| (nullable IMP) | - methodForSelector: |
| Returns the implementation for the specified selector. | |
| (nullable id) | - performSelector: |
| Performs the specified selector. | |
| (nullable id) | - performSelector:withObject: |
| Performs the specified selector with the specified object. | |
| (nullable id) | - performSelector:withObject:withObject: |
| Performs the specified selector with the specified objects. | |
| (nullable id) | - performSelector:withObject:withObject:withObject: |
| Performs the specified selector with the specified objects. | |
| (nullable id) | - performSelector:withObject:withObject:withObject:withObject: |
| Performs the specified selector with the specified objects. | |
| (bool) | - isEqual: |
| Checks two objects for equality. | |
| (instancetype) | - retain |
| Increases the retain count. | |
| (void) | - release |
| Decreases the retain count. | |
| (instancetype) | - autorelease |
| Adds the object to the topmost autorelease pool of the thread's autorelease pool stack. | |
| (instancetype) | - self |
| Returns the receiver. | |
| (bool) | - allowsWeakReference |
| Returns whether the object allows a weak reference. | |
| (bool) | - retainWeakReference |
| Retain a weak reference to this object. | |
Class Methods | |
| (bool) | + registerClass:forImageFormat: |
| Registers the specified class as the handler for the specified image format. | |
| (OFImageFormatHandler *) | + handlerForImageFormat: |
| Returns the handler for the specified image format. | |
| Class Methods inherited from OFObject | |
| (void) | + load |
| A method which is called once when the class is loaded into the runtime. | |
| (void) | + unload |
| A method which is called when the class is unloaded from the runtime. | |
| (void) | + initialize |
| A method which is called the moment before the first call to the class is being made. | |
| (instancetype) | + alloc |
| Allocates memory for an instance of the class and sets up the memory pool for the object. | |
| (Class) | + class |
| Returns the class. | |
| (OFString *) | + className |
| Returns the name of the class as a string. | |
| (bool) | + isSubclassOfClass: |
| Returns a boolean whether the class is a subclass of the specified class. | |
| (nullable Class) | + superclass |
| Returns the superclass of the class. | |
| (bool) | + instancesRespondToSelector: |
| Checks whether instances of the class respond to a given selector. | |
| (bool) | + conformsToProtocol: |
| Checks whether the class conforms to a given protocol. | |
| (nullable IMP) | + instanceMethodForSelector: |
| Returns the implementation of the instance method for the specified selector. | |
| (nullable OFMethodSignature *) | + instanceMethodSignatureForSelector: |
| Returns the method signature of the instance method for the specified selector. | |
| (OFString *) | + description |
| Returns a description for the class, which is usually the class name. | |
| (nullable IMP) | + replaceClassMethod:withMethodFromClass: |
| Replaces a class method with a class method from another class. | |
| (nullable IMP) | + replaceInstanceMethod:withMethodFromClass: |
| Replaces an instance method with an instance method from another class. | |
| (void) | + inheritMethodsFromClass: |
| Adds all methods from the specified class to the class that is the receiver. | |
| (bool) | + resolveClassMethod: |
| Try to resolve the specified class method. | |
| (bool) | + resolveInstanceMethod: |
| Try to resolve the specified instance method. | |
| (id) | + copy |
| Returns the class. | |
Properties | |
| OFImageFormat | imageFormat |
| The image format this OFImageFormatHandler handles. | |
| Properties inherited from OFObject | |
| OFString * | className |
| The name of the object's class. | |
| OFString * | description |
| A description for the object. | |
Detailed Description
A handler for an image format.
Method Documentation
◆ handlerForImageFormat:
| + (OFImageFormatHandler *) handlerForImageFormat: | (OFImageFormat) | imageFormat |
Returns the handler for the specified image format.
- Returns
- The handler for the specified image format
- Exceptions
-
OFNotImplementedException The specified image format it not supported
◆ initWithImageFormat:
| - (instancetype) initWithImageFormat: | (OFImageFormat) | imageFormat |
Initializes the handler for the specified image format.
- Parameters
-
imageFormat The image format to initialize for
- Returns
- An initialized image format handler
◆ readImageFromStream:
| - (OFMutableImage *) readImageFromStream: | (OFSeekableStream *) | stream |
Creates a new image from the specified stream.
- Parameters
-
stream The stream to create the image from
- Returns
- A new image
- Exceptions
-
OFInvalidFormatExcepetion The stream's format was invalid OFTruncatedDataException The stream ended before all required data was read OFOutOfRangeException The image read from the stream is too big for an OFImage OFReadFailedException Reading from the stream failed OFSeekFailedException Seeking the stream failed
◆ registerClass:forImageFormat:
| + (bool) registerClass: | (Class) | class_ | |
| forImageFormat: | (OFImageFormat) | imageFormat |
Registers the specified class as the handler for the specified image format.
If the same class is specified for multiple image formats, one instance of it is created per image format.
- Parameters
-
class_ The class to register as the handler for the specified image format imageFormat The image format for which to register the handler
- Returns
- Whether the class was successfully registered. If a handler for the same image format is already registered, registration fails.
◆ writeImage:toStream:options:
| - (void) writeImage: | (OFImage *) | image | |
| toStream: | (OFSeekableStream *) | stream | |
| options: | (nullable OFDictionary *) | options |
Writes the specified image to the specified stream with the specified options.
- Parameters
-
image The image to write to the stream stream The stream to write the image to options Additional format-specific options to write the image to the stream
- Exceptions
-
OFWriteFailedException Writing to the stream failed OFSeekFailedException Seeking the stream failed
The documentation for this class was generated from the following files:
- src/OFImageFormatHandler.h
- src/OFImageFormatHandler.m
