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

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

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

#	ifndef RT_RIBBON
#		define RT_RIBBON MAKEINTRESOURCE(28)
#	endif

class CXTPRibbonBar;
class CXTPPropExchange;
class CXTPCommandBars;
class CXTPPropExchangeXMLNode;
class CXTPRibbonGroup;
class CXTPRibbonGroup;
class CXTPRibbonTab;
class CXTPControl;

class _XTP_EXT_CLASS CXTPRibbonBuilder
{
public:
	CXTPRibbonBuilder();
	virtual ~CXTPRibbonBuilder();

public:
	BOOL LoadFromResource(UINT uiXMLResID, LPCTSTR lpszResType = RT_RIBBON,
						  HINSTANCE hInstance = NULL);

	BOOL Build(CXTPRibbonBar* pRibbonBar);

protected:
	virtual CCmdTarget* CreateElement(const CString& strElementName);

protected:
	BOOL BuildCategories(CXTPPropExchange* pPX, CXTPRibbonBar* pRibbonBar);
	BOOL BuildGroups(CXTPPropExchange* pPX, CXTPRibbonTab* pRibbonTab);
	BOOL BuildGroupControls(CXTPPropExchange* pPX, CXTPRibbonGroup* pRibbonGroup);
	void BuildControl(CXTPPropExchange* pPX, CXTPControl* pControl);
	BOOL BuildMainButton(CXTPPropExchange* pPX, CXTPRibbonBar* pRibbonBar);
	BOOL BuildMainButtonPopupBar(CXTPPropExchange* pPX, CXTPRibbonBar* pRibbonBar);
	void BuildControlPopupBar(CXTPPropExchange* pPX, CXTPControl*& pControl,
							  CRuntimeClass* pPopupBarClass);
	void BuildQATElements(CXTPPropExchange* pPX, CXTPRibbonBar* pRibbonBar);
	BOOL BuildTabElements(CXTPPropExchange* pPX, CXTPRibbonBar* pRibbonBar);

	void AddImageIndex(int nIndex, int nId, int nImageType);
	void LoadIcons(CXTPPropExchange* pPX);
	void LoadIcons(int nId, CUIntArray& arrIcons);

protected:
	CUIntArray m_arrImageSmall;
	CUIntArray m_arrImageLarge;
	CXTPCommandBars* m_pCommandBars;
	CXTPPropExchangeXMLNode* m_pPX;
};

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