using System;
using System.Runtime.InteropServices;
using System.Text;

namespace Vanara.PInvoke
{
	public static partial class Shell32
	{
		/// <summary>A value that controls the behavior of the view when in common dialog mode.</summary>
		[Flags]
		[PInvokeData("Shobjidl.h")]
		public enum CDB2GVF
		{
			/// <summary>All files, including hidden and system files, should be shown. In Windows XP, this is the only recognized flag.</summary>
			CDB2GVF_SHOWALLFILES = 0x00000001,

			/// <summary>This browser is designated to choose a file to save.</summary>
			CDB2GVF_ISFILESAVE = 0x00000002,

			/// <summary>Not used.</summary>
			CDB2GVF_ALLOWPREVIEWPANE = 0x00000004,

			/// <summary>Do not show a "select" verb on an item's context menu.</summary>
			CDB2GVF_NOSELECTVERB = 0x00000008,

			/// <summary>IncludeObject should not be called.</summary>
			CDB2GVF_NOINCLUDEITEM = 0x00000010,

			/// <summary>This browser is designated to pick folders.</summary>
			CDB2GVF_ISFOLDERPICKER = 0x00000020,

			/// <summary>Windows 7 and later. Displays a UAC shield on the selected item when CDB2GVF_NOSELECTVERB is not specified.</summary>
			CDB2GVF_ADDSHIELD = 0x00000040,
		}

		/// <summary>Values for ICommDlgBrowser2::Notify method.</summary>
		[PInvokeData("Shobjidl.h")]
		public enum CDB2N
		{
			/// <summary>Indicates that the shortcut menu is no longer displayed.</summary>
			CDB2N_CONTEXTMENU_DONE = 0x00000001,

			/// <summary>Indicates that the shortcut menu is about to be displayed.</summary>
			CDB2N_CONTEXTMENU_START = 0x00000002
		}

		/// <summary>Indicates a change in the selection state in ICommDlgBrowser::OnStateChange.</summary>
		[PInvokeData("Shobjidl.h")]
		public enum CDBOSC
		{
			/// <summary>The focus has been set to the view.</summary>
			CDBOSC_SETFOCUS = 0x00000000,

			/// <summary>The view has lost the focus.</summary>
			CDBOSC_KILLFOCUS = 0x00000001,

			/// <summary>The selection has changed.</summary>
			CDBOSC_SELCHANGE = 0x00000002,

			/// <summary>An item has been renamed.</summary>
			CDBOSC_RENAME = 0x00000003,

			/// <summary>An item has been checked or unchecked.</summary>
			CDBOSC_STATECHANGE = 0x00000004,
		}

		/// <summary>
		/// Exposed by the common file dialog boxes to be used when they host a Shell browser. If supported, ICommDlgBrowser exposes methods
		/// that allow a Shell view to handle several cases that require different behavior in a dialog box than in a normal Shell view. You
		/// obtain an ICommDlgBrowser interface pointer by calling QueryInterface on the IShellBrowser object.
		/// </summary>
		[ComImport, InterfaceType(ComInterfaceType.InterfaceIsIUnknown), Guid("000214F1-0000-0000-C000-000000000046")]
		[PInvokeData("Shobjidl.h", MSDNShortId = "bf89ac6e-6c2e-4944-885c-9ab62f58fe71")]
		public interface ICommDlgBrowser
		{
			/// <summary>Called when a user double-clicks in the view or presses the ENTER key.</summary>
			/// <param name="ppshv">A pointer to the view's IShellView interface.</param>
			void OnDefaultCommand([In] IShellView ppshv);

			/// <summary>Called after a state, identified by the uChange parameter, has changed in the IShellView interface.</summary>
			/// <param name="ppshv">A pointer to the view's IShellView interface.</param>
			/// <param name="uChange">Change in the selection state. This parameter can be one of the following values.</param>
			void OnStateChange([In] IShellView ppshv, CDBOSC uChange);

			/// <summary>Allows the common dialog box to filter objects that the view displays.</summary>
			/// <param name="ppshv">A pointer to the view's IShellView interface.</param>
			/// <param name="pidl">A PIDL, relative to the folder, that identifies the object.</param>
			/// <returns>The browser should return S_OK to include the object in the view, or S_FALSE to hide it.</returns>
			[PreserveSig]
			HRESULT IncludeObject([In] IShellView ppshv, PIDL pidl);
		}

		/// <summary>
		/// Extends the capabilities of ICommDlgBrowser. This interface is exposed by the common file dialog boxes when they host a Shell
		/// browser. A pointer to ICommDlgBrowser2 can be obtained by calling QueryInterface on the IShellBrowser object.
		/// </summary>
		/// <seealso cref="Vanara.PInvoke.Shell32.ICommDlgBrowser"/>
		[ComImport, InterfaceType(ComInterfaceType.InterfaceIsIUnknown), Guid("10339516-2894-11d2-9039-00C04F8EEB3E")]
		[PInvokeData("Shobjidl.h", MSDNShortId = "07a416a2-340d-4308-a6f3-cf6f19f3c906")]
		public interface ICommDlgBrowser2 : ICommDlgBrowser
		{
			/// <summary>Called when a user double-clicks in the view or presses the ENTER key.</summary>
			/// <param name="ppshv">A pointer to the view's IShellView interface.</param>
			new void OnDefaultCommand([In] IShellView ppshv);

			/// <summary>Called after a state, identified by the uChange parameter, has changed in the IShellView interface.</summary>
			/// <param name="ppshv">A pointer to the view's IShellView interface.</param>
			/// <param name="uChange">Change in the selection state. This parameter can be one of the following values.</param>
			new void OnStateChange([In] IShellView ppshv, CDBOSC uChange);

			/// <summary>Allows the common dialog box to filter objects that the view displays.</summary>
			/// <param name="ppshv">A pointer to the view's IShellView interface.</param>
			/// <param name="pidl">A PIDL, relative to the folder, that identifies the object.</param>
			/// <returns>The browser should return S_OK to include the object in the view, or S_FALSE to hide it.</returns>
			[PreserveSig]
			new HRESULT IncludeObject([In] IShellView ppshv, PIDL pidl);

			/// <summary>Called by a Shell view to notify the common dialog box hosting it that an event has occurred.</summary>
			/// <param name="ppshv">A pointer to the view's IShellView interface.</param>
			/// <param name="dwNotifyType">A flag that can can take one of the following two values.</param>
			void Notify([In] IShellView ppshv, CDB2N dwNotifyType);

			/// <summary>Called by the Shell view to get the default shortcut menu text.</summary>
			/// <param name="ppshv">A pointer to the view's IShellView interface.</param>
			/// <param name="pszText">A pointer to a buffer that is used by the Shell browser to return the default shortcut menu text.</param>
			/// <param name="cchMax">
			/// The size of the pszText buffer, in characters. It should be at least the maximum allowable path length (MAX_PATH) in size.
			/// </param>
			/// <returns>
			/// Returns S_OK if a new default shortcut menu text was returned in pshv. If S_FALSE is returned, use the normal default text.
			/// Otherwise, returns a standard COM error value.
			/// </returns>
			[PreserveSig]
			HRESULT GetDefaultMenuText([In] IShellView ppshv, [MarshalAs(UnmanagedType.LPWStr)] StringBuilder pszText, int cchMax);

			/// <summary>Called when the view must determine if special customization needs to be made for the common dialog browser.</summary>
			/// <returns>A DWORD value that controls the behavior of the view when in common dialog mode.</returns>
			CDB2GVF GetViewFlags();
		}

		/// <summary>Extends the capabilities of ICommDlgBrowser2, and used by the common file dialog boxes when they host a Shell browser.</summary>
		/// <seealso cref="Vanara.PInvoke.Shell32.ICommDlgBrowser"/>
		[ComImport, InterfaceType(ComInterfaceType.InterfaceIsIUnknown), Guid("c8ad25a1-3294-41ee-8165-71174bd01c57")]
		[PInvokeData("Shobjidl.h", MSDNShortId = "c9286061-8ac8-452b-9204-193bc6b571cb")]
		public interface ICommDlgBrowser3 : ICommDlgBrowser2
		{
			/// <summary>Called when a user double-clicks in the view or presses the ENTER key.</summary>
			/// <param name="ppshv">A pointer to the view's IShellView interface.</param>
			new void OnDefaultCommand([In] IShellView ppshv);

			/// <summary>Called after a state, identified by the uChange parameter, has changed in the IShellView interface.</summary>
			/// <param name="ppshv">A pointer to the view's IShellView interface.</param>
			/// <param name="uChange">Change in the selection state. This parameter can be one of the following values.</param>
			new void OnStateChange([In] IShellView ppshv, CDBOSC uChange);

			/// <summary>Allows the common dialog box to filter objects that the view displays.</summary>
			/// <param name="ppshv">A pointer to the view's IShellView interface.</param>
			/// <param name="pidl">A PIDL, relative to the folder, that identifies the object.</param>
			/// <returns>The browser should return S_OK to include the object in the view, or S_FALSE to hide it.</returns>
			[PreserveSig]
			new HRESULT IncludeObject([In] IShellView ppshv, PIDL pidl);

			/// <summary>Called by a Shell view to notify the common dialog box hosting it that an event has occurred.</summary>
			/// <param name="ppshv">A pointer to the view's IShellView interface.</param>
			/// <param name="dwNotifyType">A flag that can can take one of the following two values.</param>
			new void Notify([In] IShellView ppshv, CDB2N dwNotifyType);

			/// <summary>Called by the Shell view to get the default shortcut menu text.</summary>
			/// <param name="ppshv">A pointer to the view's IShellView interface.</param>
			/// <param name="pszText">A pointer to a buffer that is used by the Shell browser to return the default shortcut menu text.</param>
			/// <param name="cchMax">
			/// The size of the pszText buffer, in characters. It should be at least the maximum allowable path length (MAX_PATH) in size.
			/// </param>
			/// <returns>
			/// Returns S_OK if a new default shortcut menu text was returned in pshv. If S_FALSE is returned, use the normal default text.
			/// Otherwise, returns a standard COM error value.
			/// </returns>
			[PreserveSig]
			new HRESULT GetDefaultMenuText([In] IShellView ppshv, [MarshalAs(UnmanagedType.LPWStr)] StringBuilder pszText, int cchMax);

			/// <summary>Called when the view must determine if special customization needs to be made for the common dialog browser.</summary>
			/// <returns>A DWORD value that controls the behavior of the view when in common dialog mode.</returns>
			new CDB2GVF GetViewFlags();

			/// <summary>Called after a specified column is clicked in the IShellView interface.</summary>
			/// <param name="ppshv">A pointer to the IShellView interface of the hosted view.</param>
			/// <param name="iColumn">The index of the column clicked.</param>
			void OnColumnClicked([In] IShellView ppshv, int iColumn);

			/// <summary>Gets the current filter as a Unicode string.</summary>
			/// <param name="pszFileSpec">Contains a pointer to the current filter path/file as a Unicode string.</param>
			/// <param name="cchFileSpec">Specifies the path/file length, in characters.</param>
			void GetCurrentFilter([MarshalAs(UnmanagedType.LPWStr)] StringBuilder pszFileSpec, int cchFileSpec);

			/// <summary>Called after a specified preview is created in the IShellView interface.</summary>
			/// <param name="ppshv">A pointer to the IShellView interface of the hosted view.</param>
			void OnPreViewCreated([In] IShellView ppshv);
		}
	}
}