using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Windows.Forms;
using TradeIdeas.MiscSupport;

namespace TradeIdeas.TIProGUI.Surfer
{
    /// <summary>
    /// Status of surfable form.  Available = displaying surfable content, Unavailable = enabled but not displaying surfable content
    /// (another tab displayed perhaps), Disabled = may have surfable content but currently disabled
    /// </summary>
    public enum SurfStatus { Available, Unavailable, Disabled };

    /// <summary>
    /// Implements an interface that allows a surf manager to retrieve the latest items from the object and be
    /// notified when this object has new items or needs to be refreshed.
    /// </summary>
    public interface Surfable
    {
        /// <summary>
        /// Returns a list of RowData objects. The Surfable object can decide which items are to be returned,
        /// but presumably this is a list of the most recently received items or top items in a list defined
        /// by the current sort status.
        /// </summary>
        /// <param name="total">Total number of items to retrieve</param>
        /// <returns></returns>
        List<RowData> Surf(int total);

        /// <summary>
        /// Tells the surfable object to select the item represented by rowData.  Most likely this is simply
        /// marking the item as selected signifying to the user that the selection has occurred.
        /// </summary>
        /// <param name="rowData"></param>
        void SelectItem(RowData rowData);

        /// <summary>
        /// Tells the surfable object that surfing has completed.  The surfable object can perform post 
        /// surfing logc (i.e. clear row/cell selection in AI Strategy trade windows.)
        /// </summary>
        void PostSurfingLogic();

        /// <summary>
        /// Adds a callback that tells the surf manager that the current list of items has been updated
        /// and should be retrieved again.
        /// </summary>
        /// <param name="callback"></param>
        void AddDataRefreshedCallback(Action<Surfable> callback);

        /// <summary>
        /// Adds a callback that tells the surf manager that a new event has occurred.
        /// </summary>
        /// <param name="callback"></param>
        void AddNewEventCallback(Action<Surfable, RowData> callback);

        SurfStatus SurfStatus();

        /// <summary>
        /// Gets the window title for this window.
        /// </summary>
        /// <returns></returns>
        string WindowTitle();

        /// <summary>
        /// Retrieve the DataGridView object for the surfable object.  Return null if there is no DataGridView.
        /// </summary>
        /// <returns></returns>
        DataGridView GetDataGridView();

        Control GetOwner();
    }
}