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

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

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

class _XTP_EXT_CLASS CXTPRibbonBackstageTab : public CXTPControl
{
	/** @cond */
	DECLARE_XTP_CONTROL(CXTPRibbonBackstageTab)
	/** @endcond */
public:
	CWnd* GetControlPane() const;

	/**
	 * @brief
	 * Checks that keyboards tips for buttons on the pane activated by this tab do
	 * not conflict with each other. It also constructs an array of IDs for button
	 * windows on the pane and array of keyboard tips corresponding to those buttons.
	 */
	void CheckKeyboardTips();

	/**
	 * @brief
	 * Retrieves the size of the arrays created by the CheckKeyboardTips method.
	 * @return
	 * The size of the arrays.
	 * @see
	 * CheckKeyboardTips
	 */
	int GetKeyboardTipsCount() const;

	/**
	 * @brief
	 * Retrieves the character used as the keyboard tip for the button
	 * with the specified index in the m_arrKeyboardTipsIds array.
	 * @param index Index in the m_arrKeyboardTipsIds array.
	 * @return
	 * The character used as the keyboard tip for the button.
	 * @see
	 * CheckKeyboardTips
	 */
	TCHAR GetKeyboardTipChar(int index) const;

	/**
	 * @brief
	 * Simulates clicking on the button with the specified index in
	 * the m_arrKeyboardTipsIds array.
	 * @param index Index in the m_arrKeyboardTipsIds array.
	 * @see
	 * CheckKeyboardTips
	 */
	void ClickControlWithKeyboardTip(int index);

	/**
	 * @brief
	 * Shows/hides keyboard tips on the pane corresponding to this tab.
	 * @param bShow TRUE to show keyboard tips, FALSE to hide.
	 */
	void ShowKeyboardTips(BOOL bShow);

	void SetControlPaneMinSize(CSize sz);

protected:
	CXTPRibbonBackstageTab(HWND hwndControl = 0);

protected:
#	ifdef _XTP_COMMANDBARS_ACTIVEX
	/** @cond */

	DECLARE_DISPATCH_MAP()
	DECLARE_INTERFACE_MAP()
	DECLARE_OLETYPELIB_EX(CXTPRibbonBackstageTab);

/** @endcond */
#	endif
protected:
	HWND m_hwndControl;
	CSize m_szControlPaneMinSize;
	CArray<TCHAR, TCHAR> m_arrKeyboardTips;  /**< Array of keyboard tips for buttons on the pane. */
	CArray<HWND, HWND> m_arrKeyboardTipsIds; /**< Array of IDs for buttons on the pane. */

	friend class CXTPRibbonBackstageView;
};

AFX_INLINE void CXTPRibbonBackstageTab::SetControlPaneMinSize(CSize sz)
{
	m_szControlPaneMinSize = sz;
}

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