/**
 * @file XTPDockingPaneColorSet.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(__XTPDOCKINGPANECOLORSET_H__)
#	define __XTPDOCKINGPANECOLORSET_H__
/** @endcond */

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

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

/**
 * @brief
 * Helper class used to initialize default colors for a theme from
 * an .INI resource.
 */
class _XTP_EXT_CLASS CXTPDockingPaneColorSet
{
public:
	/**
	 * @brief
	 * Handles object destruction.
	 */
	virtual ~CXTPDockingPaneColorSet();

	/**
	 * @brief
	 * This member function is used to initialize default colors
	 * for a theme from an .INI resource.
	 * @param strSection Location of color settings in theme .INI file.
	 */
	virtual void RefreshMetrics(CString strSection) = 0;

	/**
	 * @brief
	 * Call this member function to retrieve the state color set
	 * for the caption button specified by pButton.
	 * @param pButton Pointer to a CXTPDockingPaneCaptionButton object used
	 * to determine the correct color set to return.
	 * @return
	 * A reference to a CXTPColorSetCaptionButton object representing
	 * the caption button state colors.
	 */
	virtual CXTPColorSetCaptionButton& GetButtonColorSet(CXTPDockingPaneCaptionButton* pButton);

	CXTPPaintManagerColor m_clrBorder;	 /**< Border color. */
	CXTPPaintManagerColor m_clrBackground; /**< Background color. */
	CXTPPaintManagerColor m_clrCaption;	/**< Caption color. */
	CXTPPaintManagerColor m_clrText;	   /**< Text color. */
	CXTPPaintManagerColor m_clrGripper;	/**< Gripper color. */
	CXTPPaintManagerColor m_clrSplitter;   /**< Splitter color. */

protected:
	CXTPColorSetCaptionButton m_csCaptionButtonHot;	/**< Selected state caption button colors. */
	CXTPColorSetCaptionButton m_csCaptionButtonNormal; /**< Normal state caption button colors. */
	CXTPColorSetCaptionButton m_csCaptionButtonPressed; /**< Pressed state caption button colors. */
};

#	include "Common/Base/Diagnostic/XTPEnableNoisyWarnings.h"
/** @cond */
#endif // !defined(__XTPDOCKINGPANECOLORSET_H__)
/** @endcond */