using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace Tango.PPC.Common
{
    /// <summary>
    /// Represents a <see cref="IPPCModule"/> attribute
    /// </summary>
    /// <seealso cref="System.Attribute" />
    [AttributeUsage(AttributeTargets.Class)]
    public class PPCModuleAttribute : Attribute
    {
        /// <summary>
        /// Gets or sets the module index.
        /// </summary>
        public int Index { get; private set; }

        /// <summary>
        /// Gets or sets the home view.
        /// </summary>
        public String HomeViewName { get; set; }

        /// <summary>
        /// Gets or sets a value indicating whether to dock this module menu item to the bottom..
        /// </summary>
        public bool DockToBottom { get; set; }

        /// <summary>
        /// Initializes a new instance of the <see cref="PPCModuleAttribute"/> class.
        /// </summary>
        /// <param name="index">The module index.</param>
        public PPCModuleAttribute(int index)
        {
            Index = index;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="PPCModuleAttribute"/> class.
        /// </summary>
        /// <param name="index">The module index.</param>
        /// <param name="homeViewName">Name of the home view.</param>
        public PPCModuleAttribute(int index, String homeViewName) : this(index)
        {
            HomeViewName = homeViewName;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="PPCModuleAttribute"/> class.
        /// </summary>
        /// <param name="index">The module index.</param>
        /// <param name="homeViewName">Name of the home view.</param>
        public PPCModuleAttribute(int index, String homeViewName, bool dockToBottom) : this(index, homeViewName)
        {
            HomeViewName = homeViewName;
            DockToBottom = dockToBottom;
        }
    }
}