diff options
author | Muller, Alexander (A.) <amulle19@ford.com> | 2016-07-17 15:28:26 -0700 |
---|---|---|
committer | Muller, Alexander (A.) <amulle19@ford.com> | 2016-07-17 15:28:26 -0700 |
commit | f822b52cdd133ada19727f2d118768e50030b794 (patch) | |
tree | 7887cc262a05d11663778bd4a79499d0875d68bd /SmartDeviceLink/SDLTouch.h | |
parent | 469648112a3950277c77d47b77be15ef5b4f4238 (diff) | |
download | sdl_ios-f822b52cdd133ada19727f2d118768e50030b794.tar.gz |
Added documentation
Diffstat (limited to 'SmartDeviceLink/SDLTouch.h')
-rw-r--r-- | SmartDeviceLink/SDLTouch.h | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/SmartDeviceLink/SDLTouch.h b/SmartDeviceLink/SDLTouch.h index 4d5553eb6..6cfb1f2db 100644 --- a/SmartDeviceLink/SDLTouch.h +++ b/SmartDeviceLink/SDLTouch.h @@ -19,13 +19,45 @@ NS_ASSUME_NONNULL_BEGIN @interface SDLTouch : NSObject +/** + * @abstract + * Initializes a touch. + * @param touchEvent + * Incoming touch event from onOnTouchEvent notification. + * @return SDLTouch + * Instance of SDLTouch. + */ - (instancetype)initWithTouchEvent:(SDLTouchEvent*)touchEvent; +/** + * @abstract + * Identifier of the touch's finger. Refer to SDLTouchIdentifier for valid + * identifiers. + */ @property (nonatomic, assign, readonly) NSInteger identifier; + +/** + * @abstract + * Location of touch point, in the head unit's coordinate system. + */ @property (nonatomic, assign, readonly) CGPoint location; + +/** + * @abstract + * Timestamp in which the touch occured. + */ @property (nonatomic, assign, readonly) NSUInteger timeStamp; +/** + * @abstract + * Returns whether or not this touch is a first finger. + */ @property (nonatomic, assign, readonly) BOOL isFirstFinger; + +/** + * @abstract + * Returns whether or not this touch is a second finger. + */ @property (nonatomic, assign, readonly) BOOL isSecondFinger; @end |