Improved ScrollBarEx update 2

wise0704 · wise0704 · commit dc1799b2cb63 · 2015-12-01T23:02:49.000+13:00
Added settings option to change the usage mode of ScrollBarEx (Off, Auto, On). Defaults to Auto.
diff --git a/FlashDevelop/Settings/Accessors.cs b/FlashDevelop/Settings/Accessors.cs
@@ -7,6 +7,7 @@
 using System.Xml.Serialization;
 using Ookii.Dialogs;
 using PluginCore;
+using PluginCore.Controls;
 using PluginCore.Localization;
 using ScintillaNet.Enums;
 
@@ -372,7 +373,7 @@ public HighlightMatchingWordsMode HighlightMatchingWordsMode
         [LocalizedDescription("FlashDevelop.Description.HighlightMatchingWordsDelay")]
         public Int32 HighlightMatchingWordsDelay
         {
-            get 
+            get
             {
                 // Make sure this is not an invalid value
                 if (this.highlightMatchingWordsDelay <= 0) this.highlightMatchingWordsDelay = 1200;
@@ -381,6 +382,23 @@ public Int32 HighlightMatchingWordsDelay
             set { this.highlightMatchingWordsDelay = value; }
         }
 
+        [DefaultValue(ScrollBarMode.Auto)]
+        [DisplayName("Use Custom Scroll Bar")]
+        [LocalizedCategory("FlashDevelop.Category.Editor")]
+        [LocalizedDescription("FlashDevelop.Description.UseCustomScrollBar")]
+        public ScrollBarMode UseCustomScrollBar
+        {
+            get { return this.useCustomScrollBar; }
+            set
+            {
+                if (this.useCustomScrollBar != value)
+                {
+                    this.useCustomScrollBar = value;
+                    ScrollBarEx.NotifySettingsChanged(this.useCustomScrollBar);
+                }
+            }
+        }
+
         #endregion
 
         #region Locale
@@ -445,10 +463,10 @@ public Boolean TabIndents
         [LocalizedDescription("FlashDevelop.Description.IndentView")]
         public IndentView IndentView
         {
-            get 
+            get
             {
                 if ((Int32)this.indentView == 0) this.indentView = IndentView.Real;
-                return this.indentView; 
+                return this.indentView;
             }
             set
             {
diff --git a/FlashDevelop/Settings/Properties.cs b/FlashDevelop/Settings/Properties.cs
@@ -9,6 +9,7 @@
 using System.Windows.Forms;
 using PluginCore.Managers;
 using PluginCore;
+using PluginCore.Controls;
 
 namespace FlashDevelop.Settings
 {
@@ -103,7 +104,7 @@ public partial class SettingObject : ISettings
         private Boolean uiWrapList = false;
         private Boolean uiDisableSmartMatch = false;
         private String uiInsertionTriggers = "";
-
+        private ScrollBarMode useCustomScrollBar = ScrollBarMode.Auto;
     }
 
 }
diff --git a/PluginCore/PluginCore/Controls/ScrollBarEx.cs b/PluginCore/PluginCore/Controls/ScrollBarEx.cs
@@ -18,6 +18,26 @@ namespace PluginCore.Controls
     [DefaultProperty("Value")]
     public class ScrollBarEx : Control
     {
+        #region scroll bar settings
+
+        public delegate void SettingsChangedEventHandler(ScrollBarMode value);
+        public static event SettingsChangedEventHandler SettingsChanged;
+
+        private static ScrollBarMode settingsMode = ScrollBarMode.Auto;
+
+        public static ScrollBarMode SettingsMode
+        {
+            get { return settingsMode; }
+        }
+
+        public static void NotifySettingsChanged(ScrollBarMode value)
+        {
+            settingsMode = value;
+            if (SettingsChanged != null) SettingsChanged.Invoke(settingsMode);
+        }
+
+        #endregion
+
         #region drawing
 
         private Color curPosColor/* = Color.DarkBlue*/;
@@ -2227,6 +2247,27 @@ public enum ScrollBarOrientation
         Vertical
     }
 
+    /// <summary>
+    /// Enum for scrollbar usage settings.
+    /// </summary>
+    public enum ScrollBarMode
+    {
+        /// <summary>
+        /// Turn off the usage of <see cref="ScrollBarEx"/> completely.
+        /// </summary>
+        Off,
+
+        /// <summary>
+        /// Use <see cref="ScrollBarEx"/> only when explicit theme is defined for scroll bars.
+        /// </summary>
+        Auto,
+
+        /// <summary>
+        /// Always use <see cref="ScrollBarEx"/> instead of the system scroll bar.
+        /// </summary>
+        On
+    }
+
     /// <summary>
     /// The scrollbar states.
     /// </summary>
diff --git a/PluginCore/PluginCore/Resources/de_DE.resX b/PluginCore/PluginCore/Resources/de_DE.resX
@@ -5964,4 +5964,8 @@ Eigene Sprachumgebungen müssen eine Erweiterung der Standard-Sprachumgebung sei
     <value>Highlight word:</value>
     <comment>Added after 5.0.2</comment>
   </data>
+  <data name="FlashDevelop.Description.UseCustomScrollBar" xml:space="preserve">
+    <value>Whether to use the custom scroll bar for text editors. Set to 'On' to always enable the custom scroll bar, 'Off' to disable it completely, or 'Auto' to use the custom scroll bar only when the current theme has scroll bar color definitions.</value>
+    <comment>REQUIRES TRANSLATION</comment>
+  </data>
 </root>
diff --git a/PluginCore/PluginCore/Resources/en_US.resX b/PluginCore/PluginCore/Resources/en_US.resX
@@ -5980,4 +5980,7 @@ Custom locales must be an extension of a default locale, e.g. en-US.</value>
     <value>Highlight word:</value>
     <comment>Added after 5.0.2</comment>
   </data>
+  <data name="FlashDevelop.Description.UseCustomScrollBar" xml:space="preserve">
+    <value>Whether to use the custom scroll bar for text editors. Set to 'On' to always enable the custom scroll bar, 'Off' to disable it completely, or 'Auto' to use the custom scroll bar only when the current theme has scroll bar color definitions.</value>
+  </data>
 </root>
diff --git a/PluginCore/PluginCore/Resources/eu_ES.resX b/PluginCore/PluginCore/Resources/eu_ES.resX
@@ -5961,4 +5961,8 @@ Lokalizazio pertsonalizatuek lehenetsiaren luzapen bat izan behar dute, adb. en-
     <value>Highlight word:</value>
     <comment>Added after 5.0.2</comment>
   </data>
+  <data name="FlashDevelop.Description.UseCustomScrollBar" xml:space="preserve">
+    <value>Whether to use the custom scroll bar for text editors. Set to 'On' to always enable the custom scroll bar, 'Off' to disable it completely, or 'Auto' to use the custom scroll bar only when the current theme has scroll bar color definitions.</value>
+    <comment>REQUIRES TRANSLATION</comment>
+  </data>
 </root>
diff --git a/PluginCore/PluginCore/Resources/ja_JP.resX b/PluginCore/PluginCore/Resources/ja_JP.resX
@@ -6022,4 +6022,8 @@ UseData:"</value>
     <value>Highlight word:</value>
     <comment>Added after 5.0.2</comment>
   </data>
+  <data name="FlashDevelop.Description.UseCustomScrollBar" xml:space="preserve">
+    <value>Whether to use the custom scroll bar for text editors. Set to 'On' to always enable the custom scroll bar, 'Off' to disable it completely, or 'Auto' to use the custom scroll bar only when the current theme has scroll bar color definitions.</value>
+    <comment>REQUIRES TRANSLATION</comment>
+  </data>
 </root>
diff --git a/PluginCore/PluginCore/Resources/zh_CN.resx b/PluginCore/PluginCore/Resources/zh_CN.resx
@@ -5974,4 +5974,8 @@
     <value>Highlight word:</value>
     <comment>Added after 5.0.2</comment>
   </data>
+  <data name="FlashDevelop.Description.UseCustomScrollBar" xml:space="preserve">
+    <value>Whether to use the custom scroll bar for text editors. Set to 'On' to always enable the custom scroll bar, 'Off' to disable it completely, or 'Auto' to use the custom scroll bar only when the current theme has scroll bar color definitions.</value>
+    <comment>REQUIRES TRANSLATION</comment>
+  </data>
 </root>
diff --git a/PluginCore/ScintillaNet/ScintillaControl.cs b/PluginCore/ScintillaNet/ScintillaControl.cs
@@ -45,11 +45,17 @@ public class ScintillaControl : Control, IEventHandler
         private ScrollBarEx vScrollBar;
         private ScrollBarEx hScrollBar;
 
+        /// <summary>
+        /// Gets the custom vertical scroll bar.
+        /// </summary>
         public ScrollBarEx VScrollBar
         {
             get { return this.vScrollBar; }
         }
 
+        /// <summary>
+        /// Gets the custom horizontal scroll bar.
+        /// </summary>
         public ScrollBarEx HScrollBar
         {
             get { return this.hScrollBar; }
@@ -96,15 +102,25 @@ public void HandleEvent(Object sender, NotifyEvent e, HandlingPriority priority)
         {
             if (e.Type == EventType.ApplyTheme)
             {
-                vScrollBar.ValidateColors();
-                hScrollBar.ValidateColors();
+                switch (ScrollBarEx.SettingsMode)
+                {
+                    case ScrollBarMode.Auto:
+                        AutoAddRemoveScrollBars(this);
+                        break;
+                    case ScrollBarMode.On:
+                        this.vScrollBar.ValidateColors();
+                        this.hScrollBar.ValidateColors();
+                        break;
+                    case ScrollBarMode.Off:
+                        break;
+                }
             }
         }
 
         /// <summary>
         /// Init the custom scrollbars
         /// </summary>
-        private void InitScrollBars(ScintillaControl sender)
+        private static void InitScrollBars(ScintillaControl sender)
         {
             sender.vScrollBar = new ScrollBarEx();
             sender.vScrollBar.OverScroll = true;
@@ -118,17 +134,35 @@ private void InitScrollBars(ScintillaControl sender)
             sender.hScrollBar.Orientation = ScrollBarOrientation.Horizontal;
             sender.hScrollBar.ContextMenuStrip.Renderer = new DockPanelStripRenderer();
             sender.hScrollBar.Dock = DockStyle.Bottom;
-            //Color foreColor = PluginBase.MainForm.GetThemeColor("ScrollBar.ForeColor");
-            /*if (foreColor != Color.Empty) */sender.AddScrollBars(sender);
-            PluginBase.MainForm.ThemeControls(sender.vScrollBar);
-            PluginBase.MainForm.ThemeControls(sender.hScrollBar);
-            EventManager.AddEventHandler(this, EventType.ApplyTheme);
+            sender.ScrollBarEx_SettingsChanged(ScrollBarEx.SettingsMode);
+            ScrollBarEx.SettingsChanged += sender.ScrollBarEx_SettingsChanged;
+            EventManager.AddEventHandler(sender, EventType.ApplyTheme);
+        }
+
+        /// <summary>
+        /// Turn on/off the scroll bars according to the new settings value.
+        /// </summary>
+        /// <param name="value">A <see cref="ScrollBarMode"/> enum value.</param>
+        private void ScrollBarEx_SettingsChanged(ScrollBarMode value)
+        {
+            switch (value)
+            {
+                case ScrollBarMode.Off:
+                    TurnOffScrollBars(this);
+                    break;
+                case ScrollBarMode.Auto:
+                    AutoAddRemoveScrollBars(this);
+                    break;
+                case ScrollBarMode.On:
+                    TurnOnScrollBars(this);
+                    break;
+            }
         }
 
         /// <summary>
         /// Update the scrollbars on sci control ui update
         /// </summary>
-        private void OnScrollUpdate(ScintillaControl sender)
+        private static void OnScrollUpdate(ScintillaControl sender)
         {
             Int32 vMax = sender.LinesVisible;
             Int32 vPage = sender.LinesOnScreen;
@@ -153,31 +187,73 @@ private void OnScrollUpdate(ScintillaControl sender)
         /// </summary>
         private void OnScrollBarScroll(Object sender, ScrollEventArgs e)
         {
-            this.Painted -= this.OnScrollUpdate;
+            this.Painted -= OnScrollUpdate;
             if (e.ScrollOrientation == ScrollOrientation.VerticalScroll)
             {
                 if (e.OldValue != -1) this.FirstVisibleLine = e.NewValue;
             }
             else this.XOffset = this.hScrollBar.Value;
-            this.Painted += this.OnScrollUpdate;
+            this.Painted += OnScrollUpdate;
+        }
+
+        /// <summary>
+        /// Automatically add or remove scroll bars.
+        /// </summary>
+        /// <param name="sender">The <see cref="ScintillaControl"/> object.</param>
+        private static void AutoAddRemoveScrollBars(ScintillaControl sender)
+        {
+            if (PluginBase.MainForm.GetThemeColor("ScrollBar.ForeColor").IsEmpty)
+            {
+                TurnOffScrollBars(sender);
+            }
+            else
+            {
+                TurnOnScrollBars(sender);
+            }
+        }
+
+        /// <summary>
+        /// Add scroll bars and theme them.
+        /// </summary>
+        /// <param name="sender">The <see cref="ScintillaControl"/> object.</param>
+        private static void TurnOnScrollBars(ScintillaControl sender)
+        {
+            if (!sender.Controls.Contains(sender.vScrollBar))
+                AddScrollBars(sender);
+
+            PluginBase.MainForm.ThemeControls(sender.vScrollBar);
+            PluginBase.MainForm.ThemeControls(sender.hScrollBar);
+            sender.vScrollBar.ValidateColors();
+            sender.hScrollBar.ValidateColors();
+        }
+
+        /// <summary>
+        /// Remove scroll bars from the container.
+        /// </summary>
+        /// <param name="sender">The <see cref="ScintillaControl"/> object.</param>
+        private static void TurnOffScrollBars(ScintillaControl sender)
+        {
+            if (sender.Controls.Contains(sender.vScrollBar))
+                RemoveScrollBars(sender);
         }
 
         /// <summary>
         /// Add controls to container
         /// </summary>
-        private void AddScrollBars(ScintillaControl sender)
+        /// <param name="sender">The <see cref="ScintillaControl"/> object.</param>
+        private static void AddScrollBars(ScintillaControl sender)
         {
-            Boolean vScroll = sender.IsVScrollBar;
-            Boolean hScroll = sender.IsHScrollBar;
+            bool vScroll = sender.IsVScrollBar;
+            bool hScroll = sender.IsHScrollBar;
             sender.IsVScrollBar = false; // Hide builtin
             sender.IsHScrollBar = false; // Hide builtin
-            sender.vScrollBar.VisibleChanged += OnResize;
-            sender.hScrollBar.VisibleChanged += OnResize;
+            sender.vScrollBar.VisibleChanged += sender.OnResize;
+            sender.hScrollBar.VisibleChanged += sender.OnResize;
             sender.vScrollBar.Scroll += sender.OnScrollBarScroll;
             sender.hScrollBar.Scroll += sender.OnScrollBarScroll;
             sender.Controls.Add(sender.hScrollBar);
             sender.Controls.Add(sender.vScrollBar);
-            sender.Painted += sender.OnScrollUpdate;
+            sender.Painted += OnScrollUpdate;
             sender.IsVScrollBar = vScroll;
             sender.IsHScrollBar = hScroll;
             sender.OnResize(null, null);
@@ -186,17 +262,18 @@ private void AddScrollBars(ScintillaControl sender)
         /// <summary>
         /// Remove controls from container
         /// </summary>
-        private void RemoveScrollBars(ScintillaControl sender)
+        /// <param name="sender">The <see cref="ScintillaControl"/> object.</param>
+        private static void RemoveScrollBars(ScintillaControl sender)
         {
-            Boolean vScroll = sender.IsVScrollBar;
-            Boolean hScroll = sender.IsHScrollBar;
-            sender.vScrollBar.VisibleChanged -= OnResize;
-            sender.hScrollBar.VisibleChanged -= OnResize;
+            bool vScroll = sender.IsVScrollBar;
+            bool hScroll = sender.IsHScrollBar;
+            sender.vScrollBar.VisibleChanged -= sender.OnResize;
+            sender.hScrollBar.VisibleChanged -= sender.OnResize;
             sender.vScrollBar.Scroll -= sender.OnScrollBarScroll;
             sender.hScrollBar.Scroll -= sender.OnScrollBarScroll;
             sender.Controls.Remove(sender.hScrollBar);
             sender.Controls.Remove(sender.vScrollBar);
-            sender.Painted -= sender.OnScrollUpdate;
+            sender.Painted -= OnScrollUpdate;
             sender.IsVScrollBar = vScroll;
             sender.IsHScrollBar = hScroll;
             sender.OnResize(null, null);
@@ -228,7 +305,7 @@ public ScintillaControl(string fullpath)
                 DoubleClick += new DoubleClickHandler(OnBlockSelect);
                 CharAdded += new CharAddedHandler(OnSmartIndent);
                 Resize += new EventHandler(OnResize);
-                this.InitScrollBars(this);
+                InitScrollBars(this);
             }
             catch (Exception ex)
             {

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@`
`9`	`9`	`using System.Windows.Forms;`
`10`	`10`	`using PluginCore.Managers;`
`11`	`11`	`using PluginCore;`
	`12`	`+using PluginCore.Controls;`
`12`	`13`
`13`	`14`	`namespace FlashDevelop.Settings`
`14`	`15`	`{`
`@@ -103,7 +104,7 @@ public partial class SettingObject : ISettings`
`103`	`104`	`private Boolean uiWrapList = false;`
`104`	`105`	`private Boolean uiDisableSmartMatch = false;`
`105`	`106`	`private String uiInsertionTriggers = "";`
`106`		`-`
	`107`	`+ private ScrollBarMode useCustomScrollBar = ScrollBarMode.Auto;`
`107`	`108`	`}`
`108`	`109`
`109`	`110`	`}`