RBSearchContainerViewControllerDelegate Protocol Reference

Conforms to NSObject
Declared in RBSearchContainerViewController.h

Overview

The delegate that receives search and state transition events for an RBSearchContainerViewController object.

– searchContainerViewController:didRequestSearchWithQuery: required method

Called when the search container view requests that a search be performed.

- (void)searchContainerViewController:(nonnull RBSearchContainerViewController *)searchContainerViewController didRequestSearchWithQuery:(nonnull NSString *)queryString

Parameters

searchContainerViewController

The RBSearchContainerViewController object.

queryString

The search query string.

Discussion

Called when the search container view requests that a search be performed.

Declared In

RBSearchContainerViewController.h

– searchContainerViewControllerShouldOpenOnQueryEdit:

Whether or not search mode should be opened when the query string field is tapped.

- (BOOL)searchContainerViewControllerShouldOpenOnQueryEdit:(nonnull RBSearchContainerViewController *)searchContainerViewController

Parameters

searchContainerViewController

The RBSearchContainerViewController object.

Return Value

Whether or not to open search mode.

Discussion

Whether or not search mode should be opened when the query string field is tapped.

Declared In

RBSearchContainerViewController.h

– searchContainerViewControllerShouldCloseOnCancelTapped:

Whether or not search mode should be closed when the cancel button is tapped.

- (BOOL)searchContainerViewControllerShouldCloseOnCancelTapped:(nonnull RBSearchContainerViewController *)searchContainerViewController

Parameters

searchContainerViewController

The RBSearchContainerViewController object.

Return Value

Whether or not to close search mode.

Discussion

Whether or not search mode should be closed when the cancel button is tapped.

Declared In

RBSearchContainerViewController.h

– searchContainerViewController:willOpenSearchWithAnimation:

Called when the search mode will open.

- (void)searchContainerViewController:(nonnull RBSearchContainerViewController *)searchContainerViewController willOpenSearchWithAnimation:(BOOL)animated

Parameters

searchContainerViewController

The RBSearchContainerViewController object.

animated

Whether the transition is animated.

Discussion

Called when the search mode will open.

Declared In

RBSearchContainerViewController.h

– searchContainerViewController:didOpenSearchWithAnimation:

Called when the search mode did open.

- (void)searchContainerViewController:(nonnull RBSearchContainerViewController *)searchContainerViewController didOpenSearchWithAnimation:(BOOL)animated

Parameters

searchContainerViewController

The RBSearchContainerViewController object.

animated

Whether the transition is animated.

Discussion

Called when the search mode did open.

Declared In

RBSearchContainerViewController.h

– searchContainerViewController:willCloseSearchWithAnimation:

Called when the search mode will close.

- (void)searchContainerViewController:(nonnull RBSearchContainerViewController *)searchContainerViewController willCloseSearchWithAnimation:(BOOL)animated

Parameters

searchContainerViewController

The RBSearchContainerViewController object.

animated

Whether the transition is animated.

Discussion

Called when the search mode will close.

Declared In

RBSearchContainerViewController.h

– searchContainerViewController:didCloseSearchWithAnimation:

Called when the search mode did close.

- (void)searchContainerViewController:(nonnull RBSearchContainerViewController *)searchContainerViewController didCloseSearchWithAnimation:(BOOL)animated

Parameters

searchContainerViewController

The RBSearchContainerViewController object.

animated

Whether the transition is animated.

Discussion

Called when the search mode did close.

Declared In

RBSearchContainerViewController.h