Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Internet Explorer alert
This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
close alert
Documentation
SDLSoftButtonCapabilities

SDLSoftButtonCapabilities Class Reference

Section Contents

Overview

Contains information about a SoftButton’s capabilities.

@since SDL 2.0

shortPressAvailable

The button supports a short press.

Whenever the button is pressed short, onButtonPressed(SHORT) will be invoked.

Required, Boolean

Objective-C

@property (nonatomic, strong) NSNumber<SDLBool> *_Nonnull shortPressAvailable;

Swift

var shortPressAvailable: NSNumber & SDLBool { get set }

longPressAvailable

The button supports a LONG press.

Whenever the button is pressed long, onButtonPressed(LONG) will be invoked.

Required, Boolean

Objective-C

@property (nonatomic, strong) NSNumber<SDLBool> *_Nonnull longPressAvailable;

Swift

var longPressAvailable: NSNumber & SDLBool { get set }

upDownAvailable

The button supports “button down” and “button up”.

Whenever the button is pressed, onButtonEvent(DOWN) will be invoked. Whenever the button is released, onButtonEvent(UP) will be invoked.

Required, Boolean

Objective-C

@property (nonatomic, strong) NSNumber<SDLBool> *_Nonnull upDownAvailable;

Swift

var upDownAvailable: NSNumber & SDLBool { get set }

imageSupported

The button supports referencing a static or dynamic image.

Required, Boolean

Objective-C

@property (nonatomic, strong) NSNumber<SDLBool> *_Nonnull imageSupported;

Swift

var imageSupported: NSNumber & SDLBool { get set }

textSupported

The button supports the use of text. If not included, the default value should be considered true that the button will support text.

Optional, Boolean

@since SDL 6.0

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLBool> *textSupported;

Swift

var textSupported: (NSNumber & SDLBool)? { get set }
View on GitHub.com
Previous Section Next Section