FH98ViewOnPlaneSoftware/Src/XtremeToolKitPro/FlowGraph/XTPFlowGraphNodeGroup.h

// XTPFlowGraphNodeGroup.h: interface for the CXTPFlowGraphNodeGroup class.
//
// This file is a part of the XTREME TOOLKIT PRO MFC class library.
// (c)1998-2012 Codejock Software, All Rights Reserved.
//
// THIS SOURCE FILE IS THE PROPERTY OF CODEJOCK SOFTWARE AND IS NOT TO BE
// RE-DISTRIBUTED BY ANY MEANS WHATSOEVER WITHOUT THE EXPRESSED WRITTEN
// CONSENT OF CODEJOCK SOFTWARE.
//
// THIS SOURCE CODE CAN ONLY BE USED UNDER THE TERMS AND CONDITIONS OUTLINED
// IN THE XTREME TOOLKIT PRO LICENSE AGREEMENT. CODEJOCK SOFTWARE GRANTS TO
// YOU (ONE SOFTWARE DEVELOPER) THE LIMITED RIGHT TO USE THIS SOFTWARE ON A
// SINGLE COMPUTER.
//
// CONTACT INFORMATION:
// support@codejock.com
// http://www.codejock.com
//
/////////////////////////////////////////////////////////////////////////////

//{{AFX_CODEJOCK_PRIVATE
#if !defined(__XTPFLOWGRAPHNODEGROUP_H__)
#define __XTPFLOWGRAPHNODEGROUP_H__
//}}AFX_CODEJOCK_PRIVATE

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

class CXTPFlowGraphPage;
class CXTPFlowGraphNodeGroups;
class CXTPFlowGraphNode;

// --------------------------------------------------------------------
//
// Summary:
//     Represents a group of nodes.
//
// Remarks:
//     A group is just a "box" that is used to visually group nodes
//     together. By default the group will only be shown when a node in
//     the group is selected, but you can choose to always show the
//     groups with ShowNodeGroupsAlways.
//
//
// --------------------------------------------------------------------
class _XTP_EXT_CLASS CXTPFlowGraphNodeGroup : public CXTPFlowGraphElement
{
	DECLARE_DYNAMIC(CXTPFlowGraphNodeGroup)
public:
	// -----------------------------------------------
	// Summary:
	//     Constructs a CXTPFlowGraphNodeGroup object.
	// -----------------------------------------------
	CXTPFlowGraphNodeGroup();
	// -----------------------------------------------------------------
	// Summary:
	//     Destroys a CXTPFlowGraphNodeGroup object, handles cleanup and
	//     deallocation.
	// -----------------------------------------------------------------
	virtual ~CXTPFlowGraphNodeGroup();

public:
	// --------------------------------------------------------
	// Summary:
	//     Adds a node to the node group.
	// Parameters:
	//     pNode :  Reference to the node to add to the group.
	// --------------------------------------------------------
	void AddNode(CXTPFlowGraphNode* pNode);
	// -------------------------------------------------------------
	// Summary:
	//     Removes a node from the node group.
	// Parameters:
	//     pNode :  Reference to the node to remove from the group.
	// -------------------------------------------------------------
	void RemoveNode(CXTPFlowGraphNode* pNode);

	// --------------------------------------
	// Summary:
	//     Removes all nodes from this group.
	// --------------------------------------
	void RemoveAll();
	// ------------------------------------------------------------------
	// Summary:
	//     Removes this group from the flow graph's collection of groups.
	// ------------------------------------------------------------------
	void Remove();

	// -----------------------------------------------------
	// Summary:
	//     Gets a reference to the parent FlowGraph control.
	// Returns:
	//     A reference to the parent FlowGraph control.
	// -----------------------------------------------------
	CXTPFlowGraphControl* GetControl() const;
	// ------------------------------------------------------------
	// Summary:
	//     Gets a reference to the page that this group belongs to.
	// Returns:
	//     A reference to the page that this group belongs to.
	// ------------------------------------------------------------
	CXTPFlowGraphPage* GetPage() const;

	// --------------------------------------------------------
	// Summary:
	//     Get the total number of nodes that are in the group.
	// Returns:
	//     The total number of nodes that are in the group.
	// --------------------------------------------------------
	int GetCount() const;
	// --------------------------------------------------------------------
	// Summary:
	//     Gets the node at the specified index from the group's collection
	//     \of nodes.
	// Parameters:
	//     nIndex :  Index of the specified node to return.
	//
	// Returns:
	//     A reference to the specified node.
	// --------------------------------------------------------------------
	CXTPFlowGraphNode* GetAt(int nIndex) const;

	// ----------------------------------------------
	// Summary:
	//     Gets the bounding rectangle for the group.
	// Returns:
	//     The bounding rectangle for the group.
	// ----------------------------------------------
	CRect GetWorkRect() const;

	// ----------------------------------------------
	// Summary:
	//     Sets the caption for the group.
	// Parameters:
	//     lpszCaption :  New caption for this group.
	// ----------------------------------------------
	void SetCaption(LPCTSTR lpszCaption);
	// -----------------------------------
	// Summary:
	//     Gets the caption for the group.
	// Returns:
	//     The caption for the group.
	// -----------------------------------
	CString GetCaption() const;

protected:

	CArray<CXTPFlowGraphNode*, CXTPFlowGraphNode*> m_arrNodes;  // Collection of nodes that are in this group.
	CXTPFlowGraphNodeGroups* m_pGroups; // Pointer to the collection of groups that this group belongs to.
	CRect m_rcWorkRect; // Rectangle displayed for this group.
	CString m_strCaption; // Caption used for this group.

	friend class CXTPFlowGraphNodeGroups;
	friend class CXTPFlowGraphPage;

};


AFX_INLINE int CXTPFlowGraphNodeGroup::GetCount() const {
	return (int)m_arrNodes.GetSize();
}
AFX_INLINE CXTPFlowGraphNode* CXTPFlowGraphNodeGroup::GetAt(int nIndex) const {
	return nIndex >= 0 && nIndex < m_arrNodes.GetSize() ? m_arrNodes[nIndex] : NULL;
}
AFX_INLINE CRect CXTPFlowGraphNodeGroup::GetWorkRect() const {
	return m_rcWorkRect;
}
AFX_INLINE void CXTPFlowGraphNodeGroup::SetCaption(LPCTSTR lpszCaption) {
	m_strCaption = lpszCaption;
}
AFX_INLINE CString CXTPFlowGraphNodeGroup::GetCaption() const {
	return m_strCaption;
}

#endif //#if !defined(__XTPFLOWGRAPHNODEGROUP_H__)