/*
 * Util.MenuButton.cs
 * Authors: Adam Nabinger
 * Copyright (c) 2007-2008 Cornell University

 This program is free software; you can redistribute it and/or
 modify it under the terms of the GNU General Public License
 as published by the Free Software Foundation; either version 2
 of the License, or (at your option) any later version.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with this program; if not, write to the Free Software
 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
*/

using Microsoft.Xna.Framework;
using Microsoft.Xna.Framework.Content;
using Microsoft.Xna.Framework.Graphics;

namespace Util
{
	// TODO: Add support for binding keyboard buttons to MenuButtons

	/// <summary>
	/// A piece of code to run when the button is pressed 
	/// </summary>
	/// <param name="game">The current game screen in which the scripted code is run in</param>
	public delegate void Code(GameScreen game);

	/// <summary>
	/// A simple button for use in a menu.
	/// </summary>
	public class MenuButton
	{
		#region Fields

		// The file path name of the texture to load
		protected readonly string mTextureName;

		// The code to execute when the button is pressed
		protected readonly Code mExecute;
		
		// The location and dimensions of the button
		protected readonly Rectangle mLocation;

		// The texture to render the button with
		protected Texture2D mTexture;

		#endregion

		#region Properties

		/// <summary>
		/// Gets the Location for the button.
		/// </summary>
		public Rectangle Location { get { return mLocation; } }

		#endregion

		#region Creation

		/// <summary>
		/// Constructor
		/// </summary>
		/// <param name="textureName">The file path name for the texture to render with</param>
		/// <param name="location">The location of the button and its dimensions</param>
		/// <param name="exe">Code to execute for when the button is pressed</param>
		public MenuButton(string textureName, Rectangle location, Code exe)
		{
			mTextureName = textureName;
			mLocation = location;
			mExecute = exe;
		}

		#endregion

		#region Management

		/// <summary>
		/// Loads in all the necessary information for content dependent objects
		/// </summary>
		/// <param name="content">Reference to the current content manager for loading</param>
		internal virtual void LoadContent(ContentManager content)
		{
			mTexture = content.Load<Texture2D>(mTextureName);
		}
		#endregion

		#region Render

		/// <summary>
		/// Renders the menu button
		/// </summary>
		/// <param name="sb">The current sprite batch object to render with</param>
		internal virtual void Draw(SpriteBatch sb)
		{
			sb.Draw(mTexture, Location, Color.White);
		}

		#endregion

		#region Events

		/// <summary>
		/// Execute this button's action.
		/// </summary>
		/// <param name="game">Reference to the current gamescreen</param>
		public void Execute(GameScreen game)
		{
			mExecute.Invoke(game);
		}

		#endregion
	}
}