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

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

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

class CXTPWinThemeWrapper;
class CXTPEdit;

/**
 * @brief
 * CXTPEditTheme is the base class for all edit themes used to perform
 * drawing tasks.
 */
class _XTP_EXT_CLASS CXTPEditTheme : public CXTPControlTheme
{
public:
	/**
	 * @brief
	 * Constructs a CXTPEditThemeDefault object.
	 */
	CXTPEditTheme();

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

	/**
	 * @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) = 0;

	/**
	 * @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) = 0;

	/**
	 * @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 be drawn.
	 */
	virtual void DrawNcScrollBack(CDC* pDC, CRect rcWnd, CXTPEdit* pEdit) = 0;

	/**
	 * @brief
	 * Called by the edit control to fill a rectangle using the brush
	 * specifed by pBrush.
	 * @param pDC    Pointer to a valid device context.
	 * @param x      Left side of the rectangle to draw.
	 * @param y      Top side of the rectangle to draw.
	 * @param cx     Width of the rectangle to draw.
	 * @param cy     Height of the rectangle to draw.
	 * @param pBrush Pointer to a CBrush object representing the background
	 * fill color.
	 */
	virtual void FillRect(CDC* pDC, int x, int y, int cx, int cy, CBrush* pBrush);

	/**
	 * @brief
	 * Called by the edit control to draw a frame rectangle using the
	 * brush specified by pBrush.
	 * @param pDC    Pointer to a valid device context.
	 * @param rc     CRect object representing the size of rectangle to draw.
	 * @param nSize  Width in pixels of the rectangle borders.
	 * @param pBrush Pointer to a CBrush object representing the border
	 * fill color.
	 */
	virtual void DrawFrame(CDC* pDC, CRect rc, int nSize, CBrush* pBrush);

	/**
	 * @brief
	 * Call this member function to retrieve a pointer to the client
	 * background brush.
	 * @param pDC Pointer to a valid device context.
	 * @param pEdit Pointer to the edit control.
	 * @return
	 * A CBrush pointer representing the client background brush.
	 */
	virtual CBrush* GetClientBrush(CDC* pDC, 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 brush object pointer to use or NULL.
	 */
	virtual CBrush* CtlColor(CDC* pDC, UINT nCtlColor, CXTPEdit* pEdit) = 0;

	/**
	 * @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) = 0;

	/**
	 * @brief
	 * Called by the framework to redraw the focus rectangle for the
	 * edit control.
	 * @return
	 * The implementation must return TRUE to indicate that the focused
	 * frame has to be redrawn, or FALSE otherwise.
	 */
	virtual BOOL RedrawFocusedFrame() const;

	/**
	 * @brief
	 * Call this member function to determine if the m_bFlatStyle
	 * flag has be set.
	 * @return
	 * TRUE if the flag has been set, otherwise FALSE.
	 */
	BOOL IsFlatStyle() const;

	/**
	 * @brief
	 * Call this member function to set a value for m_bFlatStyle.
	 * @param bFlatStyle TRUE to set the flat style flag.
	 */
	void SetFlatStyle(BOOL bFlatStyle);

	/**
	 * @brief
	 * Call this member function to get the style for the theme.
	 * @return
	 * A XTPControlTheme enumerator index value representing the
	 * theme style.
	 */
	XTPControlTheme GetThemeID() const;

	/**
	 * @brief
	 * Call this member function to enable Windows themes for the
	 * edit control.
	 * @param bUseWinTheme TRUE to use Windows themes.
	 */
	void UseWinTheme(BOOL bUseWinTheme);

	CXTPBrush m_xtpBrushBack; /**< Background brush color. */
	XTP_SUBSTITUTE_GDI_MEMBER_WITH_CACHED(CBrush, m_brBack, m_xtpBrushBack, GetBackBrushHandle);

	CXTPPaintManagerColor m_clrBack;		   /**< Background color. */
	CXTPPaintManagerColor m_clrText;		   /**< Text color. */
	CXTPPaintManagerColor m_clrTextReadOnly;   /**< Read-only text color. */
	CXTPPaintManagerColor m_clrBackNonClient;  /**< Non-client area background color. */
	CXTPPaintManagerColorGradient m_clrBorder; /**< Dark and light border colors. */

protected:
	BOOL m_bFlatStyle;				/**< TRUE when drawing flat borders. */
	BOOL m_bUseWinTheme;			/**< TRUE to use windows themes. */
	XTPControlTheme m_nTheme;		/**< Specifies the Theme ID used by the paint manager. */
	CXTPWinThemeWrapper m_winTheme; /**< Windows theme wrapper. */

private:
	friend class CXTPEdit;
};

/////////////////////////////////////////////////////////////////////////////
/** @cond */
AFX_INLINE XTPControlTheme CXTPEditTheme::GetThemeID() const
{
	return m_nTheme;
}
AFX_INLINE void CXTPEditTheme::UseWinTheme(BOOL bUseWinTheme)
{
	m_bUseWinTheme = bUseWinTheme;
}
AFX_INLINE BOOL CXTPEditTheme::IsFlatStyle() const
{
	return m_bFlatStyle;
}
AFX_INLINE void CXTPEditTheme::SetFlatStyle(BOOL bFlatStyle)
{
	m_bFlatStyle = bFlatStyle;
}
/** @endcond */
#	include "Common/Base/Diagnostic/XTPEnableNoisyWarnings.h"
/** @cond */
#endif // __XTPEDITTHEME_H__
/** @endcond */