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

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

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

class CXTPMarkupUIElement;

/**
 * @brief
 * CXTPMarkupUIElementCollection is a CXTPMarkupCollection derived class.
 * It implements a basic collection of CXTPMarkupUIElement elements.
 */
class _XTP_EXT_CLASS CXTPMarkupUIElementCollection : public CXTPMarkupCollection
{
public:
	/**
	 * @brief
	 * Constructs a CXTPMarkupUIElementCollection object.
	 */
	CXTPMarkupUIElementCollection();

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

public:
	/**
	 * @brief
	 * Retrieves a CXTPMarkupUIElement object by its index.
	 * @param nIndex Index of the CXTPMarkupUIElement object to retrieve.
	 * @return
	 * A pointer to the CXTPMarkupUIElement object.
	 */
	CXTPMarkupUIElement* GetItem(int nIndex) const;

protected:
	/**
	 * @brief
	 * This method is called when the collection is changed.
	 */
	void OnChanged();

protected:
	/** @cond */
public:
	DECLARE_DISPATCH_MAP()
#	ifdef _XTP_ACTIVEX
	DECLARE_INTERFACE_MAP()
	DECLARE_OLETYPELIB_EX(CXTPMarkupUIElementCollection);
#	endif

	DECLARE_ENUM_VARIANT(CXTPMarkupUIElementCollection);

	long OleGetItemCount();
	LPDISPATCH OleGetItem(long nIndex);
	void OleAdd(LPDISPATCH lpElementDisp);
	void OleInsert(long Index, LPDISPATCH lpElementDisp);
	/** @endcond */
};

AFX_INLINE CXTPMarkupUIElement* CXTPMarkupUIElementCollection::GetItem(int nIndex) const
{
	return nIndex >= 0 && nIndex < m_arrItems.GetSize() ? (CXTPMarkupUIElement*)m_arrItems[nIndex]
														: NULL;
}

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