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

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

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

/**
 * @brief
 * CXTPEditThemeDefault is a class used to perform theme drawing tasks.
 */
class _XTP_EXT_CLASS CXTPEditThemeDefault : public CXTPEditTheme
{
public:
	/**
	 * @brief
	 * Constructs a CXTPEditThemeDefault object.
	 */
	CXTPEditThemeDefault();

	/**
	 * @brief
	 * Destructor, handles cleanup and deallocation.
	 */
	virtual ~CXTPEditThemeDefault();

	/**
	 * @brief
	 * This member function is called by the theme manager to refresh
	 * the visual styles used by each component's theme.
	 * @param pEdit Pointer to a CXTPEdit object.
	 */
	virtual void RefreshMetrics(CXTPEdit* pEdit);

	/**
	 * @brief
	 * This member function is called by the theme manager to draw
	 * non-client borders for the edit control.
	 * @param pDC   Pointer to a valid device context for the control.
	 * @param rcWnd Size of the area to draw borders on.
	 * @param pEdit Pointer to a CXTPEdit object.
	 */
	virtual void DrawNcBorders(CDC* pDC, CRect rcWnd, CXTPEdit* pEdit);

	/**
	 * @brief
	 * Called by the framework to draw the non-client background for
	 * the combobox scrollbar area.
	 * @param pDC   Pointer to a valid device context.
	 * @param rcWnd Size in window coordinates for the combobox.
	 * @param pEdit Pointer to the edit control to to be drawn.
	 */
	virtual void DrawNcScrollBack(CDC* pDC, CRect rcWnd, CXTPEdit* pEdit);

	/**
	 * @brief
	 * Called by the framework to handle setting the text and background
	 * colors for the edit control.
	 * @param pDC       Pointer to a valid device context.
	 * @param nCtlColor Specifies type of control (either CTLCOLOR_STATIC
	 * or CTLCOLOR_EDIT).
	 * @param pEdit     Pointer to the edit control to to be drawn.
	 * @return
	 * A pointer to the brush used for painting the control background.
	 */
	virtual CBrush* CtlColor(CDC* pDC, UINT nCtlColor, CXTPEdit* pEdit);

	/**
	 * @brief
	 * Called by the framework to adjust the size of the area to draw
	 * the buddy control borders on.
	 * @param pBuddy     Pointer to the buddy control associated with the edit.
	 * @param rcUpDown   Size of the buddy border area to be drawn.
	 * @param nAlignment Side of the edit box that the buddy is attached to
	 * (either UDS_ALIGNRIGHT or UDS_ALIGNLEFT).
	 * @return
	 * TRUE if successful, otherwise FALSE.
	 */
	virtual BOOL AdjustBuddyRect(CWnd* pBuddy, CRect& rcUpDown, int nAlignment);

	/**
	 * @brief
	 * Called by the framework to draw the borders for the associated
	 * buddy window.
	 * @param pBuddy     Pointer to the buddy control associated with the edit.
	 * @param pDC        Pointer to a valid device context.
	 * @param rc         Size of the buddy border area to be drawn.
	 * @param nAlignment Side of the edit box that the buddy is attached to
	 * (either UDS_ALIGNRIGHT or UDS_ALIGNLEFT).
	 * @param pEdit      Pointer to the edit control for the buddy window.
	 */
	virtual void DrawBuddyBorders(CWnd* pBuddy, CDC* pDC, CRect rc, int nAlignment,
								  CXTPEdit* pEdit);

protected:
	/**
	 * @brief
	 * Called by the paint-manager to draw the borders for the associated
	 * buddy window.
	 * @param pDC        Pointer to a valid device context.
	 * @param rc         Size of the buddy border area to be drawn.
	 * @param nAlignment Side of the edit box that the buddy is attached to
	 * (either UDS_ALIGNRIGHT or UDS_ALIGNLEFT).
	 * @param pEdit      Pointer to the edit control for the buddy window.
	 * @return
	 * TRUE if the borders were successfully drawn.
	 */
	virtual BOOL DrawBuddyBorders(CDC* pDC, CRect rc, int nAlignment, CXTPEdit* pEdit);

	/**
	 * @brief
	 * Called by the paint-manager to perform Windows default border
	 * drawing for the non-client area of the combobox.
	 * @param pDC        Pointer to a valid device context.
	 * @param rcWnd      Size of the border area to be drawn.
	 * @param pEdit      Pointer to the edit control.
	 * @return
	 * TRUE if the default borders were drawn, otherwise FALSE.
	 */
	virtual BOOL DrawNcBordersDefault(CDC* pDC, CRect rcWnd, CXTPEdit* pEdit);
};

#	include "Common/Base/Diagnostic/XTPEnableNoisyWarnings.h"
/** @cond */
#endif // __XTPEDITTHEMEDEFAULT_H__
	   /** @endcond */