summaryrefslogtreecommitdiffstats
path: root/win/CS/HandBrake.Interop/Interop/EventArgs/ScanProgressEventArgs.cs
blob: 8e87552a2917aa51e3f8a30913107bfb003adba2 (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
// --------------------------------------------------------------------------------------------------------------------
// <copyright file="ScanProgressEventArgs.cs" company="HandBrake Project (http://handbrake.fr)">
//   This file is part of the HandBrake source code - It may be used under the terms of the GNU General Public License.
// </copyright>
// <summary>
//   Defines the ScanProgressEventArgs type.
// </summary>
// --------------------------------------------------------------------------------------------------------------------

namespace HandBrake.Interop.Interop.EventArgs
{
    using System;

    /// <summary>
    /// The Scan Progress Event Args
    /// </summary>
    public class ScanProgressEventArgs : EventArgs
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="ScanProgressEventArgs"/> class.
        /// </summary>
        /// <param name="progress">
        /// The progress.
        /// </param>
        /// <param name="currentPreview">
        /// The current preview.
        /// </param>
        /// <param name="previews">
        /// The previews.
        /// </param>
        /// <param name="currentTitle">
        /// The current title.
        /// </param>
        /// <param name="titles">
        /// The titles.
        /// </param>
        public ScanProgressEventArgs(double progress, int currentPreview, int previews, int currentTitle, int titles)
        {
            this.Progress = progress;
            this.CurrentPreview = currentPreview;
            this.Previews = previews;
            this.CurrentTitle = currentTitle;
            this.Titles = titles;
        }

        /// <summary>
        /// Gets the total progress fraction for the scan.
        /// </summary>
        public double Progress { get; private set; }

        /// <summary>
        /// Gets the current preview being processed on the scan.
        /// </summary>
        public int CurrentPreview { get; private set; }

        /// <summary>
        /// Gets the total number of previews to process.
        /// </summary>
        public int Previews { get; private set; }

        /// <summary>
        /// Gets the current title being processed on the scan.
        /// </summary>
        public int CurrentTitle { get; private set; }

        /// <summary>
        /// Gets the total number of titles to process.
        /// </summary>
        public int Titles { get; private set; }
    }
}