summaryrefslogtreecommitdiff
path: root/SmartDeviceLink/SDLButtonEventMode.h
blob: 56cd8683dfb5bea35ec3864f3266aa602d36ed34 (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
//  SDLButtonEventMode.h
//


#import "SDLEnum.h"

/**
 * Indicates whether the button was depressed or released. A BUTTONUP event will always be preceded by a BUTTONDOWN event.
 *
 * @since SDL 1.0
 */
@interface SDLButtonEventMode : SDLEnum {
}

/**
 * @abstract Convert String to SDLButtonEventMode
 * @param value The value of the string to get an object for
 * @return SDLButtonEventMode (BUTTONUP / BUTTONDOWN)
 */
+ (SDLButtonEventMode *)valueOf:(NSString *)value;

/**
 * @abstract Store the enumeration of all possible SDLButtonEventMode
 * @return an array that store all possible SDLButtonEventMode
 */
+ (NSArray *)values;

/**
 * @abstract The button was released
 * @return a SDLButtonEventMode with value of *BUTTONUP*
 */
+ (SDLButtonEventMode *)BUTTONUP;

/**
 * @abstract The button was depressed
 * @return a SDLButtonEventMode with value of *BUTTONDOWN*
 */
+ (SDLButtonEventMode *)BUTTONDOWN;

@end