/*
 * Greenshot - a free and open source screenshot tool
 * Copyright (C) 2007-2021 Thomas Braun, Jens Klingen, Robin Krom
 *
 * For more information see: http://getgreenshot.org/
 * The Greenshot project is hosted on GitHub https://github.com/greenshot/greenshot
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 1 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

using System;
using System.Collections.Generic;
using GreenshotPlugin.Interfaces.Ocr;

namespace GreenshotPlugin.Interfaces {
    /// <summary>
	/// Details for the capture, like the window title and date/time etc.
	/// </summary>
	public interface ICaptureDetails {

		/// <summary>
		/// If the capture comes from a file, this contains the filename
		/// </summary>
		string Filename {
			get;
			set;
		}

		/// <summary>
		/// The title of the capture
		/// </summary>
		string Title {
			get;
			set;
		}

		/// <summary>
		/// When was the capture taken (or loaded)
		/// </summary>
		DateTime DateTime {
			get;
			set;
		}

		/// <summary>
		/// Destinations to where this capture goes or went
		/// </summary>
		List<IDestination> CaptureDestinations {
			get;
			set;
		}

		/// <summary>
		/// The meta data of the capture
		/// </summary>
		Dictionary<string, string> MetaData {
			get;
		}

		/// <summary>
		/// Helper method to prevent complex code which needs to check every key
		/// </summary>
		/// <param name="key">The key for the meta-data</param>
		/// <param name="value">The value for the meta-data</param>
		void AddMetaData(string key, string value);

		void ClearDestinations();
		void RemoveDestination(IDestination captureDestination);
		void AddDestination(IDestination captureDestination);
		bool HasDestination(string designation);

		CaptureMode CaptureMode {
			get;
			set;
		}

		float DpiX {
			get;
			set;
		}

		float DpiY {
			get;
			set;
		}

        /// <summary>
        /// Store the OCR information for this capture
        /// </summary>
        OcrInformation OcrInformation { get; set; }
    }
}