PTTextSearchToolbar

@interface PTTextSearchToolbar : UIView <UITextFieldDelegate>

- (instancetype)initWithTextSearchManager:(PTTextSearchManager *)textSearchManager NS_DESIGNATED_INITIALIZER;

- (instancetype)init NS_UNAVAILABLE;
- (instancetype)initWithFrame:(CGRect)frame NS_UNAVAILABLE;
- (nullable instancetype)initWithCoder:(NSCoder *)coder NS_UNAVAILABLE;
+ (instancetype)new NS_UNAVAILABLE;

/**
 * The delegate of this view.
 */
@property (nonatomic, weak, nullable) id<PTTextSearchToolbarDelegate> delegate;

@property (nonatomic, readonly, strong) PTTextSearchManager *textSearchManager;

@property (nonatomic, readonly, strong) PTTextSearchOptions *textSearchOptions;

@property (nonatomic, readonly, strong) UITextField *searchTextField;

@property (nonatomic, readonly, strong) UIButton *searchSettingsButton;

#pragma mark - Buttons

@property (nonatomic, readonly, strong) UIButton *doneButton;

@property (nonatomic, readonly, strong) UIButton *previousResultButton;
@property (nonatomic, readonly, strong) UIButton *nextResultButton;

/**
 * The view that provides the background appearance.
 *
 * Setting a value of `nil` resets this property to the default background view.
 */
@property (nonatomic, strong, null_resettable) UIView *backgroundView;

#pragma mark - Activity indicator

/**
 * The activity indicator displayed by this view.
 */
@property (nonatomic, readonly, strong) UIActivityIndicatorView *activityIndicator;

/**
 * Whether the `activityIndicator` is currently hidden.
 *
 * The activity indicator is hidden by default.
 */
@property (nonatomic, assign, getter=isActivityIndicatorHidden) BOOL activityIndicatorHidden;

#pragma mark - Button actions

/**
 * This method is called when the `doneButton` is pressed.
 */
- (void)donePressed:(nullable id)sender;

/**
 * This method is called when the `previousResultButton` is pressed.
 */
- (void)previousResultPressed:(nullable id)sender;

/**
 * This method is called when the `nextResultButton` is pressed.
 */
- (void)nextResultPressed:(nullable id)sender;

@end

Undocumented

  • Undocumented

    Declaration

    Objective-C

    - (instancetype)initWithTextSearchManager:(PTTextSearchManager *)textSearchManager NS_DESIGNATED_INITIALIZER;

    Swift

    init(textSearchManager: PTTextSearchManager)

  • Undocumented

    Declaration

    Objective-C

    - (instancetype)init NS_UNAVAILABLE;

  • Undocumented

    Declaration

    Objective-C

    - (instancetype)initWithFrame:(CGRect)frame NS_UNAVAILABLE;

  • Undocumented

    Declaration

    Objective-C

    - (nullable instancetype)initWithCoder:(NSCoder *)coder NS_UNAVAILABLE;

  • Undocumented

    Declaration

    Objective-C

    + (instancetype)new NS_UNAVAILABLE;

  • The delegate of this view.

    Declaration

    Objective-C

    @property (nonatomic, weak, nullable) id<PTTextSearchToolbarDelegate> delegate;

    Swift

    weak var delegate: (any PTTextSearchToolbarDelegate)? { get set }

  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic, readonly, strong) PTTextSearchManager *textSearchManager

    Swift

    var textSearchManager: PTTextSearchManager { get }

  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic, readonly, strong) PTTextSearchOptions *textSearchOptions

    Swift

    var textSearchOptions: PTTextSearchOptions { get }

  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic, readonly, strong) UITextField *searchTextField

    Swift

    var searchTextField: UITextField { get }

  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic, readonly, strong) UIButton *searchSettingsButton

    Swift

    var searchSettingsButton: UIButton { get }

Buttons

  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic, readonly, strong) UIButton *doneButton

    Swift

    var doneButton: UIButton { get }

  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic, readonly, strong) UIButton *previousResultButton

    Swift

    var previousResultButton: UIButton { get }

  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic, readonly, strong) UIButton *nextResultButton

    Swift

    var nextResultButton: UIButton { get }

  • The view that provides the background appearance.

    Setting a value of nil resets this property to the default background view.

    Declaration

    Objective-C

    @property (nonatomic, strong, null_resettable) UIView *backgroundView;

    Swift

    var backgroundView: UIView! { get set }

Activity indicator

  • The activity indicator displayed by this view.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) UIActivityIndicatorView *_Nonnull activityIndicator;

    Swift

    var activityIndicator: UIActivityIndicatorView { get }

  • Whether the activityIndicator is currently hidden.

    The activity indicator is hidden by default.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite,
          getter=isActivityIndicatorHidden) BOOL activityIndicatorHidden;

    Swift

    var isActivityIndicatorHidden: Bool { get set }

Button actions

  • This method is called when the doneButton is pressed.

    Declaration

    Objective-C

    - (void)donePressed:(nullable id)sender;

    Swift

    func donePressed(_ sender: Any?)

  • This method is called when the previousResultButton is pressed.

    Declaration

    Objective-C

    - (void)previousResultPressed:(nullable id)sender;

    Swift

    func previousResultPressed(_ sender: Any?)

  • This method is called when the nextResultButton is pressed.

    Declaration

    Objective-C

    - (void)nextResultPressed:(nullable id)sender;

    Swift

    func nextResultPressed(_ sender: Any?)