Module: UISearchDisplayDelegate

Overview

This protocol defines delegate methods for UISearchDisplayController objects.Tells the delegate that the controller just hid its table view. Tells the delegate that the controller has loaded its table view. Tells the delegate that the controller just displayed its table view. Asks the delegate if the table view should be reloaded for a given scope. Asks the delegate if the table view should be reloaded for a given search string. Tells the delegate that the controller is about to hide its table view. Tells the delegate that the controller is about to display its table view. Tells the delegate that the controller is about to unload its table view. Tells the delegate that the controller has started searching. Tells the delegate that the controller has finished searching. Tells the delegate that the controller is about to begin searching.Tells the delegate that the controller is about to end searching.

Instance Method Summary (collapse)

Instance Method Details

- (Object) searchDisplayController(controller, didHideSearchResultsTableView:tableView)

Tells the delegate that the controller just hid its table view.

Parameters:

  • controller (UISearchDisplayController) —

    The search display controller for which the receiver is the delegate.

  • tableView (UITableView) —

    The search display controller’s table view.

Returns:

- (Object) searchDisplayController(controller, didLoadSearchResultsTableView:tableView)

Tells the delegate that the controller has loaded its table view.

Parameters:

  • controller (UISearchDisplayController) —

    The search display controller for which the receiver is the delegate.

  • tableView (UITableView) —

    The search display controller’s table view.

Returns:

- (Object) searchDisplayController(controller, didShowSearchResultsTableView:tableView)

Tells the delegate that the controller just displayed its table view.

Parameters:

  • controller (UISearchDisplayController) —

    The search display controller for which the receiver is the delegate.

  • tableView (UITableView) —

    The search display controller’s table view.

Returns:

- (Boolean) searchDisplayController(controller, shouldReloadTableForSearchScope:searchOption)

Asks the delegate if the table view should be reloaded for a given scope. If you don’t implement this method, then the results table is reloaded as soon as the scope button selection changes.You might implement this method if you want to perform an asynchronous search: you would initiate the search in this method, then return NO, and reload the table when you have results.

Parameters:

  • controller (UISearchDisplayController) —

    The search display controller for which the receiver is the delegate.

  • searchOption (Integer) —

    The index of the selected scope button in the search bar.

Returns:

  • (Boolean) —

    YES if the display controller should reload the data in its table view, otherwise NO.

- (Boolean) searchDisplayController(controller, shouldReloadTableForSearchString:searchString)

Asks the delegate if the table view should be reloaded for a given search string. If you don’t implement this method, then the results table is reloaded as soon as the search string changes.You might implement this method if you want to perform an asynchronous search. You would initiate the search in this method, then return NO. You would reload the table when you have results.

Parameters:

  • controller (UISearchDisplayController) —

    The search display controller for which the receiver is the delegate.

  • searchString (String) —

    The string in the search bar.

Returns:

  • (Boolean) —

    YES if the display controller should reload the data in its table view, otherwise NO.

- (Object) searchDisplayController(controller, willHideSearchResultsTableView:tableView)

Tells the delegate that the controller is about to hide its table view.

Parameters:

  • controller (UISearchDisplayController) —

    The search display controller for which the receiver is the delegate.

  • tableView (UITableView) —

    The search display controller’s table view.

Returns:

- (Object) searchDisplayController(controller, willShowSearchResultsTableView:tableView)

Tells the delegate that the controller is about to display its table view.

Parameters:

  • controller (UISearchDisplayController) —

    The search display controller for which the receiver is the delegate.

  • tableView (UITableView) —

    The search display controller’s table view.

Returns:

- (Object) searchDisplayController(controller, willUnloadSearchResultsTableView:tableView)

Tells the delegate that the controller is about to unload its table view.

Parameters:

  • controller (UISearchDisplayController) —

    The search display controller for which the receiver is the delegate.

  • tableView (UITableView) —

    The search display controller’s table view.

Returns:

- (Object) searchDisplayControllerDidBeginSearch(controller)

Tells the delegate that the controller has started searching.

Parameters:

Returns:

- (Object) searchDisplayControllerDidEndSearch(controller)

Tells the delegate that the controller has finished searching.

Parameters:

Returns:

- (Object) searchDisplayControllerWillBeginSearch(controller)

Tells the delegate that the controller is about to begin searching.

Parameters:

Returns:

- (Object) searchDisplayControllerWillEndSearch(controller)

Tells the delegate that the controller is about to end searching.

Parameters:

Returns: