diff options
| author | Roy Ben-Shabat <Roy@Twine-s.com> | 2018-08-13 14:22:32 +0300 |
|---|---|---|
| committer | Roy Ben-Shabat <Roy@Twine-s.com> | 2018-08-13 14:22:32 +0300 |
| commit | 4490b0a76d4188cb285d62b106e208803ceaa133 (patch) | |
| tree | a24f3d5653979ebaff86b524f452d20c74df3327 /Software/Visual_Studio/PPC/Tango.PPC.Common/Navigation | |
| parent | d3c0c73dc2aeae2dacf4224ce7997609132426a1 (diff) | |
| download | Tango-4490b0a76d4188cb285d62b106e208803ceaa133.tar.gz Tango-4490b0a76d4188cb285d62b106e208803ceaa133.zip | |
PPC.Common Logs and comments!
Diffstat (limited to 'Software/Visual_Studio/PPC/Tango.PPC.Common/Navigation')
3 files changed, 22 insertions, 1 deletions
diff --git a/Software/Visual_Studio/PPC/Tango.PPC.Common/Navigation/INavigationObjectReceiver.cs b/Software/Visual_Studio/PPC/Tango.PPC.Common/Navigation/INavigationObjectReceiver.cs index 8c906b106..e0f9fdca6 100644 --- a/Software/Visual_Studio/PPC/Tango.PPC.Common/Navigation/INavigationObjectReceiver.cs +++ b/Software/Visual_Studio/PPC/Tango.PPC.Common/Navigation/INavigationObjectReceiver.cs @@ -6,8 +6,16 @@ using System.Threading.Tasks; namespace Tango.PPC.Common.Navigation { + /// <summary> + /// Represents an object which supports receiving an object as part of the navigation to it. + /// </summary> + /// <typeparam name="T"></typeparam> public interface INavigationObjectReceiver<T> { + /// <summary> + /// Called when navigation system is going to navigate to this instance with the specified object. + /// </summary> + /// <param name="obj">The object.</param> void OnNavigatedToWithObject(T obj); } } diff --git a/Software/Visual_Studio/PPC/Tango.PPC.Common/Navigation/INavigationResultProvider.cs b/Software/Visual_Studio/PPC/Tango.PPC.Common/Navigation/INavigationResultProvider.cs index ddac80620..73a6ca296 100644 --- a/Software/Visual_Studio/PPC/Tango.PPC.Common/Navigation/INavigationResultProvider.cs +++ b/Software/Visual_Studio/PPC/Tango.PPC.Common/Navigation/INavigationResultProvider.cs @@ -6,10 +6,23 @@ using System.Threading.Tasks; namespace Tango.PPC.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); } } diff --git a/Software/Visual_Studio/PPC/Tango.PPC.Common/Navigation/NavigationView.cs b/Software/Visual_Studio/PPC/Tango.PPC.Common/Navigation/NavigationView.cs index 9f9ac3b6a..3c6d91502 100644 --- a/Software/Visual_Studio/PPC/Tango.PPC.Common/Navigation/NavigationView.cs +++ b/Software/Visual_Studio/PPC/Tango.PPC.Common/Navigation/NavigationView.cs @@ -7,7 +7,7 @@ using System.Threading.Tasks; namespace Tango.PPC.Common.Navigation { /// <summary> - /// Represents the available views to navigate to using the <see cref="INavigationManager"/>. + /// Represents the main application views to navigate to using the <see cref="INavigationManager"/>. /// </summary> public enum NavigationView { |