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

namespace Perspex.Controls.Generators
{
    using System.Collections.Generic;

    /// <summary>
    /// Holds details about a set of item containers in an <see cref="IItemContainerGenerator"/>.
    /// </summary>
    public class ItemContainers
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="ItemContainers"/> class.
        /// </summary>
        /// <param name="startingIndex">The index of the first container in the source items.</param>
        /// <param name="containers">The containers.</param>
        public ItemContainers(int startingIndex, IList<IControl> containers)
        {
            this.StartingIndex = startingIndex;
            this.Items = containers;
        }

        /// <summary>
        /// Gets the index of the first container in the source items.
        /// </summary>
        public int StartingIndex { get; }

        /// <summary>
        /// Gets the containers. May contain null entries.
        /// </summary>
        public IList<IControl> Items { get; }
    }
}