mattercontrol/MatterControlLib/PartPreviewWindow/View3D/PrinterBar/OverflowBar.cs

/*
Copyright (c) 2022, 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.Collections.Generic;
using System.IO;
using System.Linq;
using MatterHackers.Agg;
using MatterHackers.Agg.Image;
using MatterHackers.Agg.Platform;
using MatterHackers.Agg.UI;
using MatterHackers.ImageProcessing;
using MatterHackers.MatterControl.Library.Widgets;

namespace MatterHackers.MatterControl.PartPreviewWindow
{
	public class OverflowBar : Toolbar
	{
		protected static HashSet<Type> ignoredTypes = new HashSet<Type> { typeof(HorizontalLine), typeof(TextEditWithInlineCancel) };
		protected static HashSet<Type> ignoredInMenuTypes = new HashSet<Type> { typeof(VerticalLine), typeof(HorizontalLine), typeof(TextEditWithInlineCancel), typeof(HorizontalSpacer) };

		public OverflowBar(ThemeConfig theme, string text = null)
			: this(null, theme, text)
		{ }

		public OverflowBar(ImageBuffer icon, ThemeConfig theme, string text = null)
			: base(theme.TabbarPadding)
		{
			this.theme = theme;

			if (icon == null)
			{
				if (text != null)
				{
					this.OverflowButton = new PopupMenuButton(text, theme)
					{
						AlignToRightEdge = true,
						DrawArrow = true,
					};
				}
				else
				{
					this.OverflowButton = new OverflowMenuButton(this, theme)
					{
						AlignToRightEdge = true,
					};
				}
			}
			else
			{
				this.OverflowButton = new OverflowMenuButton(this, icon, theme)
				{
					AlignToRightEdge = true,
				};
			}
			AddMenuItemsFunction(OverflowButton);

			// We want to set right margin to overflow button width but width is already scaled - need to inflate value by amount needed to hit width when rescaled in Margin setter
			this.ActionArea.Margin = new BorderDouble(right: Math.Ceiling(this.OverflowButton.Width / GuiWidget.DeviceScale));
			this.SetRightAnchorItem(this.OverflowButton);
		}

		private ThemeConfig theme;

		public PopupMenuButton OverflowButton { get; }

		public Action<PopupMenu> ExtendOverflowMenu { get; set; }

		protected virtual void OnExtendPopupMenu(PopupMenu popupMenu)
		{
			this.ExtendOverflowMenu(popupMenu);
		}

		public override void OnBoundsChanged(EventArgs e)
		{
			base.OnBoundsChanged(e);

			if (this.RightAnchorItem == null)
			{
				return;
			}

			double maxRight = this.Width - RightAnchorItem.Width;
			//double maxRight = this.Width - this.Padding.Width - RightAnchorItem.Width - RightAnchorItem.Margin.Width;

			double accumulatedX = 0;

			bool withinLimits = true;

			foreach (var widget in this.ActionArea.Children.Where(c => !ignoredTypes.Contains(c.GetType())))
			{
				var totalX = widget.Width + widget.DeviceMarginAndBorder.Width;

				withinLimits &= (accumulatedX + totalX / 2) <= maxRight;

				// Widget is visible when no previous sibling has been rejected and its right edge is less than maxRight
				widget.Visible = withinLimits; // widget.Position.X + widget.Width < maxRight;

				// Ignore stretched widgets
				if (widget.HAnchor != HAnchor.Stretch)
				{
					accumulatedX += totalX;
				}
			}
		}

		private void AddMenuItemsFunction(PopupMenuButton menuButton)
		{
			menuButton.DynamicPopupContent = () =>
			{
				var menuTheme = ApplicationController.Instance.MenuTheme;
				var popupMenu = new PopupMenu(menuTheme);

				// Perform overflow
				bool hasOverflowItems = false;
				foreach (var widget in this.ActionArea.Children.Where(c => !c.Visible && !ignoredInMenuTypes.Contains(c.GetType())))
				{
					if (widget is ToolbarSeparator)
					{
						popupMenu.CreateSeparator();
						continue;
					}

					hasOverflowItems = true;

					PopupMenu.MenuItem menuItem;

					var iconButton = widget as ThemedIconButton;

					var iconImage = iconButton?.IconImage;

					menuItem = popupMenu.CreateMenuItem(
						widget.ToolTipText ?? widget.Text,
						iconImage);

					menuItem.Enabled = widget.Enabled;

					menuItem.Click += (s, e) =>
					{
						widget.InvokeClick();
					};
				}

				if (hasOverflowItems)
				{
					popupMenu.CreateSeparator();
				}

				// Extend menu with non-overflow/standard items
				this.OnExtendPopupMenu(popupMenu);

				return popupMenu;
			};
		}

		/// <summary>
		/// A PopupMenuButton with the standard overflow icon
		/// </summary>
		public class OverflowMenuButton : PopupMenuButton
		{
			public OverflowMenuButton(ThemeConfig theme)
				: base(CreateOverflowIcon(theme), theme)
			{
			}

			public OverflowMenuButton(string text, ThemeConfig theme)
				: base(text, CreateOverflowIcon(theme), theme)
			{
			}

			public OverflowMenuButton(OverflowBar overflowBar, ThemeConfig theme)
				: this(overflowBar, CreateOverflowIcon(theme), theme)
			{
			}

			public OverflowMenuButton(OverflowBar overflowBar, ImageBuffer icon, ThemeConfig theme)
				: base(icon, theme)
            {
            }

            private static ImageBuffer CreateOverflowIcon(ThemeConfig theme)
			{
				return StaticData.Instance.LoadIcon(Path.Combine("ViewTransformControls", "overflow.png"), 32, 32).GrayToColor(theme.TextColor);
			}
		}
	}
}