Avalonia/Perspex.Controls/ISelectable.cs

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

namespace Perspex.Controls
{
    using Perspex.Controls.Primitives;

    /// <summary>
    /// Interface for objects that are selectable.
    /// </summary>
    /// <remarks>
    /// Controls such as <see cref="SelectingItemsControl"/> use this interface to indicate the
    /// selected control in a list. If changing the control's <see cref="IsSelected"/> property
    /// should update the selection in a <see cref="SelectingItemsControl"/> or equivalent, then
    /// the control should raise the <see cref="SelectingItemsControl.IsSelectedChangedEvent"/>.
    /// </remarks>
    public interface ISelectable
    {
        /// <summary>
        /// Gets or sets the selected state of the object.
        /// </summary>
        bool IsSelected { get; set; }
    }
}