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

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

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

/**
 * @brief
 * XTPTabNavigateButtonFlags is an enumeration used to indicate
 * when a navigate button will be displayed. This style is
 * applied to one button. Navigate buttons include the left,
 * right, and close buttons that appear in the tab header area.
 * @details
 * If the xtpTabNavigateButtonAutomatic flag is used, then buttons will
 * only appear when needed (e.g. when there are too many tabs to be
 * displayed in the tab header, the arrow buttons will appear).
 *
 * <b>Example:</b>
 * This example code illustrates how to specify when the tab navigation
 * buttons are displayed:
 * <pre>
 * //Gets a reference to the tab manager
 * CXTPTabManager* pManager = GetManager();
 * if (pManager)
 * {
 *    //Finds the left navigation button and specifies that it is always displayed
 *    pManager->FindNavigateButton(xtpTabNavigateButtonLeft)->SetFlags(xtpTabNavigateButtonAlways);
 *    //Finds the right navigation button and specifies that it is never displayed
 *    pManager->FindNavigateButton(xtpTabNavigateButtonRight)->SetFlags(xtpTabNavigateButtonNone);
 *    //Finds the close navigation button and specifies that it is always displayed
 *    pManager->FindNavigateButton(xtpTabNavigateButtonClose)->SetFlags(xtpTabNavigateButtonAlways);
 * }
 * //Called to recalculate tab area and reposition components
 * pManager->Reposition();
 * </pre>
 * @see
 * CXTPTabManagerNavigateButton, CXTPTabManagerNavigateButton::SetFlags,
 * CXTPTabManagerNavigateButton::GetFlags,
 * xtpTabNavigateButtonNone, xtpTabNavigateButtonAutomatic, xtpTabNavigateButtonAlways
 */
enum XTPTabNavigateButtonFlags
{
	xtpTabNavigateButtonNone,	  /**< Never display the navigate button. */
	xtpTabNavigateButtonAutomatic, /**< Automatically display the navigate button. */
	xtpTabNavigateButtonAlways	 /**< Always display the navigate button. */
};

/**
 * @brief
 * XTPTabAppearanceStyle is an enumeration used to set the appearance of tabs.
 *
 * <b>Example:</b>
 * <pre>m_wndTabControl.SetAppearance(xtpTabAppearancePropertyPage2003);</pre>
 * @see
 * CXTPTabManager::SetAppearance, CXTPTabPaintManager::SetAppearance
 */
enum XTPTabAppearanceStyle
{
	xtpTabAppearancePropertyPage		 = 0, /**< Gives your tabs an Office 2000 appearance. */
	xtpTabAppearancePropertyPageSelected = 1, /**< Gives your tabs an Office 2000 selected
												 appearance. */
	xtpTabAppearancePropertyPageFlat = 2,  /**< Gives your tabs an Office 2000 Flat appearance. */
	xtpTabAppearancePropertyPage2003 = 3,  /**< Gives your tabs an Office 2003 appearance. */
	xtpTabAppearanceStateButtons	 = 4,  /**< Gives your tabs a State Button appearance. */
	xtpTabAppearanceFlat			 = 6,  /**< Gives your tabs a Flat appearance. */
	xtpTabAppearanceExcel2003		 = 7,  /**< Gives your tabs an Excel 2003 appearance. */
	xtpTabAppearanceVisio			 = 8,  /**< Gives your tabs a Visio appearance. */
	xtpTabAppearancePropertyPage2007 = 10, /**< Gives your tabs an Office 2007 appearance. */
	xtpTabAppearancePropertyPageAccess2007 = 11, /**< Gives your tabs an Office 2007 appearance. */

	xtpTabAppearanceVisualStudio2003 = 5,  /**< Gives your tabs a Visual Studio 2003 appearance. */
	xtpTabAppearanceVisualStudio2005 = 9,  /**< Gives your tabs a Visual Studio 2005 appearance. */
	xtpTabAppearanceVisualStudio2010 = 12, /**< Gives your tabs a Visual Studio 2010 appearance. */
	xtpTabAppearanceVisualStudio2012 = 13, /**< Gives your tabs a Visual Studio 2012 appearance. */
	xtpTabAppearanceVisualStudio2015 = 15, /**< Gives your tabs a Visual Studio 2015 appearance. */
	xtpTabAppearanceVisualStudio2017 = 17, /**< Gives your tabs a Visual Studio 2017 appearance. */
	xtpTabAppearanceVisualStudio2019 = 18, /**< Gives your tabs a Visual Studio 2019 appearance. */
	xtpTabAppearanceVisualStudio2022 = 19, /**< Gives your tabs a Visual Studio 2022 appearance. */

	xtpTabAppearanceOffice2013 = 14,						 /**< Office 2013 appearance. */
	xtpTabAppearanceOffice2016 = xtpTabAppearanceOffice2013, /**< Office 2016 appearance. */

	xtpTabAppearanceNativeWindows10 = 16, /**< Gives your tabs a Native Windows 10 appearance. */
	xtpTabAppearanceNativeWindows11 = 20, /**< Gives your tabs a Native Windows 11 appearance. */
};

/** @cond */
#	define xtpTabThemeExcel2003 xtpTabAppearanceExcel2003 // Old names
#	define xtpTabThemeVisualStudio2003 xtpTabAppearanceVisualStudio2003
#	define xtpTabThemeVisualStudio2005 xtpTabAppearanceVisualStudio2005
#	define xtpTabThemeVisualStudio2010 xtpTabAppearanceVisualStudio2010
#	define xtpTabThemeVisualStudio2012 xtpTabAppearanceVisualStudio2012
#	define xtpTabThemeVisualStudio2015 xtpTabAppearanceVisualStudio2015
#	define xtpTabThemeVisualStudio2017 xtpTabAppearanceVisualStudio2017
#	define xtpTabThemeVisualStudio2019 xtpTabAppearanceVisualStudio2019
#	define xtpTabThemeVisualStudio2022 xtpTabAppearanceVisualStudio2022
#	define xtpTabThemeOffice2013 xtpTabAppearanceOffice2013
#	define xtpTabAppearanceVisualStudio xtpTabAppearanceVisualStudio2003
#	define xtpTabAppearanceExcel xtpTabAppearanceExcel2003
/** @endcond */

/**
 * @brief
 * XTPTabColorStyle is an enumeration used to set the color style of tabs.
 *
 * <b>Example:</b>
 * <pre>m_wndTabControl.SetColor(xtpTabColorVisualStudio2005);</pre>
 * @see
 * CXTPTabManager::SetColor, CXTPTabPaintManager::SetColor,
 * CXTPTabManager::GetColor, CXTPTabPaintManager::GetColor
 */
enum XTPTabColorStyle
{
	xtpTabColorDefault = 0x0001,	/**< Tabs will use the default color for the currently set
									   Appearance. */
	xtpTabColorOffice2003 = 0x0004, /**< Tabs will use the Office 2003 color style for the currently
									   set Appearance. */
	xtpTabColorWinNative = 0x0008,  /**< Tabs will use the Windows XP color style for the currently
									   set Appearance. */
	xtpTabColorResource = 0x0020,   /**< Tabs will use the Office 2007 color style for the currently
									   set Appearance. */
	xtpTabColorOffice2007Access = 0x0080, /**< Tabs will use the Office 2007 Access color style for
											 the currently set Appearance. */
	xtpTabColorVisualStudio2003 = 0x0002, /**< Tabs will use the Visual Studio 2003 color style for
											 the currently set Appearance. */
	xtpTabColorVisualStudio2005 = 0x0010, /**< Tabs will use the Visual Studio 2005 color style for
											 the currently set Appearance. */
	xtpTabColorVisualStudio2008 = 0x0040, /**< Tabs will use the Visual Studio 2008 color style for
											 the currently set Appearance. */
	xtpTabColorVisualStudio2010 = 0x0100, /**< Tabs will use the Visual Studio 2010 color style for
											 the currently set Appearance. */
	xtpTabColorVisualStudio2012 = 0x0200, /**< Tabs will use the Visual Studio 2012 color style for
											 the currently set Appearance. */
	xtpTabColorVisualStudio2012Dark = 0x0400, /**< Tabs will use the Visual Studio 2012 Dark color
												 style for the currently set Appearance. */
	xtpTabColorOffice2013 = 0x0800, /**< Tabs will use the Office 2013 style for the currently set
									   Appearance. */
	xtpTabColorOffice2016 = xtpTabColorOffice2013, /**< Tabs will use the Office 2016 style for the
													  currently set Appearance. */
	xtpTabColorVisualStudio2015 = 0x1000, /**< Tabs will use the Visual Studio 2015 color style for
											 the currently set Appearance. */
	xtpTabColorNativeWindows10 = 0x2000,  /**< Tabs will use the Native Windows 10 color style for
											 the currently set Appearance. */
	xtpTabColorVisualStudio2017 = 0x4000, /**< Tabs will use the Visual Studio 2017 color style for
											 the currently set Appearance. */
	xtpTabColorVisualStudio2019 = 0x8000, /**< Tabs will use the Visual Studio 2019 color style for
											 the currently set Appearance. */
	xtpTabColorVisualStudio2022 = 0x00010000, /**< Tabs will use the Visual Studio 2022 color style
												 for the currently set Appearance. */
	xtpTabColorNativeWindows11 = 0x00020000,  /**< Tabs will use the Native Windows 11 color style
												 for the currently set Appearance. */
	xtpTabColorAll = 0xFFFFFFFF,			  /**< A mask for all tab colors. */
};

/** @cond */
#	define xtpTabColorVisualStudio                                                                \
		xtpTabColorVisualStudio2003 // obsolete names, for backward compatibility only.
#	define xtpTabColorWinXP xtpTabColorWinNative
#	define xtpTabColorWhidbey xtpTabColorVisualStudio2005
#	define xtpTabColorAccess2007 xtpTabColorOffice2007Access
#	define xtpTabColorOffice2007 xtpTabColorResource
/** @endcond */

/**
 * @brief
 * XTPTabPosition is an enumeration used to set the position of tabs.
 *
 * <b>Example:</b>
 * <pre>m_wndTabControl.SetPosition(xtpTabPositionBottom);</pre>
 * @see
 * CXTPTabManager::SetPosition, CXTPTabManager::GetPosition
 */
enum XTPTabPosition
{
	xtpTabPositionTop,	/**< Tabs will be drawn on the Top. */
	xtpTabPositionLeft,   /**< Tabs will be drawn on the Left. */
	xtpTabPositionBottom, /**< Tabs will be drawn on the Bottom. */
	xtpTabPositionRight   /**< Tabs will be drawn on the Right. */
};

/**
 * @brief
 * XTPTabLayoutStyle is an enumeration used to set the layout of tabs.
 *
 * <b>Example:</b>
 * <pre>m_wndTabControl.SetLayoutStyle(xtpTabLayoutCompressed);</pre>
 * @see
 * CXTPTabManager::SetLayoutStyle, CXTPTabManager::GetLayout
 */
enum XTPTabLayoutStyle
{
	xtpTabLayoutAutoSize, /**< Tabs will be automatically sized based on the caption and image size.
							 With this flag set, tabs will appear in their normal size. */
	xtpTabLayoutSizeToFit,  /**< Tabs are sized to fit within the tab panel. All tabs will be
							   compressed and forced to fit into the tab panel. */
	xtpTabLayoutFixed,		/**< All tabs will be set to a fixed size within the tab panel. */
	xtpTabLayoutCompressed, /**< Tabs will be compressed within the tab panel. This will compress
							   the size of the tabs, but all tabs will not be forced into the tab
							   panel. */
	xtpTabLayoutMultiRow,   /**< Causes a tab control to display multiple rows of tabs. */
	xtpTabLayoutRotated /**< Rotated tab layout (i.e. all tabs will be rotated to 90 degrees). */
};

/**
 * @brief
 * XTPTabToolTipBehaviour is an enumeration used to set the tooltip behaviour for tabs.
 *
 * <b>Example:</b>
 * <pre>m_wndTabControl.GetPaintManager()->EnableToolTips(xtpTabToolTipAlways);</pre>
 * @see
 * CXTPTabPaintManager::EnableToolTips, XTPTabLayoutStyle
 */
enum XTPTabToolTipBehaviour
{
	xtpTabToolTipNever,		  /**< Never show tooltips for tabs. */
	xtpTabToolTipAlways,	  /**< Always show tooltips for tabs. */
	xtpTabToolTipShrinkedOnly /**< Only show tooltips if the tab was shrinked (see
								 xtpTabLayoutSizeToFit layout).  */
};

/**
 * @brief
 * XTPTabOneNoteColor is an enumeration used to indicate which
 * OneNote RGB color value to retrieve.
 * @details
 * This enumerator is used by CXTPTabPaintManager::GetOneNoteColor to
 * retrieve a specified OneNote RGB color value.
 *
 * <b>Example:</b>
 * See WM_XTP_GETTABCOLOR for an example.
 * @see
 * CXTPTabPaintManager::GetOneNoteColor, CXTPTabManager::GetItemColor,
 * CXTPDockingPane::GetItemColor
 */
enum XTPTabOneNoteColor
{
	xtpTabColorBlue	= 0x1000000, /**< Blue tab color used when OneNote colors enabled. */
	xtpTabColorYellow  = 0x1000001, /**< Yellow tab color used when OneNote colors enabled. */
	xtpTabColorGreen   = 0x1000002, /**< Green tab color used when OneNote colors enabled. */
	xtpTabColorRed	 = 0x1000003, /**< Red tab color used when OneNote colors enabled. */
	xtpTabColorPurple  = 0x1000004, /**< Purple tab color used when OneNote colors enabled. */
	xtpTabColorCyan	= 0x1000005, /**< Cyan tab color used when OneNote colors enabled. */
	xtpTabColorOrange  = 0x1000006, /**< Orange tab color used when OneNote colors enabled. */
	xtpTabColorMagenta = 0x1000007  /**< Magenta tab color used when OneNote colors enabled. */
};

/**
 * @brief
 * XTPTabWorkspacePart is an enumeration used to indicate which
 * part of the MDI TabWorkspace must be redrawn.
 * @details
 * The enumerators are used by CXTPTabPaintManagerTheme::DrawWorkspacePart
 * when redrawing the MDITabClient TabWorkspace when grouping is enabled.
 * @see
 * CXTPTabPaintManagerTheme::DrawWorkspacePart
 */
enum XTPTabWorkspacePart
{
	xtpTabWorkspacePartBorder, /**< Indicates the border of the MDITabClient TabWorkspace should be
								  drawn. */
	xtpTabWorkspacePartWidth,  /**< Indicates the border width of the MDITabClient TabWorkspace
								  should be recalculated (i.e. when adding or removing a static
								  frame). */
	xtpTabWorkspacePartVSplitter, /**< Indicates the vertical splitter of the MDITabClient
									 TabWorkspace should be drawn. */
	xtpTabWorkspacePartHSplitter, /**< Indicates the horizontal splitter of the MDITabClient
									 TabWorkspace should be drawn. */
	xtpTabWorkspacePartBack /**< Indicates the background of the MDITabClient TabWorkspace should be
							   drawn. */
};

/**
 * @brief
 * XTPTabClientFrame is an enumeration used to set the client frame style
 * drawn around the client of tabs.
 *
 * <b>Example:</b>
 * <pre>m_wndTabControl.GetPaintManager()->m_clientFrame = xtpTabFrameBorder;</pre>
 * @see
 * CXTPTabManager, CXTPTabPaintManager
 */
enum XTPTabClientFrame
{
	xtpTabFrameBorder,	 /**< With this flag set, a border will appear around the client area. */
	xtpTabFrameSingleLine, /**< With this flag set, only a single line is used as a border around
							  the client area. */
	xtpTabFrameNone		   /**< With this flag set, no border will appear around the client area. */
};

/**
 * @brief
 * XTPTabNavigateButton is an enumeration used to identify
 * navigation buttons within a tab control.
 * @details
 * This enumerator is used by the CXTPTabManagerNavigateButton class to
 * identify navigation buttons.
 *
 * <b>Example:</b>
 * See XTPTabNavigateButtonFlags for an example.
 * @see
 * XTPTabNavigateButtonFlags, CXTPTabManager, CXTPTabManagerNavigateButton
 */
enum XTPTabNavigateButton
{
	xtpTabNavigateButtonLeft,		/**< Left tab navigation button. */
	xtpTabNavigateButtonRight,		/**< Right tab navigation button. */
	xtpTabNavigateButtonClose,		/**< Close tab navigation button. */
	xtpTabNavigateButtonActiveFiles /**< Active Files button (used in XTPTabClientWnd only). */
};

/**
 * @brief
 * Indicates that a transparent color should be used.
 * @details
 * If the RGB color value of an object is XTP_TABMANAGER_COLOR_NONE,
 * then this indicates that the object should not be drawn. This
 * is used in the tab appearance and color function to indicate when
 * tab borders, highlighting, shadowing, etc. should be drawn.
 *
 * Setting a member of CXTPTabPaintManagerColorSet to XTP_TABMANAGER_COLOR_NONE
 * will indicate that the member should not be drawn.
 * @see
 * CXTPTabPaintManagerColorSet
 */
const COLORREF XTP_TABMANAGER_COLOR_NONE = (COLORREF)(-1);

/**
 * @brief
 * Indicates a special "shaded" fill type.
 * @details
 * To get the "shaded" effect, the object will be filled with
 * one pixel COLOR_3DFACE, then one pixel COLOR_3DHIGHLIGHT, then
 * one pixel COLOR_3DFACE, then one pixel COLOR_3DHIGHLIGHT, and so on.
 *
 * Setting the clrLight parameter to XTP_TABMANAGER_COLOR_SHADED
 * in the used in CXTPTabPaintManagerColorSet::GradientFill
 * member will cause the object to be filled with the special shaded fill.
 * Note:
 * The special fill is used to colorize the currently selected tab
 * and within xtpTabAppearanceStateButtons to colorize the button face.
 * The special fill can be applied to any color member.
 * @see
 * CXTPTabPaintManagerColorSet::GradientFill
 */
const COLORREF XTP_TABMANAGER_COLOR_SHADED = (COLORREF)(-2);

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