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

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

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

class CXTPDockingPaneSplitterContainer;
class CXTPDockingPaneLayout;

/**
 * @brief
 * CXTPDockingPaneSplitterWnd is a CWnd derived class. It is
 * used internally for splitting Panes.
 */
class _XTP_EXT_CLASS CXTPDockingPaneSplitterWnd : public CWnd
{
protected:
	/**
	 * @brief
	 * Constructs a CXTPDockingPaneSplitterWnd object.
	 */
	CXTPDockingPaneSplitterWnd();

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

public:
	/**
	 * @brief
	 * Determines if the splitter orientation is horizontal.
	 * @return
	 * TRUE if the splitter orientation is horizontal.
	 */
	BOOL IsHorizontal() const;

	/**
	 * @brief
	 * Creates a CXTPDockingPaneSplitterWnd window.
	 * @param pContainer Pointer to a parent CXTPDockingPaneSplitterContainer object.
	 * @param pFirst     Pointer to a first splitting CXTPDockingPaneBase object.
	 * @param pSecond    Pointer to a second splitting CXTPDockingPaneBase object.
	 */
	void Create(CXTPDockingPaneSplitterContainer* pContainer, CXTPDockingPaneBase* pFirst,
				CXTPDockingPaneBase* pSecond);

	/**
	 * @brief
	 * Creates a CXTPDockingPaneSplitterWnd window.
	 * @param pManager Pointer to a parent CXTPDockingPaneManager object.
	 * @param bHoriz   TRUE if the splitter orientation should be horizontal.
	 */
	void Create(CXTPDockingPaneManager* pManager, BOOL bHoriz);

	/**
	 * @brief
	 * Retrieves the associated splitter container of a splitter window.
	 * @return
	 * A pointer to the associated splitter container of a splitter window.
	 */
	CXTPDockingPaneSplitterContainer* GetContainer() const;

	/**
	 * @brief
	 * Retrieves a pointer to the docking pane manager.
	 * @return
	 * A pointer to the docking pane manager.
	 */
	CXTPDockingPaneManager* GetDockingPaneManager() const;

	/**
	 * @brief
	 * Call this member function to retrieve a pointer to the docking splitter
	 * base pane.
	 * @param bFirst TRUE to retrieve a pointer to the first base pane in the group,
	 * otherwise retrieves a pointer to the second pane.
	 * @return
	 * A CXTPDockingPaneBase object.
	 */
	CXTPDockingPaneBase* GetPaneBase(BOOL bFirst = TRUE);

	/**
	 * @brief
	 * Call this member to determine the XTPDockingPaneDirection of the splitter.
	 * @return
	 * The current XTPDockingPaneDirection of the splitter.
	 */
	XTPDockingPaneDirection GetPaneDirection() const
	{
		return m_iDirection;
	}

protected:
	/** @cond */
	DECLARE_MESSAGE_MAP()

	//{{AFX_MSG(CXTPDockingPaneSplitterWnd)
	afx_msg void OnLButtonDown(UINT nFlags, CPoint point);
	afx_msg void OnPaint();
	afx_msg LRESULT OnPrintClient(WPARAM wParam, LPARAM /*lParam*/);
	afx_msg BOOL OnEraseBkgnd(CDC* pDC);
	afx_msg BOOL OnSetCursor(CWnd* pWnd, UINT nHitTest, UINT message);
	//}}AFX_MSG
	/** @endcond */

private:
	void Reposition(CRect rc, CRect rcAvail);
	BOOL Create(LPCTSTR lpszClassName, LPCTSTR lpszWindowName, DWORD dwStyle, const RECT& rect,
				CWnd* pParentWnd, UINT nID, CCreateContext* pContext = NULL);
	BOOL GetAvailableRect(CRect& rcAvail, CRect& rcUnion);

private:
	CXTPDockingPaneSplitterContainer* m_pContainer;
	CXTPDockingPaneBase* m_pFirst;
	CXTPDockingPaneBase* m_pSecond;
	CXTPDockingPaneManager* m_pManager;
	HCURSOR m_hCursor;
	BOOL m_bHoriz;
	XTPDockingPaneDirection m_iDirection;

private:
	friend class CXTPDockingPaneSplitterContainer;
	friend class CXTPDockingPaneLayout;
};

AFX_INLINE CXTPDockingPaneSplitterContainer* CXTPDockingPaneSplitterWnd::GetContainer() const
{
	return m_pContainer;
}

/**
 * @brief
 * CXTPDockingPaneSplitterContainer is a CXTPDockingPaneBase derived class.
 * It is used internally as a splitter container for CXTPDockingPaneBase
 * derived classes.
 */
class _XTP_EXT_CLASS CXTPDockingPaneSplitterContainer
	: public CXTPCmdTarget
	, public CXTPDockingPaneBaseContainer
{
protected:
	/**
	 * @brief
	 * Constructs a CXTPDockingPaneSplitterContainer object.
	 * @param pLayout Pointer to a CXTPDockingPaneLayout object.
	 */
	CXTPDockingPaneSplitterContainer(CXTPDockingPaneLayout* pLayout);

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

public:
	/**
	 * @brief
	 * This method is called to set the position of the pane.
	 * @param pParent Pointer to a CWnd object.
	 * @param rect    Rectangle of the pane to be set.
	 * @param lParam  Pointer to an AFX_SIZEPARENTPARAMS structure.
	 */
	virtual void OnSizeParent(CWnd* pParent, CRect rect, LPVOID lParam);

	/**
	 * @brief
	 * Call this member to retrieve a collection of the panes with a
	 * specified type within the splitter container's child panes.
	 * @param type  Type of panes to find.
	 * @param pList Pointer to a CXTPDockingPaneBaseList object that will
	 * contain found panes.
	 */
	void FindChildPane(XTPDockingPaneType type, CXTPDockingPaneBaseList* pList) const;

	/**
	 * @brief
	 * Call this member to determine if the splitter orientation is
	 * horizontal.
	 * @return
	 * TRUE if the splitter orientation is horizontal, otherwise FALSE.
	 */
	BOOL IsHoriz() const
	{
		return m_bHoriz;
	}

	/**
	 * @brief
	 * Call this member to fill the pMinMaxInfo structure with the
	 * minimum and maximum width and height of the splitter container.
	 * This will look at the MinMaxInfo for each pane in the splitter
	 * container and set the appropriate minimum and maximum width
	 * and height for the splitter container.
	 * @param pMinMaxInfo Pointer to a MINMAXINFO structure.
	 */
	void GetMinMaxInfo(LPMINMAXINFO pMinMaxInfo) const;

protected:
	/**
	 * @brief
	 * Constructs a CXTPDockingPaneSplitterContainer object
	 * Protected constructor. Internally constructed only.
	 * @param pPane  Child pane.
	 * @param bHoriz TRUE if the splitter orientation should be horizontal.
	 * @param pFrame Parent Frame.
	 */
	void Init(CXTPDockingPaneBase* pPane, BOOL bHoriz, CWnd* pFrame);

	/**
	 * @brief
	 * Copies a CXTPDockingPaneSplitterContainer object.
	 * @param pClone  Pointer to a CXTPDockingPaneSplitterContainer object.
	 * @param pMap Pointer to a CXTPPaneToPaneMap object.
	 * @param dwIgnoredOptions Options that must be skipped.
	 * @see
	 * CXTPPaneToPaneMap
	 */
	void Copy(CXTPDockingPaneBase* pClone, CXTPPaneToPaneMap* pMap, DWORD dwIgnoredOptions);

	/**
	 * @brief
	 * This member is called by the framework when a splitter
	 * container is created.
	 * @return
	 * A pointer to the newly created CXTPDockingPaneSplitterWnd object.
	 */
	virtual CXTPDockingPaneSplitterWnd* OnCreateSplitter();

protected:
	/**
	 * @brief
	 * This member is called to remove a pane from the collection.
	 * @param pPane Pointer to a CXTPDockingPaneBase object.
	 */
	virtual void RemovePane(CXTPDockingPaneBase* pPane);

	/**
	 * @brief
	 * This member is called when a child pane collection is changed.
	 * @param pContainer Pointer to a CXTPDockingPaneBase object.
	 */
	virtual void OnChildContainerChanged(CXTPDockingPaneBase* pContainer);

	/**
	 * @brief
	 * This member is called when the parent pane collection is changed.
	 * @param pContainer Pointer to a CXTPDockingPaneBase object.
	 */
	virtual void OnParentContainerChanged(CXTPDockingPaneBase* pContainer);

	/**
	 * @brief
	 * This member is called to save/restore the settings of the pane.
	 * @param pPX Pointer to a CXTPPropExchange object.
	 * @return
	 * TRUE if successful, otherwise FALSE.
	 */
	virtual BOOL DoPropExchange(CXTPPropExchange* pPX);

	/**
	 * @brief
	 * This member is called to normalize the size of docking panes
	 * in the splitter container. Normalizing the size of the panes
	 * means that the value of the left coordinate is less than the
	 * right and the top is less than the bottom.
	 */
	void NormalizeDockingSize();

	/**
	 * @brief
	 * This method is called to the destroy the pane.
	 */
	void DeletePane();

#	ifdef _XTP_ACTIVEX
	/** @cond */
private:
	DECLARE_DISPATCH_MAP()
	DECLARE_OLETYPELIB_EX(CXTPDockingPaneSplitterContainer);
	DECLARE_ENUM_VARIANT(CXTPDockingPaneSplitterContainer);
	DECLARE_INTERFACE_MAP()

	LPDISPATCH OleGetDispatch(BOOL /*bAddRef*/);
	afx_msg LPDISPATCH OleGetItem(int nIndex);
	afx_msg int OleGetItemCount();
	afx_msg LPDISPATCH OleGetContainer();
	afx_msg int OleGetType();
	afx_msg LPDISPATCH OleGetPane(int nIndex);
	afx_msg HWND OleGetHwnd();
	afx_msg BOOL OleIsEmpty();
	afx_msg int OleGetPosition();
/** @endcond */
#	endif

private:
	void _Replace(CXTPDockingPaneBase* pPane, CXTPDockingPaneBase* pReplace);
	void _InsertPane(CXTPDockingPaneBase* pPane, CXTPDockingPaneBase* pNeighbour = NULL,
					 BOOL bAfter = TRUE);
	void _UpdateSplitters();
	BOOL _Before(const CXTPDockingPaneBase* pPane, POSITION pos) const;
	CRect _CalculateResultDockingRectSelf(CXTPDockingPaneBase* pPane,
										  XTPDockingPaneDirection direction,
										  CXTPDockingPaneBase* pNeighbour);
	static CRect AFX_CDECL _CalculateResultDockingRectChild(CXTPDockingPaneBase* pSplitter,
															CXTPDockingPaneBase* pPane,
															XTPDockingPaneDirection direction);
	static CRect AFX_CDECL _CalculateResultDockingRect(BOOL bHoriz, CXTPDockingPaneBaseList& lst,
													   CRect rect, CXTPDockingPaneBase* pPaneI);
	static void AFX_CDECL _AdjustPanesLength(CXTPDockingPaneManager* pManager,
											 CXTPDockingPaneBaseList& lst, CRect rect, BOOL bHoriz,
											 BOOL bApply, int& nTotalLength, int& nLengthAvail);
	static LONG& AFX_CDECL GetMinSize(LPMINMAXINFO pMinMaxInfo, BOOL bHoriz);
	static LONG& AFX_CDECL GetMaxSize(LPMINMAXINFO pMinMaxInfo, BOOL bHoriz);

protected:
	CList<CXTPDockingPaneSplitterWnd*, CXTPDockingPaneSplitterWnd*> m_lstSpliters; /**< List of
																					  splitter
																					  windows. */
	BOOL m_bHoriz;		  /**< TRUE if the splitter orientation is horizontal. */
	BOOL m_bRecalcLayout; /**< TRUE if RecalcLayout method currently executed. */

private:
	friend class CXTPDockingPaneManager;
	friend class CXTPDockingPaneSplitterWnd;
	friend class CXTPDockingPaneMiniWnd;
	friend class CXTPDockingPaneLayout;
};

AFX_INLINE BOOL CXTPDockingPaneSplitterWnd::Create(LPCTSTR lpszClassName, LPCTSTR lpszWindowName,
												   DWORD dwStyle, const RECT& rect,
												   CWnd* pParentWnd, UINT nID,
												   CCreateContext* pContext)
{
	return CWnd::Create(lpszClassName, lpszWindowName, dwStyle, rect, pParentWnd, nID, pContext);
}
AFX_INLINE LONG& CXTPDockingPaneSplitterContainer::GetMinSize(LPMINMAXINFO pMinMaxInfo, BOOL bHoriz)
{
	return bHoriz ? pMinMaxInfo->ptMinTrackSize.x : pMinMaxInfo->ptMinTrackSize.y;
}
AFX_INLINE LONG& CXTPDockingPaneSplitterContainer::GetMaxSize(LPMINMAXINFO pMinMaxInfo, BOOL bHoriz)
{
	return bHoriz ? pMinMaxInfo->ptMaxTrackSize.x : pMinMaxInfo->ptMaxTrackSize.y;
}
/** @cond */
#	include "Common/Base/Diagnostic/XTPEnableNoisyWarnings.h"
#endif // #if !defined(__XTPDOCKINGPANESPLITTERCONTAINER_H__)
	   /** @endcond */