aboutsummaryrefslogtreecommitdiffstats
path: root/Software/Visual_Studio/FSE/Tango.FSE.Common/Storage/IStorageProvider.cs
blob: 4ddaddc7018b49e3c659aacf8ad297148d504a0b (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
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
68
69
70
71
72
73
74
75
76
using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Windows.Controls;
using Tango.Core.Commands;
using Tango.FileSystem;

namespace Tango.FSE.Common.Storage
{
    /// <summary>
    /// Represents a local storage provider for browsing through the local file system.
    /// </summary>
    public interface IStorageProvider
    {
        /// <summary>
        /// Gets or sets a value indicating whether use the native file system dialogs.
        /// </summary>
        bool UseNativeDialogs { get; set; }

        /// <summary>
        /// Invokes a single file open dialog.
        /// </summary>
        /// <param name="title">The title.</param>
        /// <param name="filter">The filter.</param>
        /// <param name="initialFolder">The initial folder.</param>
        /// <returns></returns>
        Task<SingleStorageResult> OpenFile(String title, String filter = null, String initialFolder = null);

        /// <summary>
        /// Invokes a multi select file open dialog.
        /// </summary>
        /// <param name="title">The title.</param>
        /// <param name="filter">The filter.</param>
        /// <param name="initialFolder">The initial folder.</param>
        /// <returns></returns>
        Task<MultiStorageResult> OpenFiles(String title, String filter = null, String initialFolder = null);

        /// <summary>
        /// Invokes a multi select file/folder open dialog.
        /// </summary>
        /// <param name="title">The title.</param>
        /// <param name="filter">The filter.</param>
        /// <param name="initialFolder">The initial folder.</param>
        /// <returns></returns>
        Task<MultiStorageResult> SelectFilesAndFolders(String title, String filter = null, String initialFolder = null);

        /// <summary>
        /// Invokes a file save dialog.
        /// </summary>
        /// <param name="title">The title.</param>
        /// <param name="filter">The filter.</param>
        /// <param name="defaultFileName">Default name of the file.</param>
        /// <param name="defaultExtension">The default extension.</param>
        /// <param name="initialFolder">The initial folder.</param>
        /// <returns></returns>
        Task<SingleStorageResult> SaveFile(String title, String filter = null, String defaultFileName = null, String defaultExtension = null, String initialFolder = null);

        /// <summary>
        /// Invokes a single folder selection dialog.
        /// </summary>
        /// <param name="title">The title.</param>
        /// <param name="initialFolder">The initial folder.</param>
        /// <returns></returns>
        Task<SingleStorageResult> SelectFolder(String title, String initialFolder = null);

        /// <summary>
        /// Opens the windows explorer and select the specified file or folder.
        /// </summary>
        /// <param name="path">The file or folder path.</param>
        /// <returns></returns>
        Task ShowInExplorer(String path);
    }
}