refactor: (base/FontIcon) actual glyph & font-family management

Author: NotYoojun

samples/WpfApp1/MainWindow.xaml

@@ -26,6 +26,11 @@
                     </Grid>
                 </Expander.Content>
             </Expander>
+            <ui:IconAndText x:Name="s1" Icon="{x:Static ui:SegoeFluentIcons.Home}" Content="Home" />
+            <ui:FontIcon x:Name="s2" Icon="{x:Static ui:SegoeFluentIcons.Home}"/>
+            <Button Click="Button_Click">
+                Update Icon
+            </Button>
         </ikw:SimpleStackPanel>
     </Canvas>
 </Window>

samples/WpfApp1/MainWindow.xaml.cs

@@ -148,5 +148,12 @@ private void SettingsCard_Click(object sender, RoutedEventArgs e)
         {
             MessageBox.Show("clicked");
         }
+
+        private void Button_Click(object sender, RoutedEventArgs e)
+        {
+            s1.Icon = s1.Icon.Value.Glyph == SegoeFluentIcons.Home.Glyph
+                   ? SegoeFluentIcons.Delete : SegoeFluentIcons.Home;
+            s2.Icon = s1.Icon;
+        }
     }
 }

source/iNKORE.UI.WPF.Modern/Common/FontIconSource.cs

@@ -4,6 +4,7 @@
 using iNKORE.UI.WPF.Modern.Common.IconKeys;
 using iNKORE.UI.WPF.Modern.Controls;
 using System;
+using System.Diagnostics;
 using System.Windows;
 using System.Windows.Markup;
 using System.Windows.Media;
@@ -30,25 +31,17 @@ public FontIconSource()
                 nameof(FontFamily),
                 typeof(FontFamily),
                 typeof(FontIconSource),
-                new PropertyMetadata(new FontFamily(FontIcon.SegoeIconsFontFamilyName), FontFamilyProperty_ValueChanged));
-
-        private static void FontFamilyProperty_ValueChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
-        {
-            if (d is IFontIconClass cls)
-            {
-                UpdateIconData(cls, false);
-            }
-        }
+                new PropertyMetadata(null));
 
         /// <summary>
         /// Gets or sets the font used to display the icon glyph.
         /// </summary>
         /// <returns>
         /// The font used to display the icon glyph.
         /// </returns>
-        public FontFamily FontFamily
+        public FontFamily? FontFamily
         {
-            get => (FontFamily)GetValue(FontFamilyProperty);
+            get => (FontFamily?)GetValue(FontFamilyProperty);
             set => SetValue(FontFamilyProperty, value);
         }
 
@@ -128,25 +121,17 @@ public FontWeight FontWeight
                 nameof(Glyph),
                 typeof(string),
                 typeof(FontIconSource),
-                new PropertyMetadata(string.Empty, GlyphProperty_ValueChanged));
-
-        private static void GlyphProperty_ValueChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
-        {
-            if(d is IFontIconClass cls)
-            {
-                UpdateIconData(cls, false);
-            }
-        }
+                new PropertyMetadata(null));
 
         /// <summary>
         /// Gets or sets the character code that identifies the icon glyph.
         /// </summary>
         /// <returns>
         /// The hexadecimal character code for the icon glyph.
         /// </returns>
-        public string Glyph
+        public string? Glyph
         {
-            get => (string)GetValue(GlyphProperty);
+            get => (string?)GetValue(GlyphProperty);
             set => SetValue(GlyphProperty, value);
         }
 
@@ -158,7 +143,7 @@ public string Glyph
                 nameof(Icon),
                 typeof(FontIconData?),
                 typeof(FontIconSource),
-                new PropertyMetadata(null, (d, e) => UpdateIconData(d as IFontIconClass, true)));
+                new PropertyMetadata(null));
 
         /// <summary>
         /// Gets or sets the wrapped icon, which includes <see cref="Glyph"/> and <see cref="FontFamily"/>. You can get these instances from <see cref="iNKORE.UI.WPF.Modern.Common.IconKeys"/> namespace.
@@ -171,44 +156,6 @@ public FontIconData? Icon
         }
 
 
-        public static bool UpdateIconData(IFontIconClass instance, bool preserveData)
-        {
-            bool isChanged = false;
-
-            if (instance.Icon.HasValue)
-            {
-                var icon = instance.Icon.Value;
-
-                if (instance.Glyph != icon.Glyph)
-                {
-                    if (preserveData)
-                        instance.Glyph = icon.Glyph;
-                    else
-                    {
-                        instance.Icon = null;
-                        return true;
-                    }
-                    isChanged = true;
-                }
-                if (icon.FontFamily != null && icon.FontFamily != instance.FontFamily)
-                {
-                    if (preserveData)
-                        instance.FontFamily = icon.FontFamily;
-                    else
-                    {
-                        instance.Icon = null;
-                        return true;
-                    }
-
-                    isChanged = true;
-                }
-            }
-
-            return isChanged;
-        }
-
-
-
         /// <inheritdoc/>
         protected override IconElement CreateIconElementCore()
         {

source/iNKORE.UI.WPF.Modern/Controls/FontIcon.cs

@@ -1,8 +1,11 @@
 using iNKORE.UI.WPF.Modern.Common;
 using iNKORE.UI.WPF.Modern.Common.IconKeys;
+using System;
 using System.ComponentModel;
+using System.Diagnostics;
 using System.Windows;
 using System.Windows.Controls;
+using System.Windows.Data;
 using System.Windows.Media;
 
 namespace iNKORE.UI.WPF.Modern.Controls
@@ -46,7 +49,7 @@ public FontIcon(string glyph, FontFamily fontFamily) : this()
                 typeof(FontFamily),
                 typeof(FontIcon),
                 new FrameworkPropertyMetadata(
-                    new FontFamily(SegoeIconsFontFamilyName),
+                    null,
                     OnFontFamilyChanged));
 
         /// <summary>
@@ -55,21 +58,31 @@ public FontIcon(string glyph, FontFamily fontFamily) : this()
         /// <returns>The font used to display the icon glyph.</returns>
         [Bindable(true), Category("Appearance")]
         [Localizability(LocalizationCategory.Font)]
-        public FontFamily FontFamily
+        public FontFamily? FontFamily
         {
-            get { return (FontFamily)GetValue(FontFamilyProperty); }
+            get { return (FontFamily?)GetValue(FontFamilyProperty); }
             set { SetValue(FontFamilyProperty, value); }
         }
 
-        private static void OnFontFamilyChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
+        protected static readonly DependencyPropertyKey ActualFontFamilyPropertyKey =
+            DependencyProperty.RegisterReadOnly(
+                nameof(ActualFontFamily),
+                typeof(FontFamily),
+                typeof(FontIcon),
+                new FrameworkPropertyMetadata(new FontFamily(SegoeIconsFontFamilyName)));
+
+        public static readonly DependencyProperty ActualFontFamilyProperty = ActualFontFamilyPropertyKey.DependencyProperty;
+
+        public FontFamily ActualFontFamily
         {
-            var fontIcon = (FontIcon)d;
-            if (fontIcon._textBlock != null)
-            {
-                fontIcon._textBlock.FontFamily = (FontFamily)e.NewValue;
-            }
+            get { return (FontFamily)GetValue(ActualFontFamilyProperty); }
+            private set { SetValue(ActualFontFamilyPropertyKey, value); }
+        }
 
-            FontIconSource.UpdateIconData(fontIcon, false);
+
+        private static void OnFontFamilyChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
+        {
+            (d as FontIcon)?.UpdateIconData();
         }
 
         /// <summary>
@@ -177,18 +190,33 @@ private static void OnFontWeightChanged(DependencyObject d, DependencyPropertyCh
                 nameof(Glyph),
                 typeof(string),
                 typeof(FontIcon),
-                new FrameworkPropertyMetadata(string.Empty, OnGlyphChanged));
+                new FrameworkPropertyMetadata(null, OnGlyphChanged));
 
         /// <summary>
         /// Gets or sets the character code that identifies the icon glyph.
         /// </summary>
         /// <returns>The hexadecimal character code for the icon glyph.</returns>
-        public string Glyph
+        public string? Glyph
         {
-            get => (string)GetValue(GlyphProperty);
+            get => (string?)GetValue(GlyphProperty);
             set => SetValue(GlyphProperty, value);
         }
 
+        protected static readonly DependencyPropertyKey ActualGlyphPropertyKey =
+            DependencyProperty.RegisterReadOnly(
+                nameof(ActualGlyph),
+                typeof(string),
+                typeof(FontIcon),
+                new FrameworkPropertyMetadata(string.Empty));
+
+        public static readonly DependencyProperty ActualGlyphProperty = ActualGlyphPropertyKey.DependencyProperty;
+
+        public string ActualGlyph
+        {
+            get => (string)GetValue(ActualGlyphProperty);
+            private set => SetValue(ActualGlyphPropertyKey, value);
+        }
+
         /// <summary>
         /// Identifies the <see cref="Icon"/> dependency property.
         /// </summary>
@@ -197,7 +225,7 @@ public string Glyph
                 nameof(Icon),
                 typeof(FontIconData?),
                 typeof(FontIcon),
-                new PropertyMetadata(null, (d, e) => FontIconSource.UpdateIconData(d as IFontIconClass, true)));
+                new FrameworkPropertyMetadata(null, FrameworkPropertyMetadataOptions.AffectsRender | FrameworkPropertyMetadataOptions.AffectsMeasure, OnIconChanged));
 
         /// <summary>
         /// Gets or sets the wrapped icon, which includes <see cref="Glyph"/> and <see cref="FontFamily"/>. You can get these instances from <see cref="iNKORE.UI.WPF.Modern.Common.IconKeys"/> namespace.
@@ -218,9 +246,21 @@ private static void OnGlyphChanged(DependencyObject d, DependencyPropertyChanged
                 fontIcon._textBlock.Text = (string)e.NewValue;
             }
 
-            FontIconSource.UpdateIconData(fontIcon, false);
+            (d as FontIcon)?.UpdateIconData();
+        }
+
+        private static void OnIconChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
+        {
+            (d as FontIcon)?.UpdateIconData();
+        }
+
+        private void UpdateIconData()
+        {
+            this.ActualGlyph = this.Glyph ?? this.Icon?.Glyph ?? null;
+            this.ActualFontFamily = this.FontFamily ?? this.Icon?.FontFamily ?? new FontFamily(SegoeIconsFontFamilyName);
         }
 
+
         private protected override void InitializeChildren()
         {
             _textBlock = new TextBlock
@@ -229,13 +269,15 @@ private protected override void InitializeChildren()
                 HorizontalAlignment = HorizontalAlignment.Stretch,
                 VerticalAlignment = VerticalAlignment.Center,
                 TextAlignment = TextAlignment.Center,
-                FontFamily = FontFamily,
-                FontSize = FontSize,
-                FontStyle = FontStyle,
-                FontWeight = FontWeight,
-                Text = Glyph
             };
 
+            // Setup bindings
+            _textBlock.SetBinding(TextBlock.FontFamilyProperty, new Binding { Path = new PropertyPath(nameof(ActualFontFamily)), Source = this });
+            _textBlock.SetBinding(TextBlock.FontSizeProperty, new Binding { Path = new PropertyPath(nameof(FontSize)), Source = this });
+            _textBlock.SetBinding(TextBlock.FontStyleProperty, new Binding { Path = new PropertyPath(nameof(FontStyle)), Source = this });
+            _textBlock.SetBinding(TextBlock.FontWeightProperty, new Binding { Path = new PropertyPath(nameof(FontWeight)), Source = this });
+            _textBlock.SetBinding(TextBlock.TextProperty, new Binding { Path = new PropertyPath(nameof(ActualGlyph)), Source = this });
+
             if (ShouldInheritForegroundFromVisualParent)
             {
                 _textBlock.Foreground = VisualParentForeground;
@@ -287,12 +329,12 @@ protected override IconSource CreateIconSourceCore()
                 FontFamily = new FontFamily(SegoeIconsFontFamilyName);
             }
             iconSource.FontFamily = FontFamily;
+            iconSource.Icon = Icon;
 
             iconSource.FontWeight = FontWeight;
             iconSource.FontStyle = FontStyle;
 
             return iconSource;
-
         }
     }
 }