blob: 137c48e6144639d5438a140c0f55acc1432d4429 [file] [log] [blame]
//
// Created by Jesse Squires
// http://www.jessesquires.com
//
//
// Documentation
// http://cocoadocs.org/docsets/JSQMessagesViewController
//
//
// GitHub
// https://github.com/jessesquires/JSQMessagesViewController
//
//
// License
// Copyright (c) 2014 Jesse Squires
// Released under an MIT license: http://opensource.org/licenses/MIT
//
#import <Foundation/Foundation.h>
#import <UIKit/UIKit.h>
#import "JSQMessageBubbleImageDataSource.h"
/**
* A `JSQMessagesBubbleImage` model object represents a message bubble image, and is immutable.
* This is a concrete class that implements the `JSQMessageBubbleImageDataSource` protocol.
* It contains a regular message bubble image and a highlighted message bubble image.
*
* @see JSQMessagesBubbleImageFactory.
*/
@interface JSQMessagesBubbleImage : NSObject <JSQMessageBubbleImageDataSource, NSCopying>
/**
* Returns the message bubble image for a regular display state.
*/
@property (strong, nonatomic, readonly) UIImage *messageBubbleImage;
/**
* Returns the message bubble image for a highlighted display state.
*/
@property (strong, nonatomic, readonly) UIImage *messageBubbleHighlightedImage;
/**
* Initializes and returns a message bubble image object having the specified regular image and highlighted image.
*
* @param image The regular message bubble image. This value must not be `nil`.
* @param highlightedImage The highlighted message bubble image. This value must not be `nil`.
*
* @return An initialized `JSQMessagesBubbleImage` object if successful, `nil` otherwise.
*
* @see JSQMessagesBubbleImageFactory.
*/
- (instancetype)initWithMessageBubbleImage:(UIImage *)image highlightedImage:(UIImage *)highlightedImage NS_DESIGNATED_INITIALIZER;
/**
* Not a valid initializer.
*/
- (id)init NS_UNAVAILABLE;
@end