view api/Exporters/IWarFoundryExporter.cs @ 130:e147a1e9399b

Re #68: Add "export army list" function * Add initial interface for exporting * Add stub implementation for exporting HTML (does nothing so far)
author IBBoard <dev@ibboard.co.uk>
date Fri, 28 Aug 2009 19:57:10 +0000
parents
children
line wrap: on
line source

// This file (IWarFoundryExporter.cs) is a part of the IBBoard.WarFoundry.API project and is copyright 2009 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.API.Exporters
{
	/// <summary>
	/// An interface to be implemented by classes that export WarFoundry armies to other formats than "saved armies" (e.g. HTML)
	/// </summary>
	public interface IWarFoundryExporter
	{
		/// <summary>
		/// Exports the army to the specified path
		/// </summary>
		/// <param name="army">
		/// The <see cref="Army"/> to export
		/// </param>
		/// <param name="path">
		/// The file path to export to
		/// </param>
		void ExportArmy(Army army, string path);
	}
}