/*
 * Copyright 2022 Peter Han
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
 * and associated documentation files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or
 * substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

using UnityEngine;

namespace PeterHan.PLib.UI {
	/// <summary>
	/// Delegate types used in the UI event system.
	/// </summary>
	public sealed class PUIDelegates {
		/// <summary>
		/// The delegate type invoked when a dialog is closed.
		/// </summary>
		/// <param name="option">The key of the chosen option, or PDialog.DIALOG_CLOSE_KEY if
		/// the dialog was closed with ESC or the X button.</param>
		public delegate void OnDialogClosed(string option);

		/// <summary>
		/// The delegate type invoked when a button is pressed.
		/// </summary>
		/// <param name="source">The source button.</param>
		public delegate void OnButtonPressed(GameObject source);

		/// <summary>
		/// The delegate type invoked when a checkbox is clicked.
		/// </summary>
		/// <param name="source">The source button.</param>
		/// <param name="state">The checkbox state.</param>
		public delegate void OnChecked(GameObject source, int state);

		/// <summary>
		/// The delegate type invoked when an option is selected from a combo box.
		/// </summary>
		/// <param name="source">The source dropdown.</param>
		/// <param name="choice">The option chosen.</param>
		/// <typeparam name="T">The type of the objects in the drop down.</typeparam>
		public delegate void OnDropdownChanged<T>(GameObject source, T choice) where T :
			class, IListableOption;

		/// <summary>
		/// The delegate type invoked when components are converted into Unity game objects.
		/// </summary>
		/// <param name="realized">The realized object.</param>
		public delegate void OnRealize(GameObject realized);

		/// <summary>
		/// The delegate type invoked once after a slider is changed and released.
		/// </summary>
		/// <param name="source">The source slider.</param>
		/// <param name="newValue">The new slider value.</param>
		public delegate void OnSliderChanged(GameObject source, float newValue);

		/// <summary>
		/// The delegate type invoked while a slider is being changed.
		/// </summary>
		/// <param name="source">The source slider.</param>
		/// <param name="newValue">The new slider value.</param>
		public delegate void OnSliderDrag(GameObject source, float newValue);

		/// <summary>
		/// The delegate type invoked when text in a text field is changed.
		/// </summary>
		/// <param name="source">The source text field.</param>
		/// <param name="text">The new text.</param>
		public delegate void OnTextChanged(GameObject source, string text);

		/// <summary>
		/// The delegate type invoked when a toggle button is swapped between states.
		/// </summary>
		/// <param name="source">The source button.</param>
		/// <param name="on">true if the button is toggled on, or false otherwise.</param>
		public delegate void OnToggleButton(GameObject source, bool on);
	}
}