Software/Visual_Studio/MachineStudio/Tango.MachineStudio.Common/Navigation/INavigationManager.cs


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
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
generated by cgit v1.3.1 (git 2.54.0) at 2026-07-15 07:42:08 +0000
 

 specified module.
        /// </summary>
        /// <typeparam name="T"></typeparam>
        Task<bool> NavigateTo<T>(bool pushToHistory = true) where T : IStudioModule;

        /// <summary>
        /// Navigates to the specified module using the view path (e.g MainView.JobsView).
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="viewPath">The view path.</param>
        Task<bool> NavigateTo<T>(String viewPath, bool pushToHistory = true) where T : IStudioModule;

        /// <summary>
        /// Navigates to the specified module using the view path (e.g MainView,JobsView).
        /// This method makes it easy to do stuff like NavigateTo(nameof(MainView),nameof(JobsView));
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="viewPath">The view path.</param>
        Task<bool> NavigateTo<T>(bool pushToHistory = true, params String[] viewPath) where T : IStudioModule;

        /// <summary>
        /// Navigates to the specified module and view by full path (e.g Jobs.JobsView).
        /// </summary>
        /// <param name="fullPath">The full path.</param>
        Task<bool> NavigateTo(String fullPath, bool pushToHistory = true);

        /// <summary>
        /// Navigates to the specified module and view with the specified object and expecting a return parameter.
        /// The view must be of type INavigationResultProvider<TResult>.
        /// </summary>
        /// <param name="fullPath">The full path.</param>
        Task<TResult> NavigateForResult<TModule, TView, TResult, TPass>(TPass obj, bool pushToHistory = true)
            where TModule : IStudioModule;

        /// <summary>
        /// Navigates to the specified module and view with the specified object.
        /// </summary>
        /// <typeparam name="TModule">The type of the module.</typeparam>
        /// <typeparam name="TView">The type of the view.</typeparam>
        /// <typeparam name="TPass">The type of the pass.</typeparam>
        /// <param name="obj">The object.</param>
        /// <param name="pushToHistory">if set to <c>true</c> [push to history].</param>
        /// <returns></returns>
        Task<bool> NavigateWithObject<TModule, TView, TPass>(TPass obj, bool pushToHistory = true)
               where TModule : IStudioModule;

        void NavigateToModule<T>() where T : IStudioModule;

        /// <summary>
        /// Clears the navigation back history.
        /// </summary>
        void ClearHistory();

        /// <summary>
        /// Clears the navigation back history except the specified view type.
        /// </summary>
        void ClearHistoryExcept<T>();
    }
}