mattercontrol/MatterControlLib/SlicerConfiguration/SettingsRow.cs

/*
Copyright (c) 2019, Lars Brubaker, John Lewin
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The views and conclusions contained in the software and documentation are those
of the authors and should not be interpreted as representing official policies,
either expressed or implied, of the FreeBSD Project.
*/

using System;
using System.Linq;
using MatterHackers.Agg;
using MatterHackers.Agg.Image;
using MatterHackers.Agg.UI;
using MatterHackers.Localizations;
using MatterHackers.MatterControl.PartPreviewWindow;
using MatterHackers.VectorMath;

namespace MatterHackers.MatterControl.CustomWidgets
{
	public class SettingsRow : FlowLayoutWidget
	{
		protected GuiWidget overrideIndicator;
		protected const bool debugLayout = false;
		protected ThemeConfig theme;

		protected bool mouseInBounds = false;
		private Color hoverColor;
		private bool fullRowSelect;
		private GuiWidget settingsLabel;

		private Popover popoverBubble = null;
		private static Popover activePopover = null;
		private SystemWindow systemWindow = null;

		protected ImageWidget imageWidget;

		public GuiWidget ActionWidget { get; set; }

		public SettingsRow(string title, string helpText, ThemeConfig theme, ImageBuffer icon = null, bool enforceGutter = false, bool fullRowSelect = false)
		{
			using (this.LayoutLock())
			{
				this.HelpText = helpText ?? "";
				this.theme = theme;
				this.fullRowSelect = fullRowSelect;

				this.HAnchor = HAnchor.Stretch;
				this.VAnchor = VAnchor.Fit;
				this.MinimumSize = new Vector2(0, theme.ButtonHeight);
				this.Border = new BorderDouble(bottom: 1);
				this.BorderColor = theme.RowBorder;

				hoverColor = theme.MinimalShade;

				if (icon != null)
				{
					this.AddChild(
						imageWidget = new ImageWidget(icon)
						{
							Margin = new BorderDouble(right: 6, left: 6),
							VAnchor = VAnchor.Center
						});
				}
				else if (enforceGutter)
				{
					// Add an icon placeholder to get consistent label indenting on items lacking icons
					this.AddChild(new GuiWidget()
					{
						Width = 24 + 12,
						Height = 24,
						Margin = new BorderDouble(0)
					});
				}
				else
				{
					this.AddChild(overrideIndicator = new GuiWidget()
					{
						VAnchor = VAnchor.Stretch,
						HAnchor = HAnchor.Absolute,
						Width = 3,
						Margin = new BorderDouble(right: 6)
					});
				}

				this.AddChild(settingsLabel = SettingsRow.CreateSettingsLabel(title, helpText, theme.TextColor));

				this.AddChild(new HorizontalSpacer());
			}

			this.PerformLayout();

			if (fullRowSelect)
			{
				this.Cursor = Cursors.Hand;
			}
		}

		public static GuiWidget CreateSettingsLabel(string label, string helpText, Color textColor)
		{
			return new TextWidget(label, textColor: textColor, pointSize: 10)
			{
				AutoExpandBoundsToText = true,
				VAnchor = VAnchor.Center,
			};
		}

		public string HelpText { get; protected set; }

		public ArrowDirection ArrowDirection { get; set; } = ArrowDirection.Right;

		public override void AddChild(GuiWidget childToAdd, int indexInChildrenList = -1)
		{
			if (fullRowSelect)
			{
				childToAdd.Selectable = false;
			}

			base.AddChild(childToAdd, indexInChildrenList);
		}

		public override Color BackgroundColor
		{
			get => (mouseInBounds) ? hoverColor : base.BackgroundColor;
			set => base.BackgroundColor = value;
		}

		public override void OnLoad(EventArgs args)
		{
			// The top level SystemWindow - due to single window implementation details, multiple SystemWindow parents may exist - proceed to the topmost one
			systemWindow = this.Parents<SystemWindow>().LastOrDefault();
			base.OnLoad(args);
		}

		public override void OnMouseEnterBounds(MouseEventArgs mouseEvent)
		{
			mouseInBounds = true;
			this.Invalidate();

			this.ShowPopover(this);

			base.OnMouseEnterBounds(mouseEvent);
		}

		public override void OnMouseLeaveBounds(MouseEventArgs mouseEvent)
		{
			mouseInBounds = false;

			this.Invalidate();

			if (popoverBubble != null)
			{
				// Allow a moment to elapse to determine if the mouse is within the bubble or has returned to this control, close otherwise
				UiThread.RunOnIdle(() =>
				{
					// Skip close if we are FirstWidgetUnderMouse
					if (this.FirstWidgetUnderMouse)
					{
						// Often we get OnMouseLeaveBounds when the mouse is still within bounds (as child mouse events are processed)
						// If the mouse is in bounds of this widget, abort the popover close below
						return;
					}

					// Close the popover as long as it doesn't contain the mouse
					if (!popoverBubble.ContainsFirstUnderMouseRecursive())
					{
						// Close any active popover bubble
						popoverBubble?.Close();
					}
				}, 1);
			}

			base.OnMouseLeaveBounds(mouseEvent);
		}

		protected virtual void ExtendPopover(SliceSettingsPopover popover)
		{
		}

		protected void ShowPopover(SettingsRow settingsRow)
		{
			// Only display popovers when we're the active widget, exit if we're not first under mouse
			if (systemWindow == null
				|| !this.ContainsFirstUnderMouseRecursive()
				|| string.IsNullOrEmpty(settingsRow.HelpText))
			{
				return;
			}

			int arrowOffset = (int)(settingsRow.Height / 2);

			var popover = new SliceSettingsPopover(this.ArrowDirection, new BorderDouble(15, 10), 7, arrowOffset)
			{
				HAnchor = HAnchor.Fit,
				VAnchor = VAnchor.Fit,
				TagColor = theme.ResolveColor(AppContext.Theme.BackgroundColor, AppContext.Theme.AccentMimimalOverlay.WithAlpha(50)),
			};

			popover.AddChild(new WrappedTextWidget(settingsRow.HelpText, pointSize: theme.DefaultFontSize - 1, textColor: AppContext.Theme.TextColor)
			{
				Width = 400 * GuiWidget.DeviceScale,
				HAnchor = HAnchor.Fit,
			});

			bool alignLeft = (this.ArrowDirection == ArrowDirection.Right);

			// after a certain amount of time make the popover close (just like a tool tip)
			double closeSeconds = Math.Max(1, (settingsRow.HelpText.Length / 50.0)) * 5;

			this.ExtendPopover(popover);

			activePopover?.Close();

			activePopover = popover;

			systemWindow.ShowPopover(
				new MatePoint(settingsRow)
				{
					Mate = new MateOptions(alignLeft ? MateEdge.Left : MateEdge.Right, MateEdge.Top),
					AltMate = new MateOptions(alignLeft ? MateEdge.Right : MateEdge.Left, MateEdge.Bottom),
					Offset = new RectangleDouble(12, 0, 12, 0)
				},
				new MatePoint(popover)
				{
					Mate = new MateOptions(alignLeft ? MateEdge.Right : MateEdge.Left, MateEdge.Top),
					AltMate = new MateOptions(alignLeft ? MateEdge.Left : MateEdge.Right, MateEdge.Bottom),
					// Offset = new RectangleDouble(12, 0, 12, 0)
				},
				secondsToClose: closeSeconds);

			popoverBubble = popover;
		}
	}
}