/**
 * @file XTPShellSettings.h
 *
 * @copyright
 * (c) 1998-2025 Codejock Software, All Rights Reserved.
 *
 * This source file is the property of Codejock Software and must not be
 * redistributed by any means without the explicit written permission of
 * Codejock Software.
 *
 * The use of this source code is governed by the terms and conditions specified
 * in the Toolkit Pro license agreement. Codejock Software grants you, as a
 * single software developer, the limited right to use this software on one
 * computer only.
 *
 * Contact Information:
 * support@codejock.com
 * http://www.codejock.com
 *
 */

/** @cond */
#if !defined(__XTPSHELLSETTINGS_H__)
#	define __XTPSHELLSETTINGS_H__
/** @endcond */

#	if _MSC_VER > 1000
#		pragma once
#	endif // _MSC_VER > 1000

#	include "Common/Base/Diagnostic/XTPDisableNoisyWarnings.h"

/**
 * @brief
 * CXTPShellSettings is a SHELLFLAGSTATE struct derived class. CXTPShellSettings
 * extends the SHELLFLAGSTATE struct for easy access to the shell flag
 * state settings.
 */
class _XTP_EXT_CLASS CXTPShellSettings : public SHELLFLAGSTATE
{
public:
	/**
	 * @brief
	 * Constructs a CXTPShellSettings object.
	 */
	CXTPShellSettings();

	/**
	 * @brief
	 * Destroys a CXTPShellSettings object, handles cleanup and deallocation.
	 */
	~CXTPShellSettings();

public:
	/**
	 * @brief
	 * This member function checks whether or not the Show All Files option is
	 * enabled.
	 * @return
	 * true if enabled, otherwise false.
	 */
	bool ShowAllFiles();

	/**
	 * @brief
	 * This member function checks whether or not the Hide File Extensions for
	 * Known File Types option is enabled.
	 * @return
	 * true if enabled, otherwise false.
	 */
	bool ShowExtensions();

	/**
	 * @brief
	 * This member function checks to see if the Display Delete Confirmation
	 * Dialog box in the Recycle Bin is enabled.
	 * @return
	 * true if enabled, otherwise false.
	 */
	bool NoConfirmRecycle();

	/**
	 * @brief
	 * This member function checks whether or not the Do Not Show Hidden Files
	 * option is selected.
	 * @return
	 * true if selected, otherwise false.
	 */
	bool ShowSysFiles();

	/**
	 * @brief
	 * This member function checks whether or not the Display Compressed Files
	 * and Folders with Alternate Color option is enabled.
	 * @return
	 * true if enabled, otherwise false.
	 */
	bool ShowCompColor();

	/**
	 * @brief
	 * This member function checks whether or not the Double-Click to Open an
	 * Item option is enabled.
	 * @return
	 * true if enabled, otherwise false.
	 */
	bool DoubleClickOpen();

	/**
	 * @brief
	 * This member function checks whether or not the Active Desktop - View as
	 * Web Page option is enabled.
	 * @return
	 * true if enabled, otherwise false.
	 */
	bool HTMLDesktop();

	/**
	 * @brief
	 * This member function checks whether or not the Classic Style option is
	 * enabled.
	 * @return
	 * true if enabled, otherwise false.
	 */
	bool Win95Classic();

	/**
	 * @brief
	 * This member function checks whether or not the Allow All Uppercase Names
	 * option is enabled.
	 * @return
	 * true if enabled, otherwise false.
	 */
	bool AllowUpperCase();

	/**
	 * @brief
	 * This member function checks whether or not the Show File Attributes in
	 * Detail View option is enabled.
	 * @return
	 * true if enabled, otherwise false.
	 */
	bool ShowAttributes();

	/**
	 * @brief
	 * This member function checks whether or not the Show Map Network Drive
	 * Button in Toolbar option is enabled.
	 * @return
	 * true if enabled, otherwise false.
	 */
	bool ShowMapNetworkDrive();

	/**
	 * @brief
	 * This member function checks whether or not the Show Info Tips for Items
	 * in Folders & Desktop option is enabled.
	 * @return
	 * true if enabled, otherwise false.
	 */
	bool ShowInfoTips();

	/**
	 * @brief
	 * Call this member function to update the SHELLFLAGSTATE values for
	 * this object.
	 */
	void RefreshSettings();

	COLORREF m_crCompColor; /**< An RGB color value that represents the system alternate compressed
							   color. */
	COLORREF m_crEncrColor; /**< An RGB color value that represents the system alternate encrypted
							   color. */
};

//////////////////////////////////////////////////////////////////////
/** @cond */
AFX_INLINE bool CXTPShellSettings::ShowAllFiles()
{
	return fShowAllObjects != 0 ? true : false;
}
AFX_INLINE bool CXTPShellSettings::ShowExtensions()
{
	return fShowExtensions != 0 ? true : false;
}
AFX_INLINE bool CXTPShellSettings::NoConfirmRecycle()
{
	return fNoConfirmRecycle != 0 ? true : false;
}
AFX_INLINE bool CXTPShellSettings::ShowSysFiles()
{
	return fShowSysFiles != 0 ? true : false;
}
AFX_INLINE bool CXTPShellSettings::ShowCompColor()
{
	return fShowCompColor != 0 ? true : false;
}
AFX_INLINE bool CXTPShellSettings::DoubleClickOpen()
{
	return fDoubleClickInWebView != 0 ? true : false;
}
AFX_INLINE bool CXTPShellSettings::HTMLDesktop()
{
	return fDesktopHTML != 0 ? true : false;
}
AFX_INLINE bool CXTPShellSettings::Win95Classic()
{
	return fWin95Classic != 0 ? true : false;
}
AFX_INLINE bool CXTPShellSettings::AllowUpperCase()
{
	return fDontPrettyPath != 0 ? true : false;
}
AFX_INLINE bool CXTPShellSettings::ShowAttributes()
{
	return fShowAttribCol != 0 ? true : false;
}
AFX_INLINE bool CXTPShellSettings::ShowMapNetworkDrive()
{
	return fMapNetDrvBtn != 0 ? true : false;
}
AFX_INLINE bool CXTPShellSettings::ShowInfoTips()
{
	return fShowInfoTip != 0 ? true : false;
}
/** @endcond */
#	include "Common/Base/Diagnostic/XTPEnableNoisyWarnings.h"
/** @cond */
#endif // !defined(__XTPSHELLSETTINGS_H__)
/** @endcond */