CodeMirror/SystemTrayMenu
1
0
Fork 0
mirror of https://github.com/Hofknecht/SystemTrayMenu.git synced 2024-06-02 18:44:56 +12:00
Code Issues Projects Releases Wiki Activity

Fix issue of some icons not being loaded properly

Browse source 
Make sure native Icon calls are running within STA threads (resolves loading issues).
Make sure bitmaps are created on UI thread to ensure ownership (resolves display/update issues).
Remove obsolete helper routines (GetParentWindow and IconToImageSourceConverter).
This commit is contained in:
Peter Kirmeier 2023-08-13 02:13:18 +02:00
parent 8202a6c3cf
commit da4ec8bec4
3 changed files with 31 additions and 89 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

59
Utilities/File/IconReader.cs
View file

@ -9,11 +9,11 @@ namespace SystemTrayMenu.Utilities
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Drawing;
using System.Globalization;
using System.IO;
using System.Runtime.InteropServices;
using System.Threading;
using System.Windows;
using System.Windows.Interop;
using System.Windows.Media.Imaging;
using SystemTrayMenu.DllImports;
using SystemTrayMenu.Helpers;
@ -65,16 +65,18 @@ namespace SystemTrayMenu.Utilities
{
cacheHit = false;
new Thread(UpdateIconInBackground).Start();
void UpdateIconInBackground()
Thread thread = new(UpdateIconInBackgroundSTA);
thread.SetApartmentState(ApartmentState.STA);
thread.Start();
void UpdateIconInBackgroundSTA()
{
BitmapSource icon = DictIconCache(checkPersistentFirst).GetOrAdd(key, FactoryIconFile);
BitmapSource icon = DictIconCache(checkPersistentFirst).GetOrAdd(key, FactoryIconFolderSTA);
onIconLoaded(icon);
}
BitmapSource FactoryIconFile(string keyExtension)
BitmapSource FactoryIconFolderSTA(string keyExtension)
{
return GetIconAsBitmapSource(path, resolvedPath, linkOverlay, false);
return GetIconAsBitmapSourceSTA(path, resolvedPath, linkOverlay, false);
}
}
else
@ -102,22 +104,24 @@ namespace SystemTrayMenu.Utilities
if (IsPreloading)
{
cacheHit = true;
icon = DictIconCache(checkPersistentFirst).GetOrAdd(key, FactoryIconFolder);
icon = DictIconCache(checkPersistentFirst).GetOrAdd(key, FactoryIconFolderSTA);
onIconLoaded(icon);
}
else
{
new Thread(UpdateIconInBackground).Start();
void UpdateIconInBackground()
Thread thread = new (UpdateIconInBackgroundSTA);
thread.SetApartmentState(ApartmentState.STA);
thread.Start();
void UpdateIconInBackgroundSTA()
{
BitmapSource icon = DictIconCache(checkPersistentFirst).GetOrAdd(key, FactoryIconFolder);
BitmapSource icon = DictIconCache(checkPersistentFirst).GetOrAdd(key, FactoryIconFolderSTA);
onIconLoaded(icon);
}
}
BitmapSource FactoryIconFolder(string keyExtension)
BitmapSource FactoryIconFolderSTA(string keyExtension)
{
return GetIconAsBitmapSource(path, path, linkOverlay, true);
return GetIconAsBitmapSourceSTA(path, path, linkOverlay, true);
}
}
else
@ -140,7 +144,17 @@ namespace SystemTrayMenu.Utilities
return GetIcon(path, linkOverlay, shFileInfo, imageList);
}
internal static BitmapSource? TryGetIconAsBitmapSource(string path, string resolvedPath, bool linkOverlay, bool isFolder)
private static BitmapSource CreateBitmapSourceFromIcon(Icon icon) => Application.Current.Dispatcher.Invoke(() =>
{
BitmapSource bitmap = Imaging.CreateBitmapSourceFromHIcon(
icon.Handle,
Int32Rect.Empty,
BitmapSizeOptions.FromEmptyOptions());
bitmap.Freeze();
return bitmap;
});
private static BitmapSource? TryGetIconAsBitmapSourceSTA(string path, string resolvedPath, bool linkOverlay, bool isFolder)
{
BitmapSource? result = null;
Icon? icon;
@ -150,7 +164,6 @@ namespace SystemTrayMenu.Utilities
if (icon != null)
{
result = CreateBitmapSourceFromIcon(icon);
icon.Dispose();
}
}
else if (!isFolder && File.Exists(resolvedPath) &&
@ -160,8 +173,6 @@ namespace SystemTrayMenu.Utilities
if (icon != null)
{
result = CreateBitmapSourceFromIcon(icon);
icon.Dispose();
if (linkOverlay && OverlayImage != null)
{
result = ImagingHelper.CreateIconWithOverlay(result, OverlayImage);
@ -170,6 +181,7 @@ namespace SystemTrayMenu.Utilities
}
else
{
// This code block must run in an STA thread otherwise the results may be incorrectly loaded icons!
NativeMethods.SHFILEINFO shFileInfo = default;
bool largeIcon = // Note: large returns another folder icon than windows explorer
Scaling.Factor >= 1.25f ||
@ -182,16 +194,16 @@ namespace SystemTrayMenu.Utilities
if (icon != null)
{
result = CreateBitmapSourceFromIcon(icon);
icon.Dispose();
}
}
icon?.Dispose();
return result;
}
private static BitmapSource GetIconAsBitmapSource(string path, string resolvedPath, bool linkOverlay, bool isFolder)
private static BitmapSource GetIconAsBitmapSourceSTA(string path, string resolvedPath, bool linkOverlay, bool isFolder)
{
BitmapSource? bitmapSource = TryGetIconAsBitmapSource(path, resolvedPath, linkOverlay, isFolder);
BitmapSource? bitmapSource = TryGetIconAsBitmapSourceSTA(path, resolvedPath, linkOverlay, isFolder);
bitmapSource ??= (BitmapSource)Application.Current.Resources["NotFoundIconImage"];
bitmapSource.Freeze(); // Make it accessible for any thread
return bitmapSource;
@ -273,14 +285,5 @@ namespace SystemTrayMenu.Utilities
return icon;
}
private static BitmapSource CreateBitmapSourceFromIcon(Icon icon)
{
return (BitmapSource)new IconToImageSourceConverter().Convert(
icon,
typeof(BitmapSource),
null!,
CultureInfo.InvariantCulture);
}
}
}

48
Utilities/IconToImageSourceConverter.cs
View file

@ -1,48 +0,0 @@
// <copyright file="IconToImageSourceConverter.cs" company="PlaceholderCompany">
// Copyright (c) PlaceholderCompany. All rights reserved.
// </copyright>
//
// Copyright (c) 2022-2023 Peter Kirmeier
namespace SystemTrayMenu.Utilities
{
using System;
using System.Drawing;
using System.Globalization;
using System.Windows;
using System.Windows.Data;
using System.Windows.Interop;
using System.Windows.Markup;
using System.Windows.Media;
using System.Windows.Media.Imaging;
[ValueConversion(typeof(Icon), typeof(ImageSource))]
[ValueConversion(typeof(Icon), typeof(BitmapSource))]
public class IconToImageSourceConverter : MarkupExtension, IValueConverter
{
public object Convert(object value, Type targetType, object parameter, CultureInfo culture)
{
if (value != null)
{
// Invalid Icon happens usually only during design time with dummy default data
Icon icon = value is Icon validIcon ? validIcon : SystemIcons.Error;
return Imaging.CreateBitmapSourceFromHIcon(
icon.Handle,
Int32Rect.Empty,
BitmapSizeOptions.FromEmptyOptions());
}
return null!;
}
public object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)
{
throw new NotImplementedException();
}
public override object ProvideValue(IServiceProvider serviceProvider)
{
return this;
}
}
}

13
Utilities/WPFExtensions.cs
View file

@ -8,7 +8,6 @@ namespace SystemTrayMenu.Utilities
{
using System;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Media;
using System.Windows.Threading;
@ -26,18 +25,6 @@ namespace SystemTrayMenu.Utilities
}
}
internal static Window GetParentWindow(this ListView listView)
{
var parent = VisualTreeHelper.GetParent(listView);
while (parent is not Window)
{
parent = VisualTreeHelper.GetParent(parent);
}
return (Window)parent;
}
internal static T? FindVisualChildOfType<T>(this DependencyObject depObj, int index = 0)
where T : DependencyObject
{