TGFKeyboard

Objective-C

@protocol TGFKeyboard <NSObject>

Swift

protocol TGFKeyboard : NSObjectProtocol

Defines the interface for a secure keyboard, providing a UIView for display and methods to manage its state and events.

@since 1.0.0

  • The secure keyboard view to be presented for user input.

    @discussion This UIView object should be displayed in your application’s UI to provide a secure passcode entry mechanism. Multiple calls to this property will return the same view instance; a new keyboard is only generated on the first call.

    Declaration

    Objective-C

    - (UIView *_Nonnull)view;

    Swift

    func view() -> UIView

  • The current number of characters entered into the keyboard.

    Declaration

    Objective-C

    - (NSUInteger)length;

    Swift

    func length() -> UInt

  • Clears all currently entered keys from the keyboard.

    @discussion This method also resets the length property to 0.

    Declaration

    Objective-C

    - (void)clear;

    Swift

    func clear()

  • The delegate object that receives keyboard events.

    @discussion This property should be set to an object that conforms to the TGFKeyboardDelegate protocol to handle user input. It is declared weak to prevent retain cycles.

    Declaration

    Objective-C

    - (void)setDelegate:(id<TGFKeyboardDelegate> _Nonnull)delegate;

    Swift

    func setDelegate(_ delegate: any TGFKeyboardDelegate)

  • Provides access the current usage state of the keyboard

    Declaration

    Objective-C

    - (TGFKeyboardUsage)keyboardUsage;

    Swift

    func keyboardUsage() -> TGFKeyboardUsage

    Return Value

    TGFKeyboardUsage