FH98ViewOnPlaneSoftware/Src/XtremeToolKitPro/Chart/XTPChartSeriesLabel.h

// XTPChartSeriesLabel.h
//
// This file is a part of the XTREME TOOLKIT PRO MFC class library.
// (c)1998-2012 Codejock Software, All Rights Reserved.
//
// THIS SOURCE FILE IS THE PROPERTY OF CODEJOCK SOFTWARE AND IS NOT TO BE
// RE-DISTRIBUTED BY ANY MEANS WHATSOEVER WITHOUT THE EXPRESSED WRITTEN
// CONSENT OF CODEJOCK SOFTWARE.
//
// THIS SOURCE CODE CAN ONLY BE USED UNDER THE TERMS AND CONDITIONS OUTLINED
// IN THE XTREME TOOLKIT PRO LICENSE AGREEMENT. CODEJOCK SOFTWARE GRANTS TO
// YOU (ONE SOFTWARE DEVELOPER) THE LIMITED RIGHT TO USE THIS SOFTWARE ON A
// SINGLE COMPUTER.
//
// CONTACT INFORMATION:
// support@codejock.com
// http://www.codejock.com
//
/////////////////////////////////////////////////////////////////////////////

//{{AFX_CODEJOCK_PRIVATE
#if !defined(__XTPCHARTSERIESLABEL_H__)
#define __XTPCHARTSERIESLABEL_H__
//}}AFX_CODEJOCK_PRIVATE

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

class CXTPChartSeriesStyle;
class CXTPChartElementView;
class CXTPChartDeviceContext;
class CXTPChartSeriesPointView;
class CXTPPoint3d;
class CXTPChartDeviceCommand;
class CXTPChartBorder;
class CXTPChartFillStyle;
class CXTPChartSeriesPoint;
class CXTPChartNumberFormat;



//===========================================================================
// Summary:
//     This class abstracts the label of a series, it is a kind of chart
//     text element.
// Remarks:
// See Also:
//===========================================================================
class _XTP_EXT_CLASS CXTPChartSeriesLabel : public CXTPChartTextElement
{
	DECLARE_SERIAL(CXTPChartSeriesLabel)
public:
	//-----------------------------------------------------------------------
	// Summary:
	//     Constructs a CXTPChartSeriesLabel object.
	// Remarks:
	//-----------------------------------------------------------------------
	CXTPChartSeriesLabel();

	//-------------------------------------------------------------------------
	// Summary:
	//     Destroys a CXTPChartSeriesLabel object, handles cleanup
	//-------------------------------------------------------------------------
	virtual ~CXTPChartSeriesLabel();

public:
	//-----------------------------------------------------------------------
	// Summary:
	//     Call this function to set the text color of the label.
	// Parameters:
	//     clrTextColor - A 32 bit color value specifying the color of choice.
	// Remarks:
	//-----------------------------------------------------------------------
	void SetTextColor(const CXTPChartColor& clrTextColor);

	//-----------------------------------------------------------------------
	// Summary:
	//     Call this function to get the apparent text color of the label.
	// Returns:
	//     A 32 bit color value specifying the color.
	// Remarks:
	//-----------------------------------------------------------------------
	CXTPChartColor GetTextColor() const;

	//-----------------------------------------------------------------------
	// Summary:
	//     Call this function to get the font of the text label.
	// Returns:
	//     A CXTPChartFont object describing the font used.
	// Remarks:
	//-----------------------------------------------------------------------
	CXTPChartFont* GetFont() const;

	//-----------------------------------------------------------------------
	// Summary:
	//     Call this function to set the font of the text label.
	// Parameters:
	//     pFont -  A pointer to CXTPChartFont object describing the font of choice.
	// Remarks:
	//-----------------------------------------------------------------------
	void SetFont(CXTPChartFont* pFont);

	//-----------------------------------------------------------------------
	// Summary:
	//     Call this function to set the lines visible.
	// Parameters:
	//     bShowLines -  TRUE to show the lines, FALSE to hide.
	// Remarks:
	//-----------------------------------------------------------------------
	void SetShowLines(BOOL bShowLines);

	//-----------------------------------------------------------------------
	// Summary:
	//     Call this function to get whether the lines are visible.
	// Returns:
	//     TRUE if the lines are visible, FALSE if not.
	// Remarks:
	//-----------------------------------------------------------------------
	BOOL GetShowLines() const;

	//-----------------------------------------------------------------------
	// Summary:
	//     Call this function to set line length.
	// Parameters:
	//     nLineLength - An integer value specifying the line length.
	// Remarks:
	//-----------------------------------------------------------------------
	void SetLineLength(int nLineLength);

	//-----------------------------------------------------------------------
	// Summary:
	//     Call this function to get line length.
	// Returns:
	//     An integer value specifying the line length.
	// Remarks:
	//-----------------------------------------------------------------------
	int GetLineLength() const;

	//-----------------------------------------------------------------------
	// Summary:
	//     Call this function to set the label visible.
	// Parameters:
	//     bVisible -  TRUE to show the show label, FALSE to hide.
	// Remarks:
	//-----------------------------------------------------------------------
	void SetVisible(BOOL bVisible);

	//-----------------------------------------------------------------------
	// Summary:
	//     Call this function to get whether the label is visible or not.
	// Returns:
	//     TRUE if the label is visible, FALSE if not.
	// Remarks:
	//-----------------------------------------------------------------------
	BOOL IsVisible() const;

	//-------------------------------------------------------------------------
	// Summary:
	//     Call this function to set the antialiasing ON or OFF.
	// Parameters:
	//     bAntialiasing - A BOOL value TRUE to set the antialiasing ON and
	//                   FALSE to OFF the anitialiasing operation.
	// Remarks:
	//     Antialiasing is the smooothing of sharp edges of text and drawing.
	// See Also:
	//-------------------------------------------------------------------------
	void SetAntialiasing(BOOL bAntialiasing);

	//-------------------------------------------------------------------------
	// Summary:
	//     Call this function to get whether antialiasing is enabled or not.
	// Returns:
	//     Returns boolean TRUE if the antialiasing is turned on FALSE if the
	//     antialiasing is turned off.
	// Remarks:
	//     Antialiasing is the smoothing of sharp edges of text and drawing.
	// See Also:
	//-------------------------------------------------------------------------
	BOOL GetAntialiasing() const;

	//-------------------------------------------------------------------------
	// Summary:
	//     Call this function to get pointer to CXTPChartNumberFormat that specify how to convert number to string
	// Returns:
	//     Pointer to CXTPChartNumberFormat class
	// See Also: CXTPChartNumberFormat
	//-------------------------------------------------------------------------
	CXTPChartNumberFormat* GetFormat() const;

	//-------------------------------------------------------------------------
	// Summary:
	//     Obsolete method. Use GetFormat()->SetPattern(lpszFormat) instead
	// Parameters:
	//     lpszFormat - New Pattern to be set
	// See Also: CXTPChartNumberFormat
	//-------------------------------------------------------------------------
	void SetFormat(LPCTSTR lpszFormat);

	virtual CXTPChartString GetPointLabel(CXTPChartSeriesPoint* pPoint, int nValueIndex = -1) const;

	CXTPChartBorder* GetBorder() const;
	CXTPChartFillStyle* GetFillStyle() const;

	//-----------------------------------------------------------------------
	// Summary:
	//     Call this function to set the text color of the label.
	// Parameters:
	//     clrTextColor - A 32 bit color value specifying the color of choice.
	// Remarks:
	//-----------------------------------------------------------------------
	void SetBackColor(const CXTPChartColor& clrBackColor);

	//-----------------------------------------------------------------------
	// Summary:
	//     Call this function to get the apparent text color of the label.
	// Returns:
	//     A 32 bit color value specifying the color.
	// Remarks:
	//-----------------------------------------------------------------------
	CXTPChartColor GetBackColor() const;

	//-----------------------------------------------------------------------
	// Summary:
	//     Call this function to set the text color of the label.
	// Parameters:
	//     clrTextColor - A 32 bit color value specifying the color of choice.
	// Remarks:
	//-----------------------------------------------------------------------
	void SetLineColor(const CXTPChartColor& clrBackColor);

	//-----------------------------------------------------------------------
	// Summary:
	//     Call this function to get the apparent text color of the label.
	// Returns:
	//     A 32 bit color value specifying the color.
	// Remarks:
	//-----------------------------------------------------------------------
	CXTPChartColor GetLineColor() const;

	//-------------------------------------------------------------------------
	// Summary:
	//     Call this function to get the transparency of the filled area with
	//     respect to the background.
	// Returns:
	//     Returns an integer whose values are from 0 to 255.
	// Remarks:
	//     A value of 0 means fully transparent and 255 fully opaque
	// See Also:
	//-------------------------------------------------------------------------
	int GetTransparency() const;

	//-------------------------------------------------------------------------
	// Summary:
	//     Call this function to set the transparency of the filled area with
	//     respect to the background.
	// Parameters:
	//     nTransparency - an integer whose values are from 0 to 255.
	// Remarks:
	//     A value of 0 means fully transparent and 255 fully opaque
	// See Also:
	//-------------------------------------------------------------------------
	void SetTransparency(int nTransparency);

public:

	CXTPChartColor GetActualBackColor() const;

	CXTPChartColor GetActualConnectorColor() const;

public:
	virtual void DoPropExchange(CXTPPropExchange* pPX);

public:
	virtual CXTPChartElementView* CreateView(CXTPChartDeviceContext* pDC, CXTPChartSeriesPointView* pPointView, CXTPChartElementView* pParentView);


protected:
	CXTPChartColor m_clrTextColor;   //The text color.
	CXTPChartColor m_clrBackColor;   //The background color.
	CXTPChartColor m_clrLineColor;   //The line color.
	BOOL m_bVisible;                //TRUE if the label is visible and FALSE if not.
	CXTPChartFont* m_pFont;          //The font of the label.
	BOOL m_bAntialiasing;           //TRUE if antialiasing enabled, FLASE if not.
	BOOL m_bShowLines;              //TRUE if the lines are visible, FALSE if not.
	int m_nLineLength;              //The line length.
	CXTPChartBorder* m_pBorder;      //Chart border object.
	CXTPChartFillStyle* m_pFillStyle;
	CXTPChartNumberFormat* m_pFormat;
	int m_nTransparency;                //The transparency values range from 0 to 255.


	LPDISPATCH OleGetBorder();
	LPDISPATCH OleGetFillStyle();
	OLE_COLOR OleGetTextColor();
	void OleSetTextColor(OLE_COLOR clr);
	OLE_COLOR OleGetBackColor();
	void OleSetBackColor(OLE_COLOR clr);
	OLE_COLOR OleGetLineColor();
	void OleSetLineColor(OLE_COLOR clr);


protected:
	friend class CXTPChartSeriesStyle;
};


class _XTP_EXT_CLASS CXTPChartSeriesLabelView : public CXTPChartElementView
{
public:
	CXTPChartSeriesLabelView(CXTPChartSeriesLabel* pLabel, CXTPChartSeriesPointView* pPointView, CXTPChartElementView* pParentView);

public:
	virtual void CalculateLayout(CXTPChartDeviceContext* pDC);

	CXTPChartColor GetActualTextColor() const;
	CXTPChartColor GetActualBorderColor() const;
	CXTPChartColor GetActualConnectorColor() const;

	CXTPChartSeriesPointView* GetPointView() const;

protected:
	CXTPChartSeriesLabel* m_pLabel;
	CXTPChartSeriesPointView* m_pPointView;
};


class _XTP_EXT_CLASS CXTPChartSeriesLabelConnectorPainterBase
{
public:
	CXTPChartSeriesLabelConnectorPainterBase(CXTPChartPointF startPoint, CXTPChartPointF finishPoint, CXTPChartRectF bounds);

public:
	static CXTPChartRectF CalcBorderBoundsForTangentDrawing(const CXTPPoint3d& point, double angle, const CXTPChartSizeF& textSize, int borderThickness, CXTPChartRectF& innerBounds);

protected:
	CXTPChartPointF m_startPoint;
	CXTPChartPointF m_finishPoint;
	CXTPChartRectF m_bounds;
};

class _XTP_EXT_CLASS CXTPChartSeriesLabelLineConnectorPainter : public CXTPChartSeriesLabelConnectorPainterBase
{
public:
	CXTPChartSeriesLabelLineConnectorPainter(CXTPChartPointF startPoint, CXTPChartPointF finishPoint, double angle, CXTPChartRectF bounds);

public:
	CXTPChartDeviceCommand* CreateDeviceCommand(CXTPChartDeviceContext* pDC, CXTPChartSeriesLabel* pLabel, const CXTPChartColor& color);
protected:
	double m_angle;
};


AFX_INLINE CXTPChartElementView* CXTPChartSeriesLabel::CreateView(CXTPChartDeviceContext* pDC, CXTPChartSeriesPointView* pPointView, CXTPChartElementView* pParentView) {
	UNREFERENCED_PARAMETER(pDC);
	UNREFERENCED_PARAMETER(pPointView);
	UNREFERENCED_PARAMETER(pParentView);
	return NULL;
}

AFX_INLINE CXTPChartFont* CXTPChartSeriesLabel::GetFont() const {
	return m_pFont;
}
AFX_INLINE CXTPChartColor CXTPChartSeriesLabel::GetTextColor() const {
	return m_clrTextColor;
}
AFX_INLINE void CXTPChartSeriesLabel::SetShowLines(BOOL bShowLines) {
	m_bShowLines = bShowLines;
	OnChartChanged();
}
AFX_INLINE BOOL CXTPChartSeriesLabel::GetShowLines() const {
	return m_bShowLines;
}
AFX_INLINE int CXTPChartSeriesLabel::GetLineLength() const {
	return m_nLineLength;
}
AFX_INLINE void CXTPChartSeriesLabel::SetLineLength(int nLineLength) {
	m_nLineLength = nLineLength;
	OnChartChanged();
}
AFX_INLINE void CXTPChartSeriesLabel::SetVisible(BOOL bVisible) {
	m_bVisible = bVisible;
	OnChartChanged();
}
AFX_INLINE BOOL CXTPChartSeriesLabel::IsVisible() const {
	return m_bVisible;
}
AFX_INLINE void CXTPChartSeriesLabel::SetAntialiasing(BOOL bAntialiasing) {
	m_bAntialiasing = bAntialiasing;
	OnChartChanged();
}
AFX_INLINE  BOOL CXTPChartSeriesLabel::GetAntialiasing() const {
	return m_bAntialiasing;
}
AFX_INLINE CXTPChartNumberFormat* CXTPChartSeriesLabel::GetFormat() const {
	return m_pFormat;
}
AFX_INLINE void CXTPChartSeriesLabel::SetTextColor(const CXTPChartColor& clrTextColor) {
	m_clrTextColor = clrTextColor;
	OnChartChanged();
}
AFX_INLINE void CXTPChartSeriesLabel::SetLineColor(const CXTPChartColor& clrLineColor) {
	m_clrLineColor = clrLineColor;
	OnChartChanged();
}
AFX_INLINE void CXTPChartSeriesLabel::SetBackColor(const CXTPChartColor& clrBackColor) {
	m_clrBackColor = clrBackColor;
	OnChartChanged();
}
AFX_INLINE CXTPChartColor CXTPChartSeriesLabel::GetBackColor() const {
	return m_clrBackColor;
}
AFX_INLINE CXTPChartColor CXTPChartSeriesLabel::GetLineColor() const {
	return m_clrLineColor;
}
AFX_INLINE CXTPChartBorder* CXTPChartSeriesLabel::GetBorder() const {
	return m_pBorder;
}
AFX_INLINE CXTPChartFillStyle* CXTPChartSeriesLabel::GetFillStyle() const {
	return m_pFillStyle;
}
AFX_INLINE int CXTPChartSeriesLabel::GetTransparency() const {
	return m_nTransparency;
}
AFX_INLINE void CXTPChartSeriesLabel::SetTransparency(int nTransparency) {
	m_nTransparency = nTransparency;
	OnChartChanged();
}

#endif //#if !defined(__XTPCHARTSERIESLABEL_H__)