view UIControl/Interfaces/IAddEquipmentUI.cs @ 56:0c5fbb54bfb0

Re #60: Add UI to add/remove/edit weapons in GTK * Refactor enabling/disabling of radio buttons * Handle null selections * Move Dispose() to be an interface method and move call out to controller
author IBBoard <dev@ibboard.co.uk>
date Wed, 25 Aug 2010 20:04:27 +0000
parents f9f6e9db5350
children 293d204e40db
line wrap: on
line source

//  This file (IAddEquipmentUI.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;
using IBBoard.WarFoundry.API.Objects;
namespace IBBoard.WarFoundry.GUI.GTK.UIControl.Interfaces
{
	/// <summary>
	/// The interface that UI components should implement to represent "Add Equipment" dialogs or system equivalents (e.g. console areas or HTML fragments)
	/// </summary>
	public interface IAddEquipmentUI
	{
		/// <summary>
		/// Should be fired when unit equipment item choice changes.
		/// </summary>
		event SingleArgMethodInvoker<UnitEquipmentItem> UnitEquipmentItemChoiceChanged;
		
		/// <summary>
		/// Sets the equipment items that should be displayed on the form
		/// </summary>
		/// <param name='items'>
		/// The equipment items that should be displayed on the form
		/// </param>
		void SetUnitEquipmentItems(UnitEquipmentItem[] items);
		
		/// <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.
		/// </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>
		/// Releases all resource used by the <see cref="IBBoard.WarFoundry.GUI.GTK.UIControl.Interfaces.IAddEquipmentUI"/> object.
		/// </summary>
		/// <remarks>
		/// Call <see cref="Dispose"/> when you are finished using the
		/// <see cref="IBBoard.WarFoundry.GUI.GTK.UIControl.Interfaces.IAddEquipmentUI"/>. The <see cref="Dispose"/> method
		/// leaves the <see cref="IBBoard.WarFoundry.GUI.GTK.UIControl.Interfaces.IAddEquipmentUI"/> in an unusable state.
		/// After calling <see cref="Dispose"/>, you must release all references to the
		/// <see cref="IBBoard.WarFoundry.GUI.GTK.UIControl.Interfaces.IAddEquipmentUI"/> so the garbage collector can reclaim
		/// the memory that the <see cref="IBBoard.WarFoundry.GUI.GTK.UIControl.Interfaces.IAddEquipmentUI"/> was occupying.
		/// </remarks>
		void Dispose();
	}
}