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

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

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

class CXTPMarkupInputElement;
class CXTPMarkupContext;

enum XTPMarkupFocusNavigationDirection
{
	xtpMarkupFocusNavigationDirectionNext,
	xtpMarkupFocusNavigationDirectionPrevious,
	xtpMarkupFocusNavigationDirectionFirst,
	xtpMarkupFocusNavigationDirectionLast,
	xtpMarkupFocusNavigationDirectionLeft,
	xtpMarkupFocusNavigationDirectionRight,
	xtpMarkupFocusNavigationDirectionUp,
	xtpMarkupFocusNavigationDirectionDown
};

enum XTPMarkupKeyboardNavigationMode
{
	xtpMarkupKeyboardNavigationContinue,
	xtpMarkupKeyboardNavigationOnce,
	xtpMarkupKeyboardNavigationCycle,
	xtpMarkupKeyboardNavigationNone,
	xtpMarkupKeyboardNavigationContained,
	xtpMarkupKeyboardNavigationLocal
};

class _XTP_EXT_CLASS CXTPMarkupKeyboardNavigation : public CXTPMarkupObject
{
	/** @cond */
	DECLARE_MARKUPCLASS(CXTPMarkupKeyboardNavigation)
	/** @endcond */
protected:
	CXTPMarkupKeyboardNavigation(CXTPMarkupContext* pContext = NULL);
	virtual ~CXTPMarkupKeyboardNavigation();

public:
	static XTPMarkupKeyboardNavigationMode AFX_CDECL GetTabNavigation(CXTPMarkupObject* pElement);

public:
	static CXTPMarkupObject* AFX_CDECL
		ConvertKeyboardNavigationMode(CXTPMarkupBuilder* pBuilder, CXTPMarkupObject* pObject,
									  CXTPMarkupDependencyProperty* pAssociatedProperty = NULL);

public:
	void ProcessInput(UINT nChar);
	void Focus(CXTPMarkupInputElement* pInputElement);

protected:
	BOOL OnWndMsg(UINT message, WPARAM wParam, LPARAM lParam, LRESULT* pResult);

protected:
	void Navigate(CXTPMarkupInputElement* pSourceElement, UINT nChar);
	void Navigate(CXTPMarkupInputElement* pSourceElement,
				  XTPMarkupFocusNavigationDirection direction);

private:
	CXTPMarkupObject* GetGroupParent(CXTPMarkupObject* e, BOOL bIncludeCurrent = FALSE);
	CXTPMarkupObject* GetParent(CXTPMarkupObject* e);
	BOOL IsInNavigationTree(CXTPMarkupObject* pVisual);
	XTPMarkupKeyboardNavigationMode GetKeyNavigationMode(CXTPMarkupObject* pElement);
	BOOL IsGroup(CXTPMarkupObject* e);
	CXTPMarkupObject* GetNextTab(CXTPMarkupObject* e, CXTPMarkupObject* pContainer,
								 BOOL goDownOnly);
	BOOL IsTabStop(CXTPMarkupObject* e);
	CXTPMarkupObject* GetTabOnceActiveElement(CXTPMarkupObject* d);
	CXTPMarkupObject* GetActiveElement(CXTPMarkupObject* d);
	CXTPMarkupObject* GetNextTabInGroup(CXTPMarkupObject* e, CXTPMarkupObject* container,
										XTPMarkupKeyboardNavigationMode tabbingType);
	CXTPMarkupObject* GetFirstTabInGroup(CXTPMarkupObject* container);
	BOOL IsTabStopOrGroup(CXTPMarkupObject* e);
	CXTPMarkupObject* GetNextInTree(CXTPMarkupObject* e, CXTPMarkupObject* container);
	CXTPMarkupObject* GetNextTabWithSameIndex(CXTPMarkupObject* e, CXTPMarkupObject* container);
	CXTPMarkupObject* GetNextTabWithNextIndex(CXTPMarkupObject* e, CXTPMarkupObject* container,
											  XTPMarkupKeyboardNavigationMode tabbingType);
	int GetTabIndexHelper(CXTPMarkupObject* d);
	CXTPMarkupObject* FocusedElement(CXTPMarkupObject* e);

	CXTPMarkupObject* GetTreeFirstChild(CXTPMarkupObject* e);
	CXTPMarkupObject* GetTreeNextSibling(CXTPMarkupObject* e);

public:
	static CXTPMarkupDependencyProperty* m_pIsTabStopProperty;
	static CXTPMarkupDependencyProperty* m_pTabNavigationProperty;
	static CXTPMarkupDependencyProperty* m_pTabIndexProperty;

protected:
	CXTPMarkupInputElement* m_pFocused;
	CXTPMarkupInputElement* m_pLastFocused;
	CXTPMarkupContext* m_pMarkupContext;
	CXTPMarkupDependencyProperty* m_pNavigationProperty;

private:
	friend class CXTPMarkupContext;
};

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