diff UIControl/Interfaces/IAddEquipmentUI.cs @ 51:dafbd432ca23

Re #60: Add UI to add/remove/edit weapons in GTK * Start to implement Add functionality using a new abstraction concept that keeps the UI dumb and keeps the logic in a cross-toolkit controller
author IBBoard <dev@ibboard.co.uk>
date Sat, 21 Aug 2010 20:00:03 +0000
parents
children f9f6e9db5350
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/UIControl/Interfaces/IAddEquipmentUI.cs	Sat Aug 21 20:00:03 2010 +0000
@@ -0,0 +1,62 @@
+//  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>
+		void ShowControl();
+	}
+}
+