Avalonia/src/Perspex.Controls/Generators/ITreeItemContainerGenerator.cs

// Copyright (c) The Perspex Project. All rights reserved.
// Licensed under the MIT license. See licence.md file in the project root for full license information.

using System.Collections.Generic;

namespace Perspex.Controls.Generators
{
    /// <summary>
    /// Creates containers for tree items and maintains a list of created containers.
    /// </summary>
    public interface ITreeItemContainerGenerator : IItemContainerGenerator
    {
        /// <summary>
        /// Gets the item container for the root of the tree, or null if this generator is itself 
        /// the root of the tree.
        /// </summary>
        ITreeItemContainerGenerator RootGenerator { get; }

        /// <summary>
        /// Gets the item container for the specified item, anywhere in the tree.
        /// </summary>
        /// <param name="item">The item.</param>
        /// <returns>The container, or null if not found.</returns>
        IControl TreeContainerFromItem(object item);

        /// <summary>
        /// Gets the item for the specified item container, anywhere in the tree.
        /// </summary>
        /// <param name="container">The container.</param>
        /// <returns>The item, or null if not found.</returns>
        object TreeItemFromContainer(IControl container);
    }
}