summaryrefslogtreecommitdiff
path: root/SmartDeviceLink/SDLImage.h
blob: 24c6dcdabd7289ce3b07dad3ad6bd3077c880ec9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
//  SDLImage.h
//

#import "SDLRPCMessage.h"

@class SDLImageType;


/**
 *Specifies, which image shall be used, e.g. in SDLAlerts or on SDLSoftbuttons provided the display supports it.
 * 
 * @since SDL 2.0
 */
@interface SDLImage : SDLRPCStruct {
}

/**
 * Constructs a newly allocated SDLImage object
 */
- (instancetype)init;

/**
 * Constructs a newly allocated SDLImage object indicated by the dictionary parameter
 * @param dict The dictionary to use
 */
- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;

- (instancetype)initWithName:(NSString *)name ofType:(SDLImageType *)imageType;

/**
 * @abstract The static hex icon value or the binary image file name identifier (sent by SDLPutFile)
 *
 * Required, max length = 65535
 */
@property (strong) NSString *value;

/**
 * @abstract Describes, whether it is a static or dynamic image
 *
 * Required
 */
@property (strong) SDLImageType *imageType;

@end