summaryrefslogtreecommitdiff
path: root/SmartDeviceLink/SDLSoftButtonCapabilities.h
blob: ca9eeb2bfae76ee94419ee1b18eab42d825e433d (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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
//  SDLSoftButtonCapabilities.h
//


#import "SDLRPCMessage.h"

/**
 * Contains information about a SoftButton's capabilities.
 *
 * @since SDL 2.0
 */
@interface SDLSoftButtonCapabilities : SDLRPCStruct {
}

/**
 * @abstract Constructs a newly allocated SDLSoftButtonCapabilities object
 */
- (instancetype)init;

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

/**
 * @abstract The button supports a short press.
 *
 * @discussion Whenever the button is pressed short, onButtonPressed(SHORT) will be invoked.
 *
 * Required, Boolean
 */
@property (strong) NSNumber *shortPressAvailable;

/**
 * @abstract The button supports a LONG press.
 *
 * @discussion Whenever the button is pressed long, onButtonPressed(LONG) will be invoked.
 *
 * Required, Boolean
 */
@property (strong) NSNumber *longPressAvailable;

/**
 * @abstract The button supports "button down" and "button up".
 *
 * @discussion Whenever the button is pressed, onButtonEvent(DOWN) will be invoked. Whenever the button is released, onButtonEvent(UP) will be invoked.
 *
 * Required, Boolean
 */
@property (strong) NSNumber *upDownAvailable;

/**
 * @abstract The button supports referencing a static or dynamic image.
 *
 * Required, Boolean
 */
@property (strong) NSNumber *imageSupported;

@end