// -----------------------------------------------------------------------
// <copyright file="DispatcherPriority.cs" company="Steven Kirk">
// Copyright 2014 MIT Licence. See licence.md for more information.
// </copyright>
// -----------------------------------------------------------------------

namespace Perspex.Threading
{
    /// <summary>
    /// Defines the priorities with which jobs can be invoked on a <see cref="Dispatcher"/>.
    /// </summary>
    // TODO: These are copied from WPF - many won't apply to Perspex.
    public enum DispatcherPriority
    {
        /// <summary>
        /// The job will not be processed.
        /// </summary>
        Inactive = 0,

        /// <summary>
        /// The job will be processed when the system is idle.
        /// </summary>
        SystemIdle = 1,

        /// <summary>
        /// The job will be processed when the application sis idle.
        /// </summary>
        ApplicationIdle = 2,

        /// <summary>
        /// The job will be processed after background operations have completed.
        /// </summary>
        ContextIdle = 3,

        /// <summary>
        /// The job will be processed after other non-idle operations have completed.
        /// </summary>
        Background = 4,

        /// <summary>
        /// The job will be processed with the same priority as input.
        /// </summary>
        Input = 5,

        /// <summary>
        /// The job will be processed after layout and render but before input.
        /// </summary>
        Loaded = 6,

        /// <summary>
        /// The job will be processed with the same priority as render.
        /// </summary>
        Render = 7,

        /// <summary>
        /// The job will be processed with the same priority as data binding.
        /// </summary>
        DataBind = 8,

        /// <summary>
        /// The job will be processed with normal priority.
        /// </summary>
        Normal = 9,

        /// <summary>
        /// The job will be processed before other asynchronous operations.
        /// </summary>
        Send = 10,
    }
}