RBSearchContainerViewController Class Reference
Inherits from | UIViewController |
---|---|
Declared in | RBSearchContainerViewController.h |
view
The underlying search container view object.
@property (nonatomic, nonnull) RBSearchContainerView *view
Discussion
The underlying search container view object.
Declared In
RBSearchContainerViewController.h
delegate
The delegate that receives search and state transition events.
@property (nonatomic, weak, nullable) id<RBSearchContainerViewControllerDelegate> delegate
Discussion
The delegate that receives search and state transition events.
Declared In
RBSearchContainerViewController.h
inSearchMode
Whether or not search mode is currently activated.
@property (nonatomic, readonly) BOOL inSearchMode
Discussion
Whether or not search mode is currently activated.
Declared In
RBSearchContainerViewController.h
queryString
The current query string as it appears in the text field.
@property (nonatomic, nullable) NSString *queryString
Discussion
The current query string as it appears in the text field.
Declared In
RBSearchContainerViewController.h
– openSearchWithAnimation:openKeyboard:completion:
Opens search mode, presenting the resultView
and optionally opening
the search query field for editing.
- (void)openSearchWithAnimation:(BOOL)animated openKeyboard:(BOOL)openKeyboard completion:(nullable dispatch_block_t)completion
Parameters
animated |
Whether or not the transition should be animated. |
---|---|
openKeyboard |
Whether or not to open the keyboard for editing the search query field. |
completion |
An optional block to be called when the transition is complete. |
Discussion
Opens search mode, presenting the resultView
and optionally opening
the search query field for editing.
Declared In
RBSearchContainerViewController.h
– closeSearchWithAnimation:completion:
Closes search mode, presenting the bodyView
again and closing the keyboard if necessary.
- (void)closeSearchWithAnimation:(BOOL)animated completion:(nullable dispatch_block_t)completion
Parameters
animated |
Whether or not the transition should be animated. |
---|---|
completion |
An optional block to be called when the transition is complete. |
Discussion
Closes search mode, presenting the bodyView
again and closing the keyboard if necessary.
Declared In
RBSearchContainerViewController.h
– closeKeyboardWithCompletion:
Closes the keyboard for editing the search query string.
- (void)closeKeyboardWithCompletion:(nullable dispatch_block_t)completion
Parameters
completion |
An optional block to be called when the keyboard has been closed. |
---|
Discussion
Closes the keyboard for editing the search query string.
Declared In
RBSearchContainerViewController.h
– performSearchWithQuery:
Performs a search with the given query. The delegate is notified that the search has been requested.
- (void)performSearchWithQuery:(nonnull NSString *)queryString
Parameters
queryString |
The query string to search with. |
---|
Discussion
Performs a search with the given query. The delegate is notified that the search has been requested.
Declared In
RBSearchContainerViewController.h