//  This file (IBaseEquipmentUI.cs) is a part of the IBBoard.WarFoundry.GUI.GTK project and is copyright 2010 IBBoard
// 
//  The file and the library/program it is in are licensed and distributed, without warranty, under the GNU Affero GPL license, either version 3 of the License or (at your option) any later version. Please see COPYING for more information and the full license.

using System;

namespace IBBoard.WarFoundry.GUI.GTK.UIControl.Interfaces
{
	/// <summary>
	/// The base interface that all "UI control" controlled interfaces implement. It provides common definitions for all classes
	/// </summary>
	public interface IBaseEquipmentUI : IDisposable
	{
		/// <summary>
		/// Occurs when the unit equipment amount type changes (e.g. percentage to numeric)
		/// </summary>
		event MethodInvoker UnitEquipmentAmountTypeChanged;

		/// <summary>
		/// Occurs when the unit equipment amount changes
		/// </summary>

		event MethodInvoker UnitEquipmentAmountChanged;
		
		/// <summary>
		/// Causes the UI to listen to its widgets and fire events
		/// </summary>

		void ListenToWidgets();
		
		/// <summary>
		/// Causes the UI to ignore the widgets so that changes do not fire events
		/// </summary>

		void IgnoreWidgets();

		/// <summary>
		/// Sets the limits for the currently selected equipment item
		/// </summary>
		/// <param name='isRatioLimit'>
		/// <code>True</code> if the current limit is a ratio limit, else <code>false</code> for absolute limits
		/// </param>
		/// <param name='minPercent'>
		/// The minimum limit as a percentage
		/// </param>
		/// <param name='maxPercent'>
		/// The maximum limit as a percentage
		/// </param>
		/// <param name='minNumber'>
		/// The minimum number as an absolute figure
		/// </param>
		/// <param name='maxNumber'>
		/// The maximum number as an absolute figure
		/// </param>

		void SetUnitEquipmentLimits(bool isRatioLimit, double minPercent, double maxPercent, int minNumber, int maxNumber);

		/// <summary>
		/// Sets whether the unit equipment limit UI components should be enabled and able to accept input. This will 
		/// generally pass the values on to the <see cref="SetNumericAmountEnabledState(bool)"/> and
		/// <see cref="SetPercentageAmountEnabledState(bool)"/> methods and is included for convenience
		/// </summary>
		/// <param name='isEnabled'>
		/// <code>True</code> if the UI components should accept input, else <code>false</code>
		/// </param>

		void SetUnitEquipmentLimitsEnabled(bool isEnabled);

		/// <summary>
		/// Shows the control and awaits a user action (close or okay)
		/// </summary>
		/// <returns>
		/// <code>true</code> if the control was closed with "Okay", else <code>false</code>
		/// </returns>

		bool ShowControl();

		/// <summary>
		/// Gets a value indicating whether the equipment amount is a ratio or an absolute number.
		/// </summary>
		/// <value>
		/// <c>true</c> if the selected amount is a ratio type (percentage or "all"); otherwise, <c>false</c>.
		/// </value>

		bool IsRatioEquipmentAmount
		{
			get;
		}

		/// <summary>
		/// Gets and sets the numeric amount for the current equipment amount. This number is meaningless if <see cref="IsRatioEquipmentAmount"/> is <code>true</code>
		/// </summary>
		/// <value>
		/// The absolue number of items taken.
		/// </value>

		int EquipmentNumericAmount
		{
			get;
			set;
		}

		/// <summary>
		/// Gets and sets the percentage amount for the current equipment amount. This number is meaningless if <see cref="IsRatioEquipmentAmount"/> is <code>false</code>
		/// </summary>
		/// <value>
		/// The number of items taken as a percentage of the unit size.
		/// </value>

		double EquipmentPercentageAmount
		{
			get;
			set;
		}

		/// <summary>
		/// Sets the state of the Okay button.
		/// </summary>
		/// <param name='enabled'>
		/// <code>true</code> to enable the button, else <code>false</code>
		/// </param>

		void SetOkayEnabledState(bool enabled);

		/// <summary>
		/// Sets the state of the numeric equipment amount control.
		/// </summary>
		/// <param name='enabled'>
		/// <code>true</code> to enable the control, else <code>false</code>
		/// </param>

		void SetNumericAmountEnabledState(bool enabled);

		/// <summary>
		/// Sets the state of the percentage equipment amount control.
		/// </summary>
		/// <param name='enabled'>
		/// <code>true</code> to enable the control, else <code>false</code>
		/// </param>

		void SetPercentageAmountEnabledState(bool enabled);
	}
}