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

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

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

/**
 * @brief
 * CXTPStatusBarProgressPane is a CXTPStatusBarPane derived class.
 * CXTPStatusBarProgressPane works with CXTStatusBar and allows
 * you to create a progress bar in your status bar area.
 */
class _XTP_EXT_CLASS CXTPStatusBarProgressPane
	: public CXTPStatusBarPane
	, public CXTPProgressBase
{
	/** @cond */
	DECLARE_DYNAMIC(CXTPStatusBarProgressPane)
	/** @endcond */
public:
	/**
	 * @brief
	 * Constructs a CXTPStatusBarProgressPane object.
	 */
	CXTPStatusBarProgressPane();

	/**
	 * @brief
	 * Destroys a CXTPStatusBarProgressPane object, handles cleanup and deallocation.
	 */
	~CXTPStatusBarProgressPane();

protected:
	/**
	 * @brief
	 * This method is called to redraw the progress bar.
	 */
	virtual void RedrawProgress();

	/**
	 * @brief
	 * This method is called to retrieve a pointer to CXTPProgressPaintManager.
	 * @return Returns a pointer to CXTPProgressPaintManager
	 */
	virtual CXTPProgressPaintManager* GetProgressPaintManager() const;

	/**
	 * @brief
	 * This method is called to get the bounding rectangle of the progressbar.
	 * @return Returns the bounding rectangle of the progressbar
	 */
	virtual CRect GetProgressRect();

	/**
	 * @brief
	 * This method is called to draw a pane item. Override it to draw a custom pane.
	 * @param pDC    Pointer to a valid device context.
	 * @param rcItem Item rectangle.
	 */
	virtual void OnDraw(CDC* pDC, CRect rcItem);

public:
#	ifdef _XTP_COMMANDBARS_ACTIVEX
	/** @cond */
	DECLARE_DISPATCH_MAP()
	DECLARE_INTERFACE_MAP()
	DECLARE_OLETYPELIB_EX(CXTPStatusBarProgressPane);

	int OleGetPos();
	void OleSetPos(int nPos);
	void OleRedrawProgress();
/** @endcond */
#	endif
};

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