Avalonia/src/Avalonia.Controls/Automation/AutomationProperties.cs

using System;
using Avalonia.Automation.Peers;
using Avalonia.Controls;

namespace Avalonia.Automation
{
    /// <summary>
    /// Declares how a control should included in different views of the automation tree.
    /// </summary>
    public enum AccessibilityView
    {
        /// <summary>
        /// The control's view is defined by its automation peer.
        /// </summary>
        Default,

        /// <summary>
        /// The control is included in the Raw view of the automation tree.
        /// </summary>
        Raw,

        /// <summary>
        /// The control is included in the Control view of the automation tree.
        /// </summary>
        Control,

        /// <summary>
        /// The control is included in the Content view of the automation tree.
        /// </summary>
        Content,
    }

    public static class AutomationProperties
    {
        internal const int AutomationPositionInSetDefault = -1;
        internal const int AutomationSizeOfSetDefault = -1;

        /// <summary>
        /// Defines the AutomationProperties.AcceleratorKey attached property.
        /// </summary>
        /// <remarks>
        /// This property affects the default value for <see cref="AutomationPeer.GetAcceleratorKey"/>.
        /// </remarks>
        public static readonly AttachedProperty<string?> AcceleratorKeyProperty =
            AvaloniaProperty.RegisterAttached<StyledElement, string?>(
                "AcceleratorKey",
                typeof(AutomationProperties));

        /// <summary>
        /// Defines the AutomationProperties.AccessibilityView attached property.
        /// </summary>
        /// <remarks>
        /// The value of this property affects the default value of the
        /// <see cref="AutomationPeer.IsContentElement"/> and
        /// <see cref="AutomationPeer.IsControlElement"/> properties.
        /// </remarks>
        public static readonly AttachedProperty<AccessibilityView> AccessibilityViewProperty =
            AvaloniaProperty.RegisterAttached<StyledElement, AccessibilityView>(
                "AccessibilityView",
                typeof(AutomationProperties));

        /// <summary>
        /// Defines the AutomationProperties.AccessKey attached property
        /// </summary>
        /// <remarks>
        /// This property affects the default value for <see cref="AutomationPeer.GetAccessKey"/>.
        /// </remarks>
        public static readonly AttachedProperty<string?> AccessKeyProperty =
            AvaloniaProperty.RegisterAttached<StyledElement, string?>(
                "AccessKey",
                typeof(AutomationProperties));

        /// <summary>
        /// Defines the AutomationProperties.AutomationId attached property.
        /// </summary>
        /// <remarks>
        /// This property affects the default value for <see cref="AutomationPeer.GetAutomationId"/>.
        /// </remarks>
        public static readonly AttachedProperty<string?> AutomationIdProperty =
            AvaloniaProperty.RegisterAttached<StyledElement, string?>(
                "AutomationId",
                typeof(AutomationProperties));

        /// <summary>
        /// Defines the AutomationProperties.ControlTypeOverride attached property.
        /// </summary>
        /// <remarks>
        /// This property affects the default value for
        /// <see cref="AutomationPeer.GetAutomationControlType"/>.
        /// </remarks>
        public static readonly AttachedProperty<AutomationControlType?> ControlTypeOverrideProperty =
            AvaloniaProperty.RegisterAttached<StyledElement, AutomationControlType?>(
                "ControlTypeOverride",
                typeof(AutomationProperties));

        /// <summary>
        /// Defines the AutomationProperties.HelpText attached property.
        /// </summary>
        /// <remarks>
        /// This property affects the default value for <see cref="AutomationPeer.GetHelpText"/>.
        /// </remarks>
        public static readonly AttachedProperty<string?> HelpTextProperty =
            AvaloniaProperty.RegisterAttached<StyledElement, string?>(
                "HelpText",
                typeof(AutomationProperties));

        /// <summary>
        /// Defines the AutomationProperties.LandmarkType attached property.
        /// </summary>
        /// <remarks>
        /// This property affects the default value for <see cref="AutomationPeer.GetLandmarkType"/>
        /// </remarks>
        public static readonly AttachedProperty<AutomationLandmarkType?> LandmarkTypeProperty =
            AvaloniaProperty.RegisterAttached<StyledElement, AutomationLandmarkType?>(
                "LandmarkType",
                typeof(AutomationProperties));

        /// <summary>
        /// Defines the AutomationProperties.HeadingLevel attached property.
        /// </summary>
        /// <remarks>
        /// This property affects the default value for <see cref="AutomationPeer.GetHeadingLevel"/>.
        /// </remarks>
        public static readonly AttachedProperty<int> HeadingLevelProperty =
            AvaloniaProperty.RegisterAttached<StyledElement, int>(
                "HeadingLevel",
                typeof(AutomationProperties));

        /// <summary>
        /// Defines the AutomationProperties.IsColumnHeader attached property.
        /// </summary>
        /// <remarks>
        /// This property currently has no effect.
        /// </remarks>
        public static readonly AttachedProperty<bool> IsColumnHeaderProperty =
            AvaloniaProperty.RegisterAttached<StyledElement, bool>(
                "IsColumnHeader",
                typeof(AutomationProperties),
                false);

        /// <summary>
        /// Defines the AutomationProperties.IsRequiredForForm attached property.
        /// </summary>
        /// <remarks>
        /// This property currently has no effect.
        /// </remarks>
        public static readonly AttachedProperty<bool> IsRequiredForFormProperty =
            AvaloniaProperty.RegisterAttached<StyledElement, bool>(
                "IsRequiredForForm",
                typeof(AutomationProperties),
                false);

        /// <summary>
        /// Defines the AutomationProperties.IsRowHeader attached property.
        /// </summary>
        /// <remarks>
        /// This property currently has no effect.
        /// </remarks>
        public static readonly AttachedProperty<bool> IsRowHeaderProperty =
            AvaloniaProperty.RegisterAttached<StyledElement, bool>(
                "IsRowHeader",
                typeof(AutomationProperties),
                false);

        /// <summary>
        /// Defines the AutomationProperties.IsOffscreenBehavior attached property.
        /// </summary>
        /// <remarks>
        /// This property affects the default value for <see cref="AutomationPeer.IsOffscreen"/>.
        /// </remarks>
        public static readonly AttachedProperty<IsOffscreenBehavior> IsOffscreenBehaviorProperty =
            AvaloniaProperty.RegisterAttached<StyledElement, IsOffscreenBehavior>(
                "IsOffscreenBehavior",
                typeof(AutomationProperties),
                IsOffscreenBehavior.Default);

        /// <summary>
        /// Defines the AutomationProperties.ItemStatus attached property.
        /// </summary>
        /// <remarks>
        /// This property currently has no effect.
        /// </remarks>
        public static readonly AttachedProperty<string?> ItemStatusProperty =
            AvaloniaProperty.RegisterAttached<StyledElement, string?>(
                "ItemStatus",
                typeof(AutomationProperties));

        /// <summary>
        /// Defines the AutomationProperties.ItemType attached property.
        /// </summary>
        /// <remarks>
        /// This property currently has no effect.
        /// </remarks>
        public static readonly AttachedProperty<string?> ItemTypeProperty =
            AvaloniaProperty.RegisterAttached<StyledElement, string?>(
                "ItemType",
                typeof(AutomationProperties));

        /// <summary>
        /// Defines the AutomationProperties.LabeledBy attached property.
        /// </summary>
        /// <remarks>
        /// This property affects the default value for <see cref="AutomationPeer.GetLabeledBy"/>.
        /// </remarks>
        public static readonly AttachedProperty<Control> LabeledByProperty =
            AvaloniaProperty.RegisterAttached<StyledElement, Control>(
                "LabeledBy",
                typeof(AutomationProperties));

        /// <summary>
        /// Defines the AutomationProperties.LiveSetting attached property.
        /// </summary>
        /// <remarks>
        /// This property affects the default value for <see cref="AutomationPeer.GetLiveSetting"/> and controls whether live region changed events are emitted.
        /// </remarks>
        public static readonly AttachedProperty<AutomationLiveSetting> LiveSettingProperty =
            AvaloniaProperty.RegisterAttached<StyledElement, AutomationLiveSetting>(
                "LiveSetting",
                typeof(AutomationProperties),
                AutomationLiveSetting.Off);

        /// <summary>
        /// Defines the AutomationProperties.Name attached attached property.
        /// </summary>
        /// <remarks>
        /// This property affects the default value for <see cref="AutomationPeer.GetName"/>.
        /// </remarks>
        public static readonly AttachedProperty<string?> NameProperty =
            AvaloniaProperty.RegisterAttached<StyledElement, string?>(
                "Name",
                typeof(AutomationProperties));

        /// <summary>
        /// Defines the AutomationProperties.PositionInSet attached property.
        /// </summary>
        /// <remarks>
        /// NOTE: This property currently has no effect.
        /// 
        /// The PositionInSet property describes the ordinal location of the element within a set
        /// of elements which are considered to be siblings. PositionInSet works in coordination
        /// with the SizeOfSet property to describe the ordinal location in the set.
        /// </remarks>
        public static readonly AttachedProperty<int> PositionInSetProperty =
            AvaloniaProperty.RegisterAttached<StyledElement, int>(
                "PositionInSet",
                typeof(AutomationProperties),
                AutomationPositionInSetDefault);

        /// <summary>
        /// Defines the AutomationProperties.SizeOfSet attached property.
        /// </summary>
        /// <remarks>
        /// NOTE: This property currently has no effect.
        /// 
        /// The SizeOfSet property describes the count of automation elements in a group or set
        /// that are considered to be siblings. SizeOfSet works in coordination with the PositionInSet
        /// property to describe the count of items in the set.
        /// </remarks>
        public static readonly AttachedProperty<int> SizeOfSetProperty =
            AvaloniaProperty.RegisterAttached<StyledElement, int>(
                "SizeOfSet",
                typeof(AutomationProperties),
                AutomationSizeOfSetDefault);

        /// <summary>
        /// Helper for setting the value of the <see cref="AcceleratorKeyProperty"/> on a StyledElement. 
        /// </summary>
        public static void SetAcceleratorKey(StyledElement element, string value)
        {
            _ = element ?? throw new ArgumentNullException(nameof(element));
            element.SetValue(AcceleratorKeyProperty, value);
        }

        /// <summary>
        /// Helper for reading the value of the <see cref="AcceleratorKeyProperty"/> on a StyledElement.
        /// </summary>
        public static string? GetAcceleratorKey(StyledElement element)
        {
            _ = element ?? throw new ArgumentNullException(nameof(element));
            return element.GetValue(AcceleratorKeyProperty);
        }

        /// <summary>
        /// Helper for setting the value of the <see cref="AccessibilityViewProperty"/> on a StyledElement. 
        /// </summary>
        public static void SetAccessibilityView(StyledElement element, AccessibilityView value)
        {
            _ = element ?? throw new ArgumentNullException(nameof(element));
            element.SetValue(AccessibilityViewProperty, value);
        }

        /// <summary>
        /// Helper for reading the value of the <see cref="AccessibilityViewProperty"/> on a StyledElement.
        /// </summary>
        public static AccessibilityView GetAccessibilityView(StyledElement element)
        {
            _ = element ?? throw new ArgumentNullException(nameof(element));
            return element.GetValue(AccessibilityViewProperty);
        }

        /// <summary>
        /// Helper for setting the value of the <see cref="AccessKeyProperty"/> on a StyledElement. 
        /// </summary>
        public static void SetAccessKey(StyledElement element, string value)
        {
            _ = element ?? throw new ArgumentNullException(nameof(element));
            element.SetValue(AccessKeyProperty, value);
        }

        /// <summary>
        /// Helper for reading the value of the <see cref="AccessKeyProperty"/> on a StyledElement.
        /// </summary>
        public static string? GetAccessKey(StyledElement element)
        {
            _ = element ?? throw new ArgumentNullException(nameof(element));
            return element.GetValue(AccessKeyProperty);
        }

        /// <summary>
        /// Helper for setting the value of the <see cref="AutomationIdProperty"/> on a StyledElement. 
        /// </summary>
        public static void SetAutomationId(StyledElement element, string? value)
        {
            _ = element ?? throw new ArgumentNullException(nameof(element));
            element.SetValue(AutomationIdProperty, value);
        }

        /// <summary>
        /// Helper for reading the value of the <see cref="AutomationIdProperty"/> on a StyledElement.
        /// </summary>
        public static string? GetAutomationId(StyledElement element)
        {
            _ = element ?? throw new ArgumentNullException(nameof(element));
            return element.GetValue(AutomationIdProperty);
        }

        /// <summary>
        /// Helper for setting the value of the <see cref="ControlTypeOverrideProperty"/> on a StyledElement. 
        /// </summary>
        public static void SetControlTypeOverride(StyledElement element, AutomationControlType? value)
        {
            _ = element ?? throw new ArgumentNullException(nameof(element));
            element.SetValue(ControlTypeOverrideProperty, value);
        }

        /// <summary>
        /// Helper for reading the value of the <see cref="ControlTypeOverrideProperty"/> on a StyledElement.
        /// </summary>
        public static AutomationControlType? GetControlTypeOverride(StyledElement element)
        {
            _ = element ?? throw new ArgumentNullException(nameof(element));
            return element.GetValue(ControlTypeOverrideProperty);
        }

        /// <summary>
        /// Helper for setting the value of the <see cref="HelpTextProperty"/> on a StyledElement. 
        /// </summary>
        public static void SetHelpText(StyledElement element, string? value)
        {
            _ = element ?? throw new ArgumentNullException(nameof(element));
            element.SetValue(HelpTextProperty, value);
        }

        /// <summary>
        /// Helper for reading the value of the <see cref="HelpTextProperty"/> on a StyledElement.
        /// </summary>
        public static string? GetHelpText(StyledElement element)
        {
            _ = element ?? throw new ArgumentNullException(nameof(element));
            return element.GetValue(HelpTextProperty);
        }

        /// <summary>
        /// Helper for setting the value of the <see cref="LandmarkTypeProperty"/> on a StyledElement.
        /// </summary>
        public static void SetLandmarkType(StyledElement element, AutomationLandmarkType? value)
        {
            _ = element ?? throw new ArgumentNullException(nameof(element));
            element.SetValue(LandmarkTypeProperty, value);
        }

        /// <summary>
        /// Helper for reading the value of the <see cref="LandmarkTypeProperty"/> on a StyledElement.
        /// </summary>
        public static AutomationLandmarkType? GetLandmarkType(StyledElement element)
        {
            _ = element ?? throw new ArgumentNullException(nameof(element));
            return element.GetValue(LandmarkTypeProperty);
        }

        /// <summary>
        /// Helper for setting the value of the <see cref="HeadingLevelProperty"/> on a StyledElement.
        /// </summary>
        public static void SetHeadingLevel(StyledElement element, int value)
        {
            _ = element ?? throw new ArgumentNullException(nameof(element));
            element.SetValue(HeadingLevelProperty, value);
        }

        /// <summary>
        /// Helper for reading the value of the <see cref="HeadingLevelProperty"/> on a StyledElement.
        /// </summary>
        public static int GetHeadingLevel(StyledElement element)
        {
            _ = element ?? throw new ArgumentNullException(nameof(element));
            return element.GetValue(HeadingLevelProperty);
        }

        /// <summary>
        /// Helper for setting the value of the <see cref="IsColumnHeaderProperty"/> on a StyledElement. 
        /// </summary>
        public static void SetIsColumnHeader(StyledElement element, bool value)
        {
            _ = element ?? throw new ArgumentNullException(nameof(element));
            element.SetValue(IsColumnHeaderProperty, value);
        }

        /// <summary>
        /// Helper for reading the value of the <see cref="IsColumnHeaderProperty"/> on a StyledElement.
        /// </summary>
        public static bool GetIsColumnHeader(StyledElement element)
        {
            _ = element ?? throw new ArgumentNullException(nameof(element));
            return element.GetValue(IsColumnHeaderProperty);
        }

        /// <summary>
        /// Helper for setting the value of the <see cref="IsRequiredForFormProperty"/> on a StyledElement. 
        /// </summary>
        public static void SetIsRequiredForForm(StyledElement element, bool value)
        {
            _ = element ?? throw new ArgumentNullException(nameof(element));
            element.SetValue(IsRequiredForFormProperty, value);
        }

        /// <summary>
        /// Helper for reading the value of the <see cref="IsRequiredForFormProperty"/> on a StyledElement.
        /// </summary>
        public static bool GetIsRequiredForForm(StyledElement element)
        {
            _ = element ?? throw new ArgumentNullException(nameof(element));
            return element.GetValue(IsRequiredForFormProperty);
        }

        /// <summary>
        /// Helper for reading the value of the <see cref="IsRowHeaderProperty"/> on a StyledElement.
        /// </summary>
        public static bool GetIsRowHeader(StyledElement element)
        {
            _ = element ?? throw new ArgumentNullException(nameof(element));
            return element.GetValue(IsRowHeaderProperty);
        }

        /// <summary>
        /// Helper for setting the value of the <see cref="IsRowHeaderProperty"/> on a StyledElement. 
        /// </summary>
        public static void SetIsRowHeader(StyledElement element, bool value)
        {
            _ = element ?? throw new ArgumentNullException(nameof(element));
            element.SetValue(IsRowHeaderProperty, value);
        }

        /// <summary>
        /// Helper for setting the value of the <see cref="IsOffscreenBehaviorProperty"/> on a StyledElement. 
        /// </summary>
        public static void SetIsOffscreenBehavior(StyledElement element, IsOffscreenBehavior value)
        {
            _ = element ?? throw new ArgumentNullException(nameof(element));
            element.SetValue(IsOffscreenBehaviorProperty, value);
        }

        /// <summary>
        /// Helper for reading the value of the <see cref="IsOffscreenBehaviorProperty"/> on a StyledElement.
        /// </summary>
        public static IsOffscreenBehavior GetIsOffscreenBehavior(StyledElement element)
        {
            _ = element ?? throw new ArgumentNullException(nameof(element));
            return element.GetValue(IsOffscreenBehaviorProperty);
        }

        /// <summary>
        /// Helper for setting the value of the <see cref="ItemStatusProperty"/> on a StyledElement. 
        /// </summary>
        public static void SetItemStatus(StyledElement element, string? value)
        {
            _ = element ?? throw new ArgumentNullException(nameof(element));
            element.SetValue(ItemStatusProperty, value);
        }

        /// <summary>
        /// Helper for reading the value of the <see cref="ItemStatusProperty"/> on a StyledElement.
        /// </summary>
        public static string? GetItemStatus(StyledElement element)
        {
            _ = element ?? throw new ArgumentNullException(nameof(element));
            return element.GetValue(ItemStatusProperty);
        }

        /// <summary>
        /// Helper for setting the value of the <see cref="ItemTypeProperty"/> on a StyledElement. 
        /// </summary>
        public static void SetItemType(StyledElement element, string? value)
        {
            _ = element ?? throw new ArgumentNullException(nameof(element));
            element.SetValue(ItemTypeProperty, value);
        }

        /// <summary>
        /// Helper for reading the value of the <see cref="ItemTypeProperty"/> on a StyledElement.
        /// </summary>
        public static string? GetItemType(StyledElement element)
        {
            _ = element ?? throw new ArgumentNullException(nameof(element));
            return element.GetValue(ItemTypeProperty);
        }

        /// <summary>
        /// Helper for setting the value of the <see cref="LabeledByProperty"/> on a StyledElement. 
        /// </summary>
        public static void SetLabeledBy(StyledElement element, Control value)
        {
            _ = element ?? throw new ArgumentNullException(nameof(element));
            element.SetValue(LabeledByProperty, value);
        }

        /// <summary>
        /// Helper for reading the value of the <see cref="LabeledByProperty"/> on a StyledElement.
        /// </summary>
        public static Control GetLabeledBy(StyledElement element)
        {
            _ = element ?? throw new ArgumentNullException(nameof(element));
            return element.GetValue(LabeledByProperty);
        }

        /// <summary>
        /// Helper for setting the value of the <see cref="LiveSettingProperty"/> on a StyledElement. 
        /// </summary>
        public static void SetLiveSetting(StyledElement element, AutomationLiveSetting value)
        {
            _ = element ?? throw new ArgumentNullException(nameof(element));
            element.SetValue(LiveSettingProperty, value);
        }

        /// <summary>
        /// Helper for reading the value of the <see cref="LiveSettingProperty"/> on a StyledElement.
        /// </summary>
        public static AutomationLiveSetting GetLiveSetting(StyledElement element)
        {
            _ = element ?? throw new ArgumentNullException(nameof(element));
            return element.GetValue(LiveSettingProperty);
        }

        /// <summary>
        /// Helper for setting the value of the <see cref="NameProperty"/> on a StyledElement. 
        /// </summary>
        public static void SetName(StyledElement element, string? value)
        {
            _ = element ?? throw new ArgumentNullException(nameof(element));
            element.SetValue(NameProperty, value);
        }

        /// <summary>
        /// Helper for reading the value of the <see cref="NameProperty"/> on a StyledElement.
        /// </summary>
        public static string? GetName(StyledElement element)
        {
            _ = element ?? throw new ArgumentNullException(nameof(element));
            return element.GetValue(NameProperty);
        }

        /// <summary>
        /// Helper for setting the value of the <see cref="PositionInSetProperty"/> on a StyledElement. 
        /// </summary>
        public static void SetPositionInSet(StyledElement element, int value)
        {
            _ = element ?? throw new ArgumentNullException(nameof(element));
            element.SetValue(PositionInSetProperty, value);
        }

        /// <summary>
        /// Helper for reading the value of the <see cref="PositionInSetProperty"/> on a StyledElement.
        /// </summary>
        public static int GetPositionInSet(StyledElement element)
        {
            _ = element ?? throw new ArgumentNullException(nameof(element));
            return element.GetValue(PositionInSetProperty);
        }

        /// <summary>
        /// Helper for setting the value of the <see cref="SizeOfSetProperty"/> on a StyledElement. 
        /// </summary>
        public static void SetSizeOfSet(StyledElement element, int value)
        {
            _ = element ?? throw new ArgumentNullException(nameof(element));
            element.SetValue(SizeOfSetProperty, value);
        }

        /// <summary>
        /// Helper for reading the value of the <see cref="SizeOfSetProperty"/> on a StyledElement.
        /// </summary>
        public static int GetSizeOfSet(StyledElement element)
        {
            _ = element ?? throw new ArgumentNullException(nameof(element));
            return element.GetValue(SizeOfSetProperty);
        }
    }
}