aboutsummaryrefslogtreecommitdiffstats
path: root/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.Common/Navigation/INavigationResultProvider.cs
blob: dee037432d0a445644baf700b07a64c8c3eb01ba (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace Tango.MachineStudio.Common.Navigation
{
    /// <summary>
    /// Represents a object which provides a result the navigation system navigates away from it.
    /// </summary>
    /// <typeparam name="TResult">The type of the result.</typeparam>
    /// <typeparam name="TPass">The type of the pass.</typeparam>
    public interface INavigationResultProvider<TResult, TPass>
    {
        /// <summary>
        /// Called when the navigation system requests a result when it is navigating away from this instance.
        /// </summary>
        /// <returns></returns>
        TResult GetNavigationResult();

        /// <summary>
        /// Called when navigation system is going to navigate to this instance with the specified object.
        /// </summary>
        /// <param name="obj">The object.</param>
        void OnNavigationObjectReceived(TPass obj);
    }
}