iOS Developer Library

Developer

UIKit Framework Reference UIInputViewAudioFeedback Protocol Reference

Options
Deployment Target:

On This Page
Language:

UIInputViewAudioFeedback

Inheritance


Not Applicable

Conforms To


Import Statement


Swift

import UIKit

Objective-C

@import UIKit;

Availability


Available in iOS 4.2 and later.

The UIInputViewAudioFeedback protocol defines a single property for enabling a custom input or keyboard accessory view to play standard keyboard input clicks.

Implement this protocol in your custom subclass of UIView that you associate with your custom input Nib file. For more information, see Text Programming Guide for iOS.

Implementation of this protocol is optional but expected.

  • Specifies whether or not an input view enables input clicks.

    Declaration

    Swift

    optional var enableInputClicksWhenVisible: Bool { get }

    Objective-C

    @property(nonatomic, readonly) BOOL enableInputClicksWhenVisible

    Parameters

    enableInputClicksWhenVisible

    Return YEStrue to enable input clicks by way of the playInputClick method, or NOfalse to disable input clicks. The value is NOfalse by default.

    Discussion

    In your custom subclass of UIView, implement this property as a getter method. Return YEStrue to enable input clicks in your custom input or keyboard accessory view, as follows:

    Swift

    • var enableInputClicksWhenVisible: Bool {
    • return true
    • }

    Objective-C

    • - (BOOL) enableInputClicksWhenVisible {
    • return YES;
    • }

    Input clicks will be produced only if the user has also enabled keyboard clicks in Settings > Sounds.

    Import Statement

    Objective-C

    @import UIKit;

    Swift

    import UIKit

    Availability

    Available in iOS 4.2 and later.