summaryrefslogtreecommitdiff
path: root/SmartDeviceLink/SDLImage.h
blob: cb7cb089c37591cbb8a84fecc5dcd9b550c34965 (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
//  SDLImage.h
//

#import "SDLRPCMessage.h"

#import "SDLImageType.h"

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

NS_ASSUME_NONNULL_BEGIN

@interface SDLImage : SDLRPCStruct

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

- (instancetype)initWithName:(NSString *)name;

- (instancetype)initWithStaticImageValue:(UInt16)staticImageValue;

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

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

@end

NS_ASSUME_NONNULL_END