path: root/CocoaSharp/UIKit/Protocols/Delegates/UISearchDisplayDelegate.cs

using ObjectiveC;
using System;
using SharpSwift.Attributes;
using System.Collections.Generic;
using Foundation;
using CoreGraphics;

namespace UIKit
{
    /// <summary>
    /// Important: UISearchDisplayDelegate is deprecated in iOS 8. (Note that UISearchDisplayController is also deprecated.) To manage the presentation of a search bar and display search results in iOS 8 and later, instead use UISearchControllerDelegate.
    /// </summary>
    /// <see cref="https://developer.apple.com/library/prerelease/ios/documentation/UIKit/Reference/UISearchDisplayDelegate_Protocol/index.html#//apple_ref/occ/intf/UISearchDisplayDelegate"/>
    [iOSVersion(3)]
    [Export("")]
    public interface UISearchDisplayDelegate//: NSObjectProtocol
    {
        /// <summary>
        /// Tells the delegate that the controller is about to begin searching.
        /// </summary>
        /// <param name="controller">The search display controller for which the receiver is the delegate.</param>
        //[iOSVersion(3)]
        //[Export("searchDisplayControllerWillBeginSearch")]
        //[InheritOptional]
        //void SearchDisplayControllerWillBeginSearch(UISearchDisplayController controller);
        
        /// <summary>
        /// Tells the delegate that the controller has started searching.
        /// </summary>
        /// <param name="controller">The search display controller for which the receiver is the delegate.</param>
        //[iOSVersion(3)]
        //[Export("searchDisplayControllerDidBeginSearch")]
        //[InheritOptional]
        //void SearchDisplayControllerDidBeginSearch(UISearchDisplayController controller);
        
        /// <summary>
        /// Tells the delegate that the controller is about to end searching.
        /// </summary>
        /// <param name="controller">The search display controller for which the receiver is the delegate.</param>
        //[iOSVersion(3)]
        //[Export("searchDisplayControllerWillEndSearch")]
        //[InheritOptional]
        //void SearchDisplayControllerWillEndSearch(UISearchDisplayController controller);
        
        /// <summary>
        /// Tells the delegate that the controller has finished searching.
        /// </summary>
        /// <param name="controller">The search display controller for which the receiver is the delegate.</param>
        //[iOSVersion(3)]
        //[Export("searchDisplayControllerDidEndSearch")]
        //[InheritOptional]
        //void SearchDisplayControllerDidEndSearch(UISearchDisplayController controller);
        
        /// <summary>
        /// Tells the delegate that the controller has loaded its table view.
        /// </summary>
        /// <param name="controller">The search display controller for which the receiver is the delegate.</param>
        /// <param name="didLoadSearchResultsTableView">The search display controller’s table view.</param>
        //[iOSVersion(3)]
        //[Export("searchDisplayController")]
        //[InheritOptional]
        //void SearchDisplayController(UISearchDisplayController controller, UITableView didLoadSearchResultsTableView);
        
        /// <summary>
        /// Tells the delegate that the controller is about to unload its table view.
        /// </summary>
        /// <param name="controller">The search display controller for which the receiver is the delegate.</param>
        /// <param name="willUnloadSearchResultsTableView">The search display controller’s table view.</param>
        /// <param name="NAME_YOUR_PARAMS">DO NOT USE THIS PARAMETER - Instead make sure to name the parameters you're using.</param>
        //[iOSVersion(3)]
        //[Export("searchDisplayController")]
        //[InheritOptional]
        //[IgnoreParameter("NAME_YOUR_PARAMS")]
        //void SearchDisplayController(UISearchDisplayController controller, UITableView willUnloadSearchResultsTableView, bool NAME_YOUR_PARAMS = false);
        
        /// <summary>
        /// Tells the delegate that the controller is about to display its table view.
        /// </summary>
        /// <param name="controller">The search display controller for which the receiver is the delegate.</param>
        /// <param name="willShowSearchResultsTableView">The search display controller’s table view.</param>
        /// <param name="NAME_YOUR_PARAMS">DO NOT USE THIS PARAMETER - Instead make sure to name the parameters you're using.</param>
        //[iOSVersion(3)]
        //[Export("searchDisplayController")]
        //[InheritOptional]
        //[IgnoreParameter("NAME_YOUR_PARAMS")]
        //void SearchDisplayController(UISearchDisplayController controller, UITableView willShowSearchResultsTableView, int NAME_YOUR_PARAMS = 0);
        
        /// <summary>
        /// Tells the delegate that the controller just displayed its table view.
        /// </summary>
        /// <param name="controller">The search display controller for which the receiver is the delegate.</param>
        /// <param name="didShowSearchResultsTableView">The search display controller’s table view.</param>
        /// <param name="NAME_YOUR_PARAMS">DO NOT USE THIS PARAMETER - Instead make sure to name the parameters you're using.</param>
        //[iOSVersion(3)]
        //[Export("searchDisplayController")]
        //[InheritOptional]
        //[IgnoreParameter("NAME_YOUR_PARAMS")]
        //void SearchDisplayController(UISearchDisplayController controller, UITableView didShowSearchResultsTableView, string NAME_YOUR_PARAMS = "");
        
        /// <summary>
        /// Tells the delegate that the controller is about to hide its table view.
        /// </summary>
        /// <param name="controller">The search display controller for which the receiver is the delegate.</param>
        /// <param name="willHideSearchResultsTableView">The search display controller’s table view.</param>
        /// <param name="NAME_YOUR_PARAMS">DO NOT USE THIS PARAMETER - Instead make sure to name the parameters you're using.</param>
        //[iOSVersion(3)]
        //[Export("searchDisplayController")]
        //[InheritOptional]
        //[IgnoreParameter("NAME_YOUR_PARAMS")]
        //void SearchDisplayController(UISearchDisplayController controller, UITableView willHideSearchResultsTableView, double NAME_YOUR_PARAMS = 4.2);
        
        /// <summary>
        /// Tells the delegate that the controller just hid its table view.
        /// </summary>
        /// <param name="controller">The search display controller for which the receiver is the delegate.</param>
        /// <param name="didHideSearchResultsTableView">The search display controller’s table view.</param>
        /// <param name="NAME_YOUR_PARAMS">DO NOT USE THIS PARAMETER - Instead make sure to name the parameters you're using.</param>
        //[iOSVersion(3)]
        //[Export("searchDisplayController")]
        //[InheritOptional]
        //[IgnoreParameter("NAME_YOUR_PARAMS")]
        //void SearchDisplayController(UISearchDisplayController controller, UITableView didHideSearchResultsTableView, uint NAME_YOUR_PARAMS = 4.2);
        
        /// <summary>
        /// Asks the delegate if the table view should be reloaded for a given search string.
        /// </summary>
        /// <param name="controller">The search display controller for which the receiver is the delegate.</param>
        /// <param name="shouldReloadTableForSearchString">The string in the search bar.</param>
        //[iOSVersion(3)]
        //[Export("searchDisplayController")]
        //[InheritOptional]
        //bool SearchDisplayController(UISearchDisplayController controller, [Unwrapped] string shouldReloadTableForSearchString);
        
        /// <summary>
        /// Asks the delegate if the table view should be reloaded for a given scope.
        /// </summary>
        /// <param name="controller">The search display controller for which the receiver is the delegate.</param>
        /// <param name="shouldReloadTableForSearchScope">The index of the selected scope button in the search bar.</param>
        //[iOSVersion(3)]
        //[Export("searchDisplayController")]
        //[InheritOptional]
        //bool SearchDisplayController(UISearchDisplayController controller, int shouldReloadTableForSearchScope);
    }
}