OpenRA/OpenRA.Game/Widgets/ScrollPanelWidget.cs

#region Copyright & License Information
/*
 * Copyright 2007-2010 The OpenRA Developers (see AUTHORS)
 * This file is part of OpenRA, which is free software. It is made 
 * available to you under the terms of the GNU General Public License
 * as published by the Free Software Foundation. For more information,
 * see LICENSE.
 */
#endregion

using System.Drawing;
using OpenRA.Graphics;
using System;

namespace OpenRA.Widgets
{
	public class ScrollPanelWidget : Widget
	{
		public readonly string Background = "dialog3";
		public readonly int ScrollbarWidth = 24;
		public readonly float ScrollVelocity = 4f;		
		public readonly int ItemSpacing = 2;
		
		public int ContentHeight = 0;
		float ListOffset = 0;
		bool UpPressed = false;
		bool DownPressed = false;
		bool ThumbPressed = false;
		Rectangle upButtonRect;
		Rectangle downButtonRect;
		Rectangle backgroundRect;
		Rectangle scrollbarRect;
		Rectangle thumbRect;
		
		public ScrollPanelWidget() : base() {}
		protected ScrollPanelWidget(ScrollPanelWidget other)
			: base(other)
		{
			throw new NotImplementedException();
		}
		
		public void ClearChildren()
		{
			Children.Clear();
			ContentHeight = 0;
		}
		
		public override void AddChild(Widget child)
		{
			// Initial setup of margins/height
			if (Children.Count == 0)
				ContentHeight = ItemSpacing;
			
			child.Bounds.Y += ContentHeight;
			ContentHeight += child.Bounds.Height + ItemSpacing;
			base.AddChild(child);
		}
		
		public override void DrawInner( WorldRenderer wr ) {}
		public override void Draw( WorldRenderer wr )
		{
			if (!IsVisible())
				return;
			
			var ScrollbarHeight = RenderBounds.Height - 2 * ScrollbarWidth;
			
			var thumbHeight = ContentHeight == 0 ? 0 : (int)(ScrollbarHeight*Math.Min(RenderBounds.Height*1f/ContentHeight, 1f));
			var thumbOrigin = RenderBounds.Y + ScrollbarWidth + (int)((ScrollbarHeight - thumbHeight)*(-1f*ListOffset/(ContentHeight - RenderBounds.Height)));
			
			backgroundRect = new Rectangle(RenderBounds.X, RenderBounds.Y, RenderBounds.Width - ScrollbarWidth, RenderBounds.Height);
			upButtonRect = new Rectangle(RenderBounds.Right - ScrollbarWidth, RenderBounds.Y, ScrollbarWidth, ScrollbarWidth);
			downButtonRect = new Rectangle(RenderBounds.Right - ScrollbarWidth, RenderBounds.Bottom - ScrollbarWidth, ScrollbarWidth, ScrollbarWidth);
			scrollbarRect = new Rectangle(RenderBounds.Right - ScrollbarWidth, RenderBounds.Y + ScrollbarWidth, ScrollbarWidth, ScrollbarHeight);
			thumbRect = new Rectangle(RenderBounds.Right - ScrollbarWidth, thumbOrigin, ScrollbarWidth, thumbHeight);
			
			string upButtonBg = UpPressed ? "dialog3" : "dialog2";
			string downButtonBg = DownPressed ? "dialog3" : "dialog2";
			string scrollbarBg = "dialog3";
			string thumbBg = "dialog2";

			WidgetUtils.DrawPanel(Background, backgroundRect);
			WidgetUtils.DrawPanel(upButtonBg, upButtonRect);
			WidgetUtils.DrawPanel(downButtonBg, downButtonRect);
			WidgetUtils.DrawPanel(scrollbarBg, scrollbarRect);
			
			if (thumbHeight > 0)
				WidgetUtils.DrawPanel(thumbBg, thumbRect);

			var upOffset = UpPressed ? 4 : 3;
			var downOffset = DownPressed ? 4 : 3;
			WidgetUtils.DrawRGBA(ChromeProvider.GetImage("scrollbar", "up_arrow"),
				new float2(upButtonRect.Left + upOffset, upButtonRect.Top + upOffset));
			WidgetUtils.DrawRGBA(ChromeProvider.GetImage("scrollbar", "down_arrow"),
				new float2(downButtonRect.Left + downOffset, downButtonRect.Top + downOffset));

			Game.Renderer.EnableScissor(backgroundRect.X + 1, backgroundRect.Y + 1, backgroundRect.Width - 2, backgroundRect.Height - 2);

			foreach (var child in Children)
				child.Draw( wr );

			Game.Renderer.DisableScissor();
		}

		public override int2 ChildOrigin { get { return RenderOrigin + new int2(0, (int)ListOffset); } }

		public override Rectangle GetEventBounds()
		{
			return EventBounds;
		}
		
		public override void Tick ()
		{
			if (UpPressed && ListOffset <= 0) ListOffset += ScrollVelocity;
			if (DownPressed) ListOffset -= ScrollVelocity;
						
			ListOffset = Math.Min(0,Math.Max(RenderBounds.Height - ContentHeight, ListOffset));
		}
		
		public override bool LoseFocus (MouseInput mi)
		{
			UpPressed = DownPressed = ThumbPressed = false;
			return base.LoseFocus(mi);
		}
		
		public override bool HandleInputInner(MouseInput mi)
		{						
			if (mi.Event == MouseInputEvent.Down && !TakeFocus(mi))
				return false;
			
			if (!Focused)
				return false;

			UpPressed = upButtonRect.Contains(mi.Location.X, mi.Location.Y);
			DownPressed = downButtonRect.Contains(mi.Location.X, mi.Location.Y);
			ThumbPressed = thumbRect.Contains(mi.Location.X, mi.Location.Y);
			if (Focused && mi.Event == MouseInputEvent.Up)
				LoseFocus(mi);
			
			if (ThumbPressed && mi.Event == MouseInputEvent.Move)
			{
				var ScrollbarHeight = RenderBounds.Height - 2 * ScrollbarWidth;
				var thumbHeight = ContentHeight == 0 ? 0 : (int)(ScrollbarHeight*Math.Min(RenderBounds.Height*1f/ContentHeight, 1f));
			
				ListOffset += (int)((Viewport.LastMousePos.Y - mi.Location.Y)*(ContentHeight - RenderBounds.Height)*1f/(ScrollbarHeight - thumbHeight));
				ListOffset = Math.Min(0,Math.Max(RenderBounds.Height - ContentHeight, ListOffset));
			}
			return (UpPressed || DownPressed || ThumbPressed);
		}

		public override Widget Clone() { return new ScrollPanelWidget(this); }
	}
}