Add taskbar progress indicator support (#2695)

native/Avalonia.Native/src/OSX/WindowImpl.h

@@ -70,6 +70,10 @@ BEGIN_INTERFACE_MAP()
 
     virtual HRESULT GetWindowZOrder (long* zOrder) override;
 
+    virtual HRESULT SetDockProgressState (int state) override;
+
+    virtual HRESULT SetDockProgressValue (double progress) override;
+
     void EnterFullScreenMode ();
 
     void ExitFullScreenMode ();

native/Avalonia.Native/src/OSX/WindowImpl.mm

@@ -635,6 +635,72 @@
     [zoomButton setEnabled:CanZoom() || (([Window styleMask] & NSWindowStyleMaskFullScreen) != 0 && _isEnabled)];
 }
 
+static NSProgressIndicator* s_dockProgressIndicator = nullptr;
+static NSView* s_dockContentView = nullptr;
+
+static void EnsureDockProgressIndicator() {
+    static dispatch_once_t onceToken;
+    dispatch_once(&onceToken, ^{
+        NSDockTile *dockTile = [[NSApplication sharedApplication] dockTile];
+        NSImageView *iconView = [[NSImageView alloc] init];
+        [iconView setImage:[NSApplication sharedApplication].applicationIconImage];
+
+        NSRect frame = NSMakeRect(0, 0, dockTile.size.width, 15);
+        s_dockProgressIndicator = [[NSProgressIndicator alloc] initWithFrame:frame];
+        [s_dockProgressIndicator setStyle:NSProgressIndicatorStyleBar];
+        [s_dockProgressIndicator setMinValue:0.0];
+        [s_dockProgressIndicator setMaxValue:1.0];
+        [s_dockProgressIndicator setDoubleValue:0.0];
+        [s_dockProgressIndicator setHidden:YES];
+
+        s_dockContentView = [[NSView alloc] init];
+        [s_dockContentView addSubview:iconView];
+        [s_dockContentView addSubview:s_dockProgressIndicator];
+
+        [iconView setFrame:NSMakeRect(0, 0, dockTile.size.width, dockTile.size.height)];
+
+        [dockTile setContentView:s_dockContentView];
+    });
+}
+
+HRESULT WindowImpl::SetDockProgressState(int state) {
+    START_COM_CALL;
+
+    @autoreleasepool {
+        EnsureDockProgressIndicator();
+
+        if (state == 0) {
+            // None
+            [s_dockProgressIndicator setHidden:YES];
+            [s_dockProgressIndicator setIndeterminate:NO];
+        } else if (state == 1) {
+            // Indeterminate
+            [s_dockProgressIndicator setHidden:NO];
+            [s_dockProgressIndicator setIndeterminate:YES];
+            [s_dockProgressIndicator startAnimation:nil];
+        } else {
+            // Normal, Error, Paused - all show the bar
+            [s_dockProgressIndicator setHidden:NO];
+            [s_dockProgressIndicator setIndeterminate:NO];
+        }
+
+        [[[NSApplication sharedApplication] dockTile] display];
+        return S_OK;
+    }
+}
+
+HRESULT WindowImpl::SetDockProgressValue(double progress) {
+    START_COM_CALL;
+
+    @autoreleasepool {
+        EnsureDockProgressIndicator();
+
+        [s_dockProgressIndicator setDoubleValue:progress];
+        [[[NSApplication sharedApplication] dockTile] display];
+        return S_OK;
+    }
+}
+
 extern IAvnWindow* CreateAvnWindow(IAvnWindowEvents*events)
 {
     @autoreleasepool

samples/Sandbox/MainWindow.axaml

@@ -1,4 +1,24 @@
 <Window xmlns="https://github.com/avaloniaui"
         xmlns:x='http://schemas.microsoft.com/winfx/2006/xaml'
-        x:Class="Sandbox.MainWindow">
+        x:Class="Sandbox.MainWindow"
+        Title="Taskbar Progress Demo"
+        Width="400" Height="350">
+    <StackPanel Margin="20" Spacing="12">
+        <TextBlock Text="Taskbar Progress Demo" FontSize="20" FontWeight="Bold"/>
+
+        <TextBlock Text="State:" Margin="0,10,0,0"/>
+        <ComboBox x:Name="StateCombo" SelectedIndex="0">
+            <ComboBoxItem Content="None"/>
+            <ComboBoxItem Content="Indeterminate"/>
+            <ComboBoxItem Content="Normal"/>
+            <ComboBoxItem Content="Error"/>
+            <ComboBoxItem Content="Paused"/>
+        </ComboBox>
+
+        <TextBlock x:Name="ValueLabel" Text="Value: 0%" Margin="0,10,0,0"/>
+        <Slider x:Name="ProgressSlider" Minimum="0" Maximum="100" Value="0"/>
+
+        <Button x:Name="AnimateBtn" Content="Animate 0 -> 100%" Margin="0,10,0,0"/>
+        <Button x:Name="ResetBtn" Content="Reset"/>
+    </StackPanel>
 </Window>

samples/Sandbox/MainWindow.axaml.cs

@@ -1,17 +1,71 @@
-using Avalonia;
+using System;
 using Avalonia.Controls;
-using Avalonia.Controls.Presenters;
-using Avalonia.Input.TextInput;
-using Avalonia.Markup.Xaml;
-using Avalonia.Win32.WinRT.Composition;
+using Avalonia.Threading;
 
 namespace Sandbox
 {
     public partial class MainWindow : Window
     {
+        private DispatcherTimer? _timer;
+
         public MainWindow()
         {
             InitializeComponent();
+
+            var stateCombo = this.FindControl<ComboBox>("StateCombo")!;
+            var slider = this.FindControl<Slider>("ProgressSlider")!;
+            var valueLabel = this.FindControl<TextBlock>("ValueLabel")!;
+            var animateBtn = this.FindControl<Button>("AnimateBtn")!;
+            var resetBtn = this.FindControl<Button>("ResetBtn")!;
+
+            stateCombo.SelectionChanged += (_, _) =>
+            {
+                TaskbarProgressState = stateCombo.SelectedIndex switch
+                {
+                    0 => Avalonia.Controls.TaskbarProgressState.None,
+                    1 => Avalonia.Controls.TaskbarProgressState.Indeterminate,
+                    2 => Avalonia.Controls.TaskbarProgressState.Normal,
+                    3 => Avalonia.Controls.TaskbarProgressState.Error,
+                    4 => Avalonia.Controls.TaskbarProgressState.Paused,
+                    _ => Avalonia.Controls.TaskbarProgressState.None,
+                };
+            };
+
+            slider.PropertyChanged += (_, e) =>
+            {
+                if (e.Property == Slider.ValueProperty)
+                {
+                    var pct = slider.Value / 100.0;
+                    TaskbarProgressValue = pct;
+                    valueLabel.Text = $"Value: {slider.Value:F0}%";
+                }
+            };
+
+            animateBtn.Click += (_, _) =>
+            {
+                _timer?.Stop();
+                slider.Value = 0;
+                TaskbarProgressState = Avalonia.Controls.TaskbarProgressState.Normal;
+                stateCombo.SelectedIndex = 2;
+
+                _timer = new DispatcherTimer { Interval = TimeSpan.FromMilliseconds(50) };
+                _timer.Tick += (_, _) =>
+                {
+                    slider.Value += 1;
+                    if (slider.Value >= 100)
+                        _timer.Stop();
+                };
+                _timer.Start();
+            };
+
+            resetBtn.Click += (_, _) =>
+            {
+                _timer?.Stop();
+                slider.Value = 0;
+                stateCombo.SelectedIndex = 0;
+                TaskbarProgressState = Avalonia.Controls.TaskbarProgressState.None;
+                TaskbarProgressValue = 0;
+            };
         }
     }
 }

src/Avalonia.Controls/Platform/IWindowImpl.cs

@@ -59,6 +59,16 @@ public interface IWindowImpl : IWindowBaseImpl
         /// </summary>
         void ShowTaskbarIcon(bool value);
 
+        /// <summary>
+        /// Sets the taskbar progress indicator state for this window.
+        /// </summary>
+        void SetTaskbarProgressState(TaskbarProgressState state);
+
+        /// <summary>
+        /// Sets the taskbar progress indicator value for this window.
+        /// </summary>
+        void SetTaskbarProgressValue(ulong completed, ulong total);
+
         /// <summary>
         /// Enables or disables resizing of the window
         /// </summary>

src/Avalonia.Controls/TaskbarProgressState.cs

@@ -0,0 +1,33 @@
+namespace Avalonia.Controls
+{
+    /// <summary>
+    /// Specifies the state of the progress indicator displayed in the taskbar.
+    /// </summary>
+    public enum TaskbarProgressState
+    {
+        /// <summary>
+        /// No progress is displayed.
+        /// </summary>
+        None = 0,
+
+        /// <summary>
+        /// Pulsing green indicator is displayed.
+        /// </summary>
+        Indeterminate = 1,
+
+        /// <summary>
+        /// Green progress indicator is displayed.
+        /// </summary>
+        Normal = 2,
+
+        /// <summary>
+        /// Red progress indicator is displayed.
+        /// </summary>
+        Error = 4,
+
+        /// <summary>
+        /// Yellow progress indicator is displayed.
+        /// </summary>
+        Paused = 8,
+    }
+}

src/Avalonia.Controls/Window.cs

@@ -151,6 +151,18 @@ public class Window : WindowBase, IFocusScope, ILayoutRoot
         public static readonly StyledProperty<bool> ShowInTaskbarProperty =
             AvaloniaProperty.Register<Window, bool>(nameof(ShowInTaskbar), true);
 
+        /// <summary>
+        /// Defines the <see cref="TaskbarProgressState"/> property.
+        /// </summary>
+        public static readonly StyledProperty<TaskbarProgressState> TaskbarProgressStateProperty =
+            AvaloniaProperty.Register<Window, TaskbarProgressState>(nameof(TaskbarProgressState), TaskbarProgressState.None);
+
+        /// <summary>
+        /// Defines the <see cref="TaskbarProgressValue"/> property.
+        /// </summary>
+        public static readonly StyledProperty<double> TaskbarProgressValueProperty =
+            AvaloniaProperty.Register<Window, double>(nameof(TaskbarProgressValue), 0.0);
+
         /// <summary>
         /// Defines the <see cref="ClosingBehavior"/> property.
         /// </summary>
@@ -254,6 +266,8 @@ public Window(IWindowImpl impl)
             CreatePlatformImplBinding(CanMinimizeProperty, canMinimize => PlatformImpl!.SetCanMinimize(canMinimize));
             CreatePlatformImplBinding(CanMaximizeProperty, canMaximize => PlatformImpl!.SetCanMaximize(canMaximize));
             CreatePlatformImplBinding(ShowInTaskbarProperty, show => PlatformImpl!.ShowTaskbarIcon(show));
+            CreatePlatformImplBinding(TaskbarProgressStateProperty, state => PlatformImpl!.SetTaskbarProgressState(state));
+            CreatePlatformImplBinding(TaskbarProgressValueProperty, value => PlatformImpl!.SetTaskbarProgressValue((ulong)(Math.Clamp(value, 0.0, 1.0) * 1000), 1000));
 
             CreatePlatformImplBinding(WindowStateProperty, state => PlatformImpl!.WindowState = state);
             CreatePlatformImplBinding(ExtendClientAreaToDecorationsHintProperty, hint => PlatformImpl!.SetExtendClientAreaToDecorationsHint(hint));
@@ -389,13 +403,31 @@ public bool ShowActivated
         /// <summary>
         /// Enables or disables the taskbar icon
         /// </summary>
-        /// 
+        ///
         public bool ShowInTaskbar
         {
             get => GetValue(ShowInTaskbarProperty);
             set => SetValue(ShowInTaskbarProperty, value);
         }
 
+        /// <summary>
+        /// Gets or sets the taskbar progress indicator state for this window.
+        /// </summary>
+        public TaskbarProgressState TaskbarProgressState
+        {
+            get => GetValue(TaskbarProgressStateProperty);
+            set => SetValue(TaskbarProgressStateProperty, value);
+        }
+
+        /// <summary>
+        /// Gets or sets the taskbar progress indicator value (0.0 to 1.0) for this window.
+        /// </summary>
+        public double TaskbarProgressValue
+        {
+            get => GetValue(TaskbarProgressValueProperty);
+            set => SetValue(TaskbarProgressValueProperty, value);
+        }
+
         /// <summary>
         /// Gets or sets a value indicating how the <see cref="Closing"/> event behaves in the presence
         /// of child windows.

src/Avalonia.DesignerSupport/Remote/PreviewerWindowImpl.cs

@@ -135,6 +135,14 @@ public void ShowTaskbarIcon(bool value)
         {
         }
 
+        public void SetTaskbarProgressState(TaskbarProgressState state)
+        {
+        }
+
+        public void SetTaskbarProgressValue(ulong completed, ulong total)
+        {
+        }
+
         public void CanResize(bool value)
         {
         }

src/Avalonia.DesignerSupport/Remote/Stubs.cs

@@ -146,6 +146,14 @@ public void ShowTaskbarIcon(bool value)
         {
         }
 
+        public void SetTaskbarProgressState(TaskbarProgressState state)
+        {
+        }
+
+        public void SetTaskbarProgressValue(ulong completed, ulong total)
+        {
+        }
+
         public void CanResize(bool value)
         {
         }

src/Avalonia.FreeDesktop/Avalonia.FreeDesktop.csproj

@@ -43,6 +43,8 @@
 
     <AdditionalFiles Include="DBusXml/org.kde.StatusNotifierWatcher.xml" DBusGeneratorMode="Proxy" />
     <AdditionalFiles Include="DBusXml/org.kde.StatusNotifierItem.xml" DBusGeneratorMode="Handler" />
+
+    <AdditionalFiles Include="DBusXml/com.canonical.Unity.LauncherEntry.xml" DBusGeneratorMode="Handler" />
   </ItemGroup>
 
 </Project>