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

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

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

class CXTPDockingPane;
class CXTPDockingPaneBase;
class CXTPDockingPaneBase;

/**
 * @brief
 * Docking direction enumeration.
 *
 * <b>Example:</b>
 * <pre>
 * CXTPDockingPane* pwndPane1 = GetDockingPaneManager()->CreatePane(
 * IDR_PANE1, CRect(0, 0, 200, 120), xtpPaneDockTop);
 * </pre>
 * @see
 * CXTPDockingPaneManager::CreatePane, CXTPDockingPaneManager,
 * xtpPaneDockLeft, xtpPaneDockRight, xtpPaneDockTop, xtpPaneDockBottom
 */
enum XTPDockingPaneDirection
{
	xtpPaneDockUndefined = -1, /**< Docking pane direction is unspecified.				*/
	xtpPaneDockLeft,		   /**< To dock the pane to the left of the pane or frame.	*/
	xtpPaneDockRight,		   /**< To dock the pane to the right of the pane or frame.	*/
	xtpPaneDockTop,			   /**< To dock the pane to the top of the pane or frame.	*/
	xtpPaneDockBottom,		   /**< To dock the pane to the bottom of the pane or frame.*/
	xtpPaneDockMiniWnd		   /**< Docking pane is floating mini-frame window.			*/
};

/**
 * @brief
 * Docking pane type.
 *
 * <b>Example:</b>
 * <pre>
 * if (pPane->GetType() == xtpPaneTypeDockingPane)
 * {
 *    // This is CXTPDockingPane object
 * }
 * </pre>
 * @see
 * CXTPDockingPaneBase::GetType, CXTPDockingPaneBase,
 * xtpPaneTypeDockingPane, xtpPaneTypeTabbedContainer, xtpPaneTypeSplitterContainer,
 * xtpPaneTypeMiniWnd, xtpPaneTypeClient, xtpPaneTypeAutoHidePanel
 */
enum XTPDockingPaneType
{
	xtpPaneTypeDockingPane,		  /**< Object is the docking pane.				*/
	xtpPaneTypeTabbedContainer,   /**< Object is the tabbed container.			*/
	xtpPaneTypeSplitterContainer, /**< Object is the splitter container.		*/
	xtpPaneTypeMiniWnd,			  /**< Object is the mini-window container.		*/
	xtpPaneTypeClient,			  /**< Object is the pane contained client area.*/
	xtpPaneTypeAutoHidePanel,	 /**< Object is the auto-hide panel.			*/
	xtpPaneTypeSidePanel		  /**< Object is the side panel.				*/
};

/**
 * @brief
 * Visual theme enumeration.
 *
 * <b>Example:</b>
 * <pre>m_paneManager.SetTheme(xtpPaneThemeVisualStudio2005Beta1);</pre>
 * @see
 * CXTPDockingPaneManager, CXTPDockingPaneManager::SetTheme,
 * xtpPaneThemeDefault, xtpPaneThemeVisualStudio2003, xtpPaneThemeGrippered,
 * xtpPaneThemeOffice2002Visio, xtpPaneThemeCustom, xtpPaneThemeOffice2003, xtpPaneThemeWinNative,
 * xtpPaneThemeVisualStudio2005Beta1
 */
enum XTPDockingPanePaintTheme
{
	xtpPaneThemeDefault,							 /**< Default theme.				   */
	xtpPaneThemeVisualStudio2003,					 /**< Visual Studio 2003 theme.		   */
	xtpPaneThemeOffice2003,							 /**< Office 2003 theme.			   */
	xtpPaneThemeWinNative,							 /**< Windows Native theme.			   */
	xtpPaneThemeGrippered,							 /**< Gripper theme.				   */
	xtpPaneThemeOffice2002Visio,					 /**< Office 2002 Visio theme.		   */
	xtpPaneThemeVisualStudio2005Beta1,				 /**< Visual Studio 2005 Beta 1 theme. */
	xtpPaneThemeOffice2003Outlook,					 /**< Office 2003 Outlook theme.	   */
	xtpPaneThemeWinExplorer,						 /**< Windows Explorer theme.		   */
	xtpPaneThemeVisualStudio2005,					 /**< Visual Studio 2005 theme.		   */
	xtpPaneThemeResource,							 /**< Office 2007/2010 theme.		   */
	xtpPaneThemeOffice2007Word,						 /**< Office 2007 Word theme.		   */
	xtpPaneThemeOffice2007Outlook,					 /**< Office 2007 Outlook theme.	   */
	xtpPaneThemeVisualStudio6,						 /**< Visual Studio 6 theme.		   */
	xtpPaneThemeVisualStudio2005Beta2,				 /**< Visual Studio 2005 Beta 2 theme. */
	xtpPaneThemeVisualStudio2008,					 /**< Visual Studio 2008 theme.		   */
	xtpPaneThemeVisualStudio2010,					 /**< Visual Studio 2010 theme.		   */
	xtpPaneThemeOffice2003Visio,					 /**< Office 2003 Visio theme.		   */
	xtpPaneThemeOffice2007Visio,					 /**< Office 2007 Visio theme.		   */
	xtpPaneThemeOffice2013,							 /**< Office 2013 pane theme.		   */
	xtpPaneThemeOffice2016 = xtpPaneThemeOffice2013, /**< Office 2016 pane theme.		   */
	xtpPaneThemeVisualStudio2012,					 /**< Visual Studio 2012 theme.		   */
	xtpPaneThemeVisualStudio2015,					 /**< Visual Studio 2015 theme.		   */
	xtpPaneThemeCustom,								 /**< Custom User Defined Theme.	   */
	xtpPaneThemeNativeWindows10,					 /**< Native Windows 10 theme.		   */
	xtpPaneThemeVisualStudio2017,					 /**< Visual Studio 2017 theme.		   */
	xtpPaneThemeVisualStudio2019,					 /**< Visual Studio 2019 theme.		   */
	xtpPaneThemeVisualStudio2022,					 /**< Visual Studio 2022 theme.		   */
	xtpPaneThemeNativeWindows11,					 /**< Native Windows 11 theme.		   */
};

/** @cond */
#	define xtpPaneThemeOffice                                                                     \
		xtpPaneThemeVisualStudio2003 // obsolete names, for backward compatibility only.
#	define xtpPaneThemeNativeWinXP xtpPaneThemeWinNative
#	define xtpPaneThemeExplorer xtpPaneThemeWinExplorer
#	define xtpPaneThemeVisio xtpPaneThemeOffice2002Visio
#	define xtpPaneThemeWhidbey xtpPaneThemeVisualStudio2005Beta1
#	define xtpPaneThemeShortcutBar2003 xtpPaneThemeOffice2003Outlook
#	define xtpPaneThemeWord2007 xtpPaneThemeOffice2007Word
#	define xtpPaneThemeOutlook2007 xtpPaneThemeOffice2007Outlook
#	define xtpPaneThemeOffice2007 xtpPaneThemeResource
/** @endcond */

/**
 * @brief
 * Docking Panes sticker style enumeration.
 *
 * <b>Example:</b>
 * <pre>m_paneManager.SetStickerStyle(xtpPaneStickerStyleVisualStudio2005);</pre>
 *
 * @see xtpPaneStickerStyleVisualStudio2005Beta, xtpPaneStickerStyleVisualStudio2005>
 */
enum XTPDockingContextStickerStyle
{
	xtpPaneStickerStyleVisualStudio2005Beta,	  /**< Visual Studio 2005 Beta stickers.	   */
	xtpPaneStickerStyleVisualStudio2005,		  /**< Visual Studio 2005 stickers.			   */
	xtpPaneStickerStyleVisualStudio2008,		  /**< Visual Studio 2008 stickers.			   */
	xtpPaneStickerStyleVisualStudio2010,		  /**< Visual Studio 2010 stickers.			   */
	xtpPaneStickerStyleVisualStudio2012Light,	 /**< Visual Studio 2012 light stickers.	   */
	xtpPaneStickerStyleVisualStudio2012Dark,	  /**< Visual Studio 2012 dark stickers.	   */
	xtpPaneStickerStyleVisualStudio2015Light,	 /**< Visual Studio 2015 light stickers.	   */
	xtpPaneStickerStyleVisualStudio2015Blue,	  /**< Visual Studio 2015 blue stickers.	   */
	xtpPaneStickerStyleVisualStudio2015Dark,	  /**< Visual Studio 2015 dark stickers.	   */
	xtpPaneStickerStyleVisualStudio2017Light,	 /**< Visual Studio 2017 light stickers.	   */
	xtpPaneStickerStyleVisualStudio2017Blue,	  /**< Visual Studio 2017 blue stickers.	   */
	xtpPaneStickerStyleVisualStudio2017BlueExtra, /**< Visual Studio 2017 blue extra stickers. */
	xtpPaneStickerStyleVisualStudio2017Dark,	  /**< Visual Studio 2017 dark stickers.	   */
	xtpPaneStickerStyleVisualStudio2019Light,	 /**< Visual Studio 2019 light stickers.	   */
	xtpPaneStickerStyleVisualStudio2019Blue,	  /**< Visual Studio 2019 blue stickers.	   */
	xtpPaneStickerStyleVisualStudio2019BlueExtra, /**< Visual Studio 2019 blue extra stickers. */
	xtpPaneStickerStyleVisualStudio2019Dark,	  /**< Visual Studio 2019 dark stickers.	   */
	xtpPaneStickerStyleVisualStudio2022Light,	 /**< Visual Studio 2022 light stickers.	   */
	xtpPaneStickerStyleVisualStudio2022Blue,	  /**< Visual Studio 2022 blue stickers.	   */
	xtpPaneStickerStyleVisualStudio2022BlueExtra, /**< Visual Studio 2022 blue extra stickers. */
	xtpPaneStickerStyleVisualStudio2022Dark,	  /**< Visual Studio 2022 dark stickers.	   */
	xtpPaneStickerStyleNativeWindows10Light,	  /**< Native Windows 10 light stickers.	   */
	xtpPaneStickerStyleNativeWindows10Dark,		  /**< Native Windows 10 dark stickers.		   */
	xtpPaneStickerStyleNativeWindows11Light,	  /**< Native Windows 11 light stickers.	   */
	xtpPaneStickerStyleNativeWindows11Dark,		  /**< Native Windows 11 dark stickers.		   */
};

/** @cond */
#	define xtpPaneStickerStyleWhidbey                                                             \
		xtpPaneStickerStyleVisualStudio2005Beta // obsolete name, for backward compatibility only.
/** @endcond */

/**
 * @brief
 * Docking Pane Options enumeration.
 *
 * <b>Example:</b>
 * <pre>
 * // Remove Hide button for all panes
 * m_paneManager.SetDefaultPaneOptions(xtpPaneNoHideable);
 * // Remove close button for pPane
 * pPane->SetOptions(xtpPaneNoCloseable);
 * </pre>
 * @see
 * CXTPDockingPaneManager::SetDefaultPaneOptions, CXTPDockingPane::SetOptions,
 * xtpPaneNoCloseable, xtpPaneNoHideable, xtpPaneNoFloatable, xtpPaneNoCaption
 */
enum XTPDockingPaneOptions
{
	xtpPaneNoCloseable				   = 1,  /**< A Pane can't be closed.	*/
	xtpPaneNoHideable				   = 2,  /**< A Pane can't be hidden.	*/
	xtpPaneNoFloatable				   = 4,  /**< A Pane can't be floated.*/
	xtpPaneNoCaption				   = 8,  /**< A Pane has no caption.	*/
	xtpPaneHasMenuButton			   = 16, /**< A Pane has menu button.	*/
	xtpPaneNoDockable				   = 32, /**< A Pane can't be docked.	*/
	xtpPaneNoFloatableByTabDoubleClick = 64, /**< A Pane can't be floated by a double-click on the
												tab button. */
	xtpPaneNoFloatableByCaptionDoubleClick = 128, /**< Pane can't be floated by a double-click on
													 the pane caption. */
	xtpPaneNoHoverShow = 1024 /**< A pane won't be shown on hoverusing a mouse. */
};

/**
 * @brief
 * Docking Pane Caption direction enumeration.
 *
 * <b>Example:</b>
 * <pre>
 * m_paneManager.SetCaptionDirection(xtpPaneCaptionAutoBySize);
 * </pre>
 * @see
 * CXTPDockingPaneManager::SetCaptionDirection,
 * xtpPaneCaptionHorizontal, xtpPaneCaptionVertical, xtpPaneCaptionAutoByPosition,
 * xtpPaneCaptionAutoBySize
 */
enum XTPDockingPaneCaptionDirection
{
	xtpPaneCaptionHorizontal,	 /**< Show caption on top.	*/
	xtpPaneCaptionVertical,		  /**< Show caption on left.*/
	xtpPaneCaptionAutoByPosition, /**< Automatically.		*/
	xtpPaneCaptionAutoBySize	  /**< Automatically.		*/
};

/**
 * @brief
 * Actions a docking pane is currently performing.
 *
 * <b>Example:</b>
 * <pre>
 * BEGIN_MESSAGE_MAP(CMainFrame, CFrameWnd)
 * ON_MESSAGE(XTPWM_DOCKINGPANE_NOTIFY, OnDockingPaneNotify)
 * END_MESSAGE_MAP()
 *
 * LRESULT CMainFrame::OnDockingPaneNotify(WPARAM wParam, LPARAM lParam)
 * {
 *    if (wParam == XTP_DPN_ACTION)
 *    {
 *       XTP_DOCKINGPANE_ACTION* pAction = (XTP_DOCKINGPANE_ACTION*)lParam;
 *       TRACE("Action %i\n", pAction->action);
 *       return TRUE;
 *    }
 *    return FALSE;
 * }
 * </pre>
 * @see
 * XTP_DOCKINGPANE_ACTION, XTP_DPN_ACTION,
 * xtpPaneActionFloating, xtpPaneActionFloated, xtpPaneActionClosing, xtpPaneActionClosed,
 * xtpPaneActionDocking, xtpPaneActionDocked, xtpPaneActionAttaching, xtpPaneActionAttached,
 * xtpPaneActionPinning, xtpPaneActionPinned, xtpPaneActionCollapsing, xtpPaneActionCollapsed,
 * xtpPaneActionExpanding, xtpPaneActionExpanded
 */
enum XTPDockingPaneAction
{
	xtpPaneActionFloating, /**< Docking pane is currently floating. This occurs when the user clicks
								on the title bar of a docking pane and drags the pane to another
								location. When this occurs, the pane is said to be "floating." */
	xtpPaneActionFloated,  /**< Docking pane has been docked, and is currently floating. */
	xtpPaneActionClosing,  /**< Docking pane is currently closing. This occurs when the close button
							  of the pane is clicked. */
	xtpPaneActionClosed,   /**< Docking pane has been closed. This occurs when the docking pane has
							  finished closing. */
	xtpPaneActionDocking,  /**< Docking pane is in the process of docking. */
	xtpPaneActionDocked,   /**< Docking pane has been docked. This occurs when the docking pane has
							  finished docking. */
	xtpPaneActionAttaching, /**< Docking pane is in the process of attaching to another pane.*/
	xtpPaneActionAttached,  /**< Docking pane has been attached. This occurs when the docking pane
							   has finished attaching to another pane. */
	xtpPaneActionPinning,   /**< Docking pane is currently pinning (hiding). This occurs when the
							   "pin" button is clicked. */
	xtpPaneActionPinned,	/**< Docking pane has been pinned. This occurs when the docking pane has
							   finished pinning. */
	xtpPaneActionCollapsing, /**< Docking pane is currently collapsing (hiding). This occurs when
								  pane is going back to its auto-hide position. If a pane is hidden
								  and the mouse is positioned over the tab to display the pane, then
								  the pane is expanding. When the mouse is moved off of the pane, it
								  begins to collapse. */
	xtpPaneActionCollapsed,  /**< Docking Pane has been collapsed. This occurs when the docking pane
								has finished collapsing. */
	xtpPaneActionExpanding,  /**< Docking pane is currently expanding. This occurs when a pane is
								  being displayed from its auto-hide position. If a pane is hidden
								and  the mouse is positioned over the tab to display the pane, then
								the  pane is expanding. When the mouse is moved off of the pane, it
								begins  to collapse. */
	xtpPaneActionExpanded,  /**< Docking pane is expanded; this is when the pane is fully shown from
							   the auto-hide position. */
	xtpPaneActionActivated, /**< Docking pane activated.*/
	xtpPaneActionDeactivated, /**< Docking pane deactivated.*/
	xtpPaneActionDetaching,   /**< Docking pane is being removed from tabbed container.*/
	xtpPaneActionDragging,	/**< Docking pane is being dragged.*/
	xtpPaneActionUnpinning, /**< Docking pane is currently docked. This occurs when the "pin" button
							   is clicked. */
	xtpPaneActionUnpinned,  /**< Docking pane has been unpinned. This occurs when the docking pane
							   has finished pinning. */
	xtpPaneActionSplitterResizing, /**< Docking pane splitter resizing. */
	xtpPaneActionSplitterResized   /**< Docking pane splitter resized. */
};

/**
 * @brief
 * Enable options of the pane.
 */
enum XTPDockingPaneEnableOptions
{
	xtpPaneDisabled		 = 0,	/**< Pane is disabled.*/
	xtpPaneEnableClient  = 1,	/**< Client is enabled.*/
	xtpPaneEnableActions = 2,	/**< All actions are enabled.*/
	xtpPaneEnabled		 = 3,	/**< Pane is enabled. */
	xtpPaneEnabledAuto   = 4 + 3 /**< Pane is automatically enabled. */
};

/**
 * @brief
 * Keyboard options indicates which key can be used to navigate panes.
 *
 * <b>Example:</b>
 * <pre>
 * m_paneManager.EnableKeyboardNavigate(xtpPaneKeyboardUseAll);
 * </pre>
 * @see
 * CXTPDockingPaneManager::EnableKeyboardNavigate
 */
enum XTPDockingPaneKeyboardNavigate
{
	xtpPaneKeyboardUnused	  = 0, /**< Don't use the keyboard.*/
	xtpPaneKeyboardUseAltMinus = 1, /**< To use Alt+'-' to show the context menu.*/
	xtpPaneKeyboardUseAltF6	= 2, /**< To use Alt+F6 to select the next pane.*/
	xtpPaneKeyboardUseAltF7	= 4, /**< To use Alt+F7 to show the window select dialog.*/
	xtpPaneKeyboardUseCtrlTab  = 8, /**< To use Ctrl+Tab to show the window select dialog.*/
	xtpPaneKeyboardUseAll	  = 15 /**< To use all keys.*/
};

/**
 * @brief
 * XTPDockingPaneStickerType is an enumeration that is used to indicate
 * which docking stickers are to be drawn on the screen when a
 * docking pane is dragged.
 * @details
 * m_bUseAlphaContext must be TRUE to display docking stickers.
 * @see
 * CXTPDockingPaneContext::CreateNewSticker,
 * CXTPDockingPaneContextStickerWnd::m_typeSticker,
 * CXTPDockingPaneContextStickerWnd::m_selectedSticker,
 * xtpPaneStickerNone, xtpPaneStickerLeft, xtpPaneStickerRight, xtpPaneStickerTop,
 * xtpPaneStickerBottom, xtpPaneStickerCenter, xtpPaneStickerClient, xtpPaneStickerPane
 */
enum XTPDockingPaneStickerType
{
	xtpPaneStickerNone = 0,  /**< No docking stickers are displayed. */
	xtpPaneStickerLeft = 1,  /**< Display the docking sticker indicating the pane can be docked to
								the left. */
	xtpPaneStickerRight = 2, /**< Display the docking sticker indicating the pane can be docked to
								the right. */
	xtpPaneStickerTop = 4, /**< Display the docking sticker indicating the pane can be docked on the
							  top. */
	xtpPaneStickerBottom = 8,  /**< Display the docking sticker indicating the pane can be docked on
								  the bottom. */
	xtpPaneStickerCenter = 16, /**< Display the docking sticker indicating the pane can be docked in
								  the center. */
	xtpPaneStickerClient = 32  /**< Display the left, top, bottom, and right docking stickers on
								  client frame. */
};

/**
 * @brief
 * The XTP_DOCKINGPANE_CLICK structure contains information about the
 * pane that was used in an XTP_DPN_PANEMENUCLICK message.
 * @see
 * XTP_DPN_PANEMENUCLICK
 */
struct XTP_DOCKINGPANE_CLICK
{
	CXTPDockingPane* pPane;			 /**< Docking Pane pointer. */
	CXTPDockingPaneBase* pContainer; /**< Docking Pane container. */
	CPoint pt;						 /**< Mouse pointer. */
	CRect rcExclude;				 /**< Exclude rectangle. */
};

/**
 * @brief
 * The XTP_DOCKINGPANE_ACTION structure contains information about the
 * action performed by the user with docking panes.
 *
 * <b>Example:</b>
 * <pre>
 * LRESULT CMainFrame::OnDockingPaneNotify(WPARAM wParam, LPARAM lParam)
 * {
 *    if (wParam == XTP_DPN_ACTION)
 *    {
 *       XTP_DOCKINGPANE_ACTION* pAction = (XTP_DOCKINGPANE_ACTION*)lParam;
 *       TRACE("Action %i\n", pAction->action);
 *       return TRUE;
 *    }
 *    return FALSE;
 * }
 * </pre>
 * @see
 * XTP_DPN_ACTION, XTPDockingPaneAction
 */
struct XTP_DOCKINGPANE_ACTION
{
	/** @cond */
	XTP_DOCKINGPANE_ACTION(XTPDockingPaneAction _action)
	{
		pPane		   = NULL;
		pDockContainer = NULL;
		action		   = _action;
		bCancel		   = FALSE;
		dockDirection  = xtpPaneDockUndefined;
	}
	/** @endcond */

	XTPDockingPaneAction action; /**< Current action the pane is performing. */
	BOOL bCancel;				 /**< If TRUE, then the current action will be ignored/canceled. */
	CXTPDockingPane* pPane;		 /**< Pane performing the action. */
	CXTPDockingPaneBase* pDockContainer;   /**< Container of the xtpPaneActionDocking action. */
	XTPDockingPaneDirection dockDirection; /**< The direction that the pane is trying to dock, if
											  any. */
};

/**
 * @brief
 * Internal structure used by the Layout manager.
 * @see
 * CXTPDockingPaneLayout
 */
struct XTP_DOCKINGPANE_INFO
{
	/** @cond */
	XTP_DOCKINGPANE_INFO(CXTPDockingPane* p = NULL)
	{
		pPane		= p;
		pLastHolder = pDockingHolder = pFloatingHolder = 0;
	}

	operator CXTPDockingPane*()
	{
		return pPane;
	}
	CXTPDockingPane* operator->()
	{
		return pPane;
	}
	/** @endcond */

	CXTPDockingPane* pPane;				  /**< Docking Pane. */
	CXTPDockingPaneBase* pFloatingHolder; /**< Last floating holder of the pane. */
	CXTPDockingPaneBase* pDockingHolder;  /**< Last docking holder of the pane. */
	CXTPDockingPaneBase* pLastHolder; /**< Last holder (must be pFloatingHolder or pDockingHolder).
									   */
};

/**
 * @brief
 * This list is used by the CXTPDockingPaneTabbedContainer class for
 * maintaining a CXTPDockingPane collection.
 * @see
 * CXTPDockingPaneTabbedContainer::GetPanes
 */
typedef CList<CXTPDockingPane*, CXTPDockingPane*> CXTPDockingPaneList;

/**
 * @brief
 * This list is used for maintaining a CXTPDockingPaneBase collection.
 * @see
 * CXTPDockingPaneBase::FindPane, CXTPDockingPaneAutoHidePanel::GetPanes
 */
typedef CList<CXTPDockingPaneBase*, CXTPDockingPaneBase*> CXTPDockingPaneBaseList;

/**
 * @brief
 * This list is used by the CXTPDockingPaneLayout class for
 * maintaining an XTP_DOCKINGPANE_INFO collection.
 * @see
 * CXTPDockingPaneLayout::GetPaneList, CXTPDockingPaneManager::GetPaneList
 */
typedef CList<XTP_DOCKINGPANE_INFO, XTP_DOCKINGPANE_INFO&> CXTPDockingPaneInfoList;

/**
 * @brief
 * This map is used for mapping CXTPDockingPaneBase objects.
 *
 * <b>Example:</b>
 * <pre>
 * CXTPDockingPaneBase* CXTPDockingPaneBase::Clone(
 * CXTPDockingPaneLayout* pLayout,
 * CXTPPaneToPaneMap* pMap,
 * DWORD dwIgnoredOptions)
 * {
 *    _ASSERTE(pMap);
 *    CXTPDockingPaneBase* pClone = new CXTPDockingPaneBase(m_type, pLayout);
 *    pMap->SetAt(this, pClone);
 *    return pClone;
 * }
 * </pre>
 * @see
 * CXTPDockingPaneBase::Clone, CXTPDockingPane::Clone
 */
typedef CMap<CXTPDockingPaneBase*, CXTPDockingPaneBase*, CXTPDockingPaneBase*, CXTPDockingPaneBase*>
	CXTPPaneToPaneMap;

/**
 * @brief
 * This map is used for mapping index to CXTPDockingPaneBase objects.
 */
typedef CMap<int, int, CXTPDockingPaneBase*, CXTPDockingPaneBase*> CXTPPaneIndexToPaneMap;

/**
 * @brief
 * Base for all docking pane messages.
 */
const UINT WM_XTP_DOCKINGPANE_BASE = (WM_USER + 9900);

/**
 * @brief
 * The XTPWM_DOCKINGPANE_NOTIFY message is sent to the Docking Pane Manager
 * owner window whenever an action occurs within the DockingPanes.
 * @details
 * The XTPWM_DOCKINGPANE_NOTIFY notification message is sent to inform the
 * owner window that an action occured within the DockingPanes.
 * The owner window of the color picker receives this notification
 * through the WM_COMMAND message.
 *
 * <pre>XTPWM_DOCKINGPANE_NOTIFY
 * CXTPDockingPane* pPane = (CXTPDockingPane*)lParam; // pointer to an CXTPDockingPane object
 * </pre>
 *
 * wParam can be one of the following:
 * <b>XTP_DPN_SHOWWINDOW</b>: The docking pane is just a virtual container
 * for a user window. The best place to associate
 * them is after the pane becomes visible because,
 * initially, it can be created, closed, hidden,
 * or as a non-active tab. You can create your user
 * window in this handler.
 * Process this message to attach an existing window
 * to the Docking Pane container using the Attach
 * member function.
 * <b>XTP_DPN_RCLICK</b>: User pressed the right mouse button on the docking pane
 * container.
 * <b>XTP_DPN_CLOSEPANE</b>: User closed the Pane. You can return
 * <b>XTP_ACTION_NOCLOSE</b> while processing the
 * <b>XTP_DPN_CLOSEPANE</b> notification to disable
 * closing docking pane windows.
 * <b>XTP_DPN_ACTION</b>: Extended action occurred (see XTPDockingPaneAction).
 * <b>XTP_DPN_CONTEXTMENU</b>: User pressed the menu button or right clicked to
 * show the context menu.
 *
 * @param pPane The value of lParam points to a CXTPDockingPane object that becomes
 * visible. For XTP_DPN_SHOWWINDOW, this pointer should <b>never</b> be NULL.
 *
 *
 * <b>Example:</b>
 * Here is an example of how an application would process the XTPWM_DOCKINGPANE_NOTIFY
 * message:
 * <pre>
 * BEGIN_MESSAGE_MAP(CMainFrame, CFrameWnd)
 * ON_MESSAGE(XTPWM_DOCKINGPANE_NOTIFY, OnDockingPaneNotify)
 * END_MESSAGE_MAP()
 *
 * LRESULT CMainFrame::OnDockingPaneNotify(WPARAM wParam, LPARAM lParam)
 * {
 *    switch ((int)wParam)
 *    {
 *       case XTP_DPN_SHOWWINDOW:
 *       {
 *          CXTPDockingPane* pPane = (CXTPDockingPane*)lParam;
 *
 *          // check if the Pane hasn't been attached yet.
 *          if (!pPane->IsValid())
 *          {
 *             // check if the user window hasn't been created.
 *             if (!m_wndPane.m_hWnd)
 *             {
 *                // create it.
 *                m_wndPane.CreateEx(WS_EX_STATICEDGE, _T("EDIT"), _T(""),
 *                WS_CHILD | ES_AUTOVSCROLL | ES_MULTILINE,
 *                CRect(0, 0, 200, 120), this, 0);
 *             }
 *          // attach it to the Pane.
 *          pPane->Attach(&m_wndPane);
 *          }
 *          return TRUE;
 *       }
 *          case XTP_DPN_CLOSEPANE:
 *       {
 *       // Disable the user from closing docking panes.
 *       return XTP_ACTION_NOCLOSE;
 *       }
 *    }
 *
 *    return FALSE;
 * }
 * </pre>
 * @return
 * TRUE if the application should process this message, otherwise FALSE.
 */
#	define XTPWM_DOCKINGPANE_NOTIFY (WM_XTP_DOCKINGPANE_BASE + 1)

const int XTP_DPN_SHOWWINDOW  = 1;  /**<  @see XTPWM_DOCKINGPANE_NOTIFY */
const int XTP_DPN_RCLICK	  = 2;  /**<  @see XTPWM_DOCKINGPANE_NOTIFY */
const int XTP_DPN_CLOSEPANE   = 3;  /**<  @see  XTPWM_DOCKINGPANE_NOTIFY */
const int XTP_DPN_ACTION	  = 4;  /**<  @see  XTPWM_DOCKINGPANE_NOTIFY */
const int XTP_DPN_CONTEXTMENU = 5;  /**<  @see  XTPWM_DOCKINGPANE_NOTIFY */
const int XTP_ACTION_NOCLOSE  = -1; /**< @see  XTPWM_DOCKINGPANE_NOTIFY */

/** @cond */

// Obsolete

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