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

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

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

class CXTPChartFont;
class CXTPChartElementView;
class CXTPChartDeviceContext;
class CXTPChartLegend;
class CXTPChartLegendView;
class CXTPChartDeviceContext;
class CXTPChartDeviceCommand;
class CXTPChartBorder;
class CXTPChartFillStyle;
class CXTPPropExchange;

/**
 * @brief
 * Enumerates the legend orientation.
 */
enum XTPChartLegendDirection
{
	xtpChartLegendTopToBottom, /**< The legend items are arranged from top to bottom.*/
	xtpChartLegendLeftToRight, /**< The legend items are arranged from left to right.*/
};

/**
 * @brief
 * Enumerates the legend alignment.
 */
enum XTPChartLegendAlignment
{
	xtpChartLegendNearOutside, /**< The legend is placed out side of the chart, near the primary Y
									axis.*/
	xtpChartLegendNear,   /**< The legend is placed inside of the chart, near the primary Y axis.*/
	xtpChartLegendCenter, /**< The legend is placed at the center of the chart.*/
	xtpChartLegendFar, /**< The legend is placed inside of the chart, near the secondary Y axis.*/
	xtpChartLegendFarOutside, /**< The legend is placed outside of the chart, near the secondary Y
								   axis.*/
};

/**
 * @brief
 * Sort the legend strings.
 */
enum XTPChartLegendSortDirection
{
	xtpChartLegendNone,		/**< The legend items no sorting*/
	xtpChartLegendMinToMax, /**< The legend items are sorting minimum first*/
	xtpChartLegendMaxToMin, /**< The legend items are sorting maximum first*/
	xtpChartLegendAsc,		/**< The legend items are sorting ascending*/
	xtpChartLegendDesc,		/**< The legend items are sorting descending*/
};

/**
 * @brief
 * This class represents a chart legend as a kind of chart element.
 * It abstracts all the features of a chart legend.
 */
class _XTP_EXT_CLASS CXTPChartLegend : public CXTPChartTextElement
{
	/** @cond */
	DECLARE_DYNAMIC(CXTPChartLegend)
	/** @endcond */
public:
	/**
	 * @brief
	 * Constructs a CXTPChartLegend object.
	 *
	 * @param pOwner     Pointer to the CXTPChartContent object which owns this legend.
	 */
	CXTPChartLegend(CXTPChartContent* pOwner);

	/**
	 * @brief
	 * Destroys a CXTPChartLegend object, handles cleanup.
	 */
	virtual ~CXTPChartLegend();

public:
	/**
	 * @brief
	 * Call this function to see whether the legend is visible.
	 *
	 * @return
	 * Returns a BOOL value. TRUE if the legend is visible, FALSE otherwise.
	 */
	BOOL IsVisible() const;

	/**
	 * @brief
	 * Call this function to set the legend visible/invisible.
	 *
	 * @param bVisible    A BOOL value. TRUE to set the legend visible,
	 *                    FALSE to hide the legend.
	 */
	void SetVisible(BOOL bVisible);

	/**
	 * @brief
	 * This function returns the CXTPChartFont object pointer associated with
	 * the CXTPChartLegend object.
	 *
	 * @return
	 * Returns a pointer to CXTPChartFont.
	 */
	CXTPChartFont* GetFont() const;

	/**
	 * @brief
	 * Call this function, to set the font for the legend
	 *
	 * @param pFont    A CXTPChartFont object, represents the type of font.
	 */
	void SetFont(CXTPChartFont* pFont);

	/**
	 * @brief
	 * This function returns whether the marker is visible.
	 *
	 * @return
	 * Returns a BOOL value. TRUE if the marker is visible, FALSE otherwise.
	 */
	BOOL IsMarkerVisible() const;

	/**
	 * @brief
	 * Call this function to set the marker visible/invisible.
	 *
	 * @param bVisible    A BOOL value. TRUE to set the marker visible,
	 *                    FALSE to hide the marker.
	 */
	void SetMarkerVisible(BOOL bVisible);

	/**
	 * @brief
	 * Call this function to get the marker size (width and height).
	 *
	 * @return
	 * Returns a CSize object, which gives the size of the marker.
	 */
	CSize GetMarkerSize() const;

	/**
	 * @brief
	 * Call this function to set the marker size.
	 *
	 * @param sz    A CSize object representing the width and height
	 *              of the marker.
	 */
	void SetMarkerSize(CSize sz);

	/**
	 * @brief
	 * Call this function to set the text color of the legend.
	 *
	 * @param clrTextColor    A CXTPChartColor object representing the ARGB value
	 *                        of the color of choice.
	 */
	void SetTextColor(const CXTPChartColor& clrTextColor);

	/**
	 * @brief
	 * Call this function to get the current text color.
	 *
	 * @return
	 * Returns a CXTPChartColor object, which gives the ARGB value
	 * of the current text color.
	 */
	CXTPChartColor GetTextColor() const;

	/**
	 * @brief
	 * Call this function to get the actual text color.
	 *
	 * @return
	 * Returns a CXTPChartColor object, which gives the ARGB value
	 * of the actual text color.
	 */
	CXTPChartColor GetActualTextColor() const;

	/**
	 * @brief
	 * Call this function to set the background color of the legend.
	 *
	 * @param clrBackgroundColor    A CXTPChartColor object representing the ARGB value
	 *                              of the color of choice.
	 */
	void SetBackgroundColor(const CXTPChartColor& clrBackgroundColor);

	/**
	 * @brief
	 * Call this function to get the current background color.
	 *
	 * @return
	 * Returns a CXTPChartColor object, which gives the ARGB value
	 * of the current background color.
	 */
	CXTPChartColor GetBackgroundColor() const;

	/**
	 * @brief
	 * Call this function to get the actual background color of the legend.
	 *
	 * @return
	 * Returns a CXTPChartColor object, which gives the ARGB value
	 * of the actual background color.
	 */
	CXTPChartColor GetActualBackgroundColor() const;

	/**
	 * @brief
	 * Call this function to get the actual border color of the legend.
	 *
	 * @return
	 * Returns a CXTPChartColor object, which gives the ARGB value
	 * of the actual border color.
	 */
	CXTPChartColor GetActualBorderColor() const;

	/**
	 * @brief
	 * Call this function to set anti-aliasing ON or OFF. Anti-aliasing is
	 * the smoothing of sharp edges of text and drawing.
	 *
	 * @param bAntialiasing A BOOL value. TRUE to set anti-aliasing to ON,
	 *                      FALSE to set anti-aliasing to OFF.
	 */
	void SetAntialiasing(BOOL bAntialiasing);

	/**
	 * @brief
	 * Call this function to check if anti-aliasing is ON or OFF. Anti-aliasing is
	 * the smoothing of sharp edges of text and drawing.
	 *
	 * @return
	 * A BOOL value. TRUE if anti-aliasing is ON, FALSE if anti-aliasing is OFF.
	 */
	BOOL GetAntialiasing() const;

	/**
	 * @brief
	 * Call this function to get the fill style.
	 *
	 * @return
	 * Returns a pointer to a CXTPChartFillStyle object, which represents the
	 * fill style of the legend.
	 */
	CXTPChartFillStyle* GetFillStyle() const;

	/**
	 * @brief
	 * Call this function to get the legend border.
	 *
	 * @return
	 * Returns a pointer to a CXTPChartBorder object, which represents the
	 * border of the legend.
	 */
	CXTPChartBorder* GetBorder() const;

	/**
	 * @brief
	 * Call this function to set the legend's horizontal alignment.
	 *
	 * @param nAlignment    An enumerated value representing the legend alignment.
	 */
	void SetHorizontalAlignment(XTPChartLegendAlignment nAlignment);

	/**
	 * @brief
	 * Call this function to get the legend's horizontal alignment.
	 *
	 * @return
	 * Returns an enumerated value XTPChartLegendAlignment, which represents the
	 * the kind of horizontal alignment chosen.
	 */
	XTPChartLegendAlignment GetHorizontalAlignment() const;

	/**
	 * @brief
	 * Call this function to set the legend's vertical alignment.
	 *
	 * @param nAlignment    An enumerated value representing the legend alignment.
	 */
	void SetVerticalAlignment(XTPChartLegendAlignment nAlignment);

	/**
	 * @brief
	 * Call this function to get the legend's vertical alignment.
	 *
	 * @return
	 * Returns an enumerated value XTPChartLegendAlignment, which represents the
	 * the kind of vertical alignment chosen.
	 */
	XTPChartLegendAlignment GetVerticalAlignment() const;

	/**
	 * @brief
	 * Call this function to set the legend's direction. Either top to bottom or
	 * left to right.
	 *
	 * @param nDirection value indicating the layout direction of panels
	 */
	void SetDirection(XTPChartLegendDirection nDirection);

	/**
	 * @brief
	 * Call this function to get the legend's direction. Either top to bottom or
	 * left to right.
	 *
	 * @return
	 * Returns an enumerated value XTPChartLegendDirection, which represents the
	 * the direction of the legend.
	 */
	XTPChartLegendDirection GetDirection() const;

	void SetColumnCount(int nColumnCount);
	int GetColumnCount() const;

	void SetOffset(CPoint ptOffset);
	CPoint GetOffset() const;

public:
	/**
	 * @brief
	 * This function creates the view (CXTPChartLegendView) of the legend.
	 *
	 * @param pDC The chart device context object pointer.
	 * @param pParentView The parent view of the legend.
	 *
	 * @return
	 * Returns a pointer to the newly created CXTPChartLegendView object.
	 */
	virtual CXTPChartLegendView* CreateView(CXTPChartDeviceContext* pDC,
											CXTPChartElementView* pParentView);

	/**
	 * @brief
	 * This function sets sort direction of legend.
	 *
	 * @param value sort direction value.
	 */
	void SetSortDirection(XTPChartLegendSortDirection value);

	/**
	 * @brief
	 * This function return sort direction of legend.
	 *
	 * @return
	 * Returns sort direction value.
	 */
	XTPChartLegendSortDirection GetSortDirection() const;

protected:
	/**
	 * @brief
	 * Call this member function to Store/Load the properties of a legend object
	 * using the specified data object.
	 *
	 * @param pPX Source or destination CXTPPropExchange data object reference.
	 *
	 * @details
	 * This member function is used to store property data to or load property
	 * data from storage.
	 */
	virtual void DoPropExchange(CXTPPropExchange* pPX);

#	ifdef _XTP_ACTIVEX
public:
	/** @cond */
	DECLARE_DISPATCH_MAP()
	DECLARE_INTERFACE_MAP()
	DECLARE_OLETYPELIB_EX(CXTPChartLegend);

	afx_msg OLE_COLOR OleGetTextColor();
	afx_msg void OleSetTextColor(OLE_COLOR clr);
	afx_msg OLE_COLOR OleGetBackgroundColor();
	afx_msg void OleSetBackgroundColor(OLE_COLOR clr);
	afx_msg int OleGetMarkerWidth();
	afx_msg void OleSetMarkerWidth(int sz);
	afx_msg int OleGetMarkerHeight();
	afx_msg void OleSetMarkerHeight(int sz);
	afx_msg LPDISPATCH OleGetFillStyle();
	afx_msg LPDISPATCH OleGetBorder();
	afx_msg int OleGetOffsetX();
	afx_msg int OleGetOffsetY();
	afx_msg void OleSetOffsetY(int val);
	afx_msg void OleSetOffsetX(int val);
	afx_msg void OleSetSortDirection(XTPChartLegendSortDirection val);
	afx_msg XTPChartLegendSortDirection OleGetSortDirection();
	afx_msg LPDISPATCH CXTPChartLegend::OleGetFont();
/** @endcond */
#	endif

public:
	BOOL m_bVisible;				  /**< TRUE if the legend is visible.*/
	BOOL m_bAntialiasing;			  /**< TRUE if antialiasing is turned ON*/
	CXTPChartBorder* m_pBorder;		  /**< Pointer to chart border object.*/
	CXTPChartFillStyle* m_pFillStyle; /**< Pointer to chart fill style object.*/
	CXTPChartFont* m_pFont;			  /**< Pointer to font object.*/
	CSize m_szMarkerSize;			  /**< Size of the marker.*/

	CXTPChartColor m_clrBackgroundColor; /**< Chart background color.*/
	CXTPChartColor m_clrTextColor;		 /**< Chart text color.*/
	BOOL m_bMarkerVisible;				 /**< TRUE if marker is visible.*/

	int m_nColumnCount; /**< Column Count*/

	XTPChartLegendAlignment m_nHorizontalAlignment; /**< Legend horizontal alignment.*/
	XTPChartLegendAlignment m_nVerticalAlignment;   /**< Legend vertical alignment.*/
	XTPChartLegendDirection m_nDirection;			/**< Legend orientation.*/
	XTPChartLegendSortDirection m_nSortDirection;   /**< Legend sorting direction.*/

	CPoint m_ptOffset;

	friend class CXTPChartContent;
};

AFX_INLINE BOOL CXTPChartLegend::IsVisible() const
{
	return m_bVisible;
}

AFX_INLINE void CXTPChartLegend::SetVisible(BOOL bVisible)
{
	m_bVisible = bVisible;
	OnChartChanged();
}

AFX_INLINE CXTPChartFont* CXTPChartLegend::GetFont() const
{
	return m_pFont;
}

AFX_INLINE CSize CXTPChartLegend::GetMarkerSize() const
{
	return m_szMarkerSize;
}

AFX_INLINE void CXTPChartLegend::SetMarkerSize(CSize sz)
{
	m_szMarkerSize = sz;
	OnChartChanged();
}

AFX_INLINE BOOL CXTPChartLegend::IsMarkerVisible() const
{
	return m_bMarkerVisible;
}

AFX_INLINE void CXTPChartLegend::SetMarkerVisible(BOOL bVisible)
{
	m_bMarkerVisible = bVisible;
	OnChartChanged();
}

AFX_INLINE void CXTPChartLegend::SetAntialiasing(BOOL bAntialiasing)
{
	m_bAntialiasing = bAntialiasing;
	OnChartChanged();
}

AFX_INLINE BOOL CXTPChartLegend::GetAntialiasing() const
{
	return m_bAntialiasing;
}

AFX_INLINE CXTPChartFillStyle* CXTPChartLegend::GetFillStyle() const
{
	return m_pFillStyle;
}

AFX_INLINE CXTPChartBorder* CXTPChartLegend::GetBorder() const
{
	return m_pBorder;
}

AFX_INLINE void CXTPChartLegend::SetHorizontalAlignment(XTPChartLegendAlignment nAlignment)
{
	m_nHorizontalAlignment = nAlignment;
	OnChartChanged();
}

AFX_INLINE XTPChartLegendAlignment CXTPChartLegend::GetHorizontalAlignment() const
{
	return m_nHorizontalAlignment;
}

AFX_INLINE void CXTPChartLegend::SetVerticalAlignment(XTPChartLegendAlignment nAlignment)
{
	m_nVerticalAlignment = nAlignment;
	OnChartChanged();
}

AFX_INLINE XTPChartLegendAlignment CXTPChartLegend::GetVerticalAlignment() const
{
	return m_nVerticalAlignment;
}

AFX_INLINE void CXTPChartLegend::SetDirection(XTPChartLegendDirection nDirection)
{
	m_nDirection = nDirection;
	OnChartChanged();
}

AFX_INLINE XTPChartLegendDirection CXTPChartLegend::GetDirection() const
{
	return m_nDirection;
}

AFX_INLINE void CXTPChartLegend::SetColumnCount(int nColumnCount)
{
	m_nColumnCount = nColumnCount;
	OnChartChanged();
}

AFX_INLINE int CXTPChartLegend::GetColumnCount() const
{
	return m_nColumnCount;
}

AFX_INLINE void CXTPChartLegend::SetOffset(CPoint ptOffset)
{
	m_ptOffset = ptOffset;
	OnChartChanged();
}

AFX_INLINE CPoint CXTPChartLegend::GetOffset() const
{
	return m_ptOffset;
}

AFX_INLINE void CXTPChartLegend::SetSortDirection(XTPChartLegendSortDirection value)
{
	m_nSortDirection = value;
	OnChartChanged();
}

AFX_INLINE XTPChartLegendSortDirection CXTPChartLegend::GetSortDirection() const
{
	return m_nSortDirection;
}
/** @cond */
#	include "Common/Base/Diagnostic/XTPEnableNoisyWarnings.h"
#endif //#if !defined(__XTPCHARTLEGEND_H__)
	   /** @endcond */