diff 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 diff
--- a/UIControl/Interfaces/IAddEquipmentUI.cs	Wed Aug 25 19:51:23 2010 +0000
+++ b/UIControl/Interfaces/IAddEquipmentUI.cs	Wed Aug 25 20:04:27 2010 +0000
@@ -58,6 +58,19 @@
 		/// <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();
 	}
 }