IAggregateActionItem.cs

Go to the documentation of this file.

// Copyright (c) 2014 Silicon Studio Corp. (http://siliconstudio.co.jp)
// This file is distributed under GPL v3. See LICENSE.md for details.
using System.Collections.Generic;

namespace SiliconStudio.ActionStack
{
    /// <summary>
    /// Base interface of aggregate of action items.
    /// </summary>
    public interface IAggregateActionItem : IActionItem
    {
        /// <summary>
        /// Gets the aggregated action items.
        /// </summary>
        IEnumerable<IActionItem> ActionItems { get; }

        /// <summary>
        /// Gets whether the given action item is contained in this aggregate.
        /// </summary>
        /// <param name="actionItem">The action item to look for.</param>
        /// <returns><c>true</c> if this aggregate contains the given action item, <c>false</c> otherwise.</returns>
        bool ContainsAction(IActionItem actionItem);

        /// <summary>
        /// Gets all action items contained in this aggregate that are not <see cref="IAggregateActionItem"/> themselves, recursively.
        /// </summary>
        /// <returns>An enumeration of all action items contained in this aggregate that are not <see cref="IAggregateActionItem"/> themselves, recursively.</returns>
        IEnumerable<IActionItem> GetInnerActionItems();
    }
}