The SBJ MVC Framework - The Design View, Responding to Model Change

//------------------------------------------------------------------------------
// $Workfile: CmdMsgHandler.cpp $
// $Header:  $
//
//	Copyright � 2008 SbjCat
// All rights reserved.
//
//
// *** Authors ***
//	 Steve Johnson
//
// $Revision: $
//
//-----------------------------------------------------------------------------

#include "stdafx.h"
#include "CmdMsgHandler.h"
#include "CmdTargetController.h"

#ifdef _DEBUG
#define new DEBUG_NEW
#undef THIS_FILE
static char THIS_FILE[] = __FILE__;
#endif


namespace SbjCore
{
	namespace Mvc
	{
		/////////////////////////////////////////////////////
		
		/// dtor
		CmdMsgHandler::~CmdMsgHandler()
		{
		}
		
		CmdTargetController* CmdMsgHandler::GetController() const
		{
			return static_cast<CmdTargetController*>(MessageHandler::GetController());
		}
		

		/** HandleCmd is called by the CmdTargetController's HandleCmdMsg 
			method when it determines that the message is a Command message. 
			HandleCmd calls the private pure virtual OnHandleCmd method
			which actually handles the message. See the documentation 
			for OnHandleCmd for further information.
		*/
		bool CmdMsgHandler::HandleCmd(UINT nID)
		{
			return OnHandleCmd(nID);
		}

		/** HandleCmdUI is called by the CmdTargetController's HandleCmdMsg 
			method when it determines that the message is a CmdUI message. 
			HandleCmdUI calls the private virtual OnHandleCmdUI method 
			which actually handles the message. See the documentation for 
			OnHandleCmdUI for further information.
		*/
		bool CmdMsgHandler::HandleCmdUI(CCmdUI* pCmdUI)					
		{
			return OnHandleCmdUI(pCmdUI);
		}
		
		/** HandleCmdPrev calls the previous handler's HandleCmd method.  
			This should be called from the overridden OnHandleCmd method 
			to preserve the chain of previous handlers assigned to the 
			CmdTargetController.
		
			\param pCtrlr the CmdTargetController where this handler has 
			been mapped
			\param nID the ID handled.

			\return true if message is handled
		*/
		bool CmdMsgHandler::HandleCmdPrev(UINT nID)
		{
			bool bRslt = false;
			CmdMsgHandler* pHandler = dynamic_cast<CmdMsgHandler*>(GetPrevHandler());
			if (pHandler != NULL)
			{
				bRslt = pHandler->HandleCmd(nID);
			}
			return bRslt;
		}
		
		/** HandleCmdUIPrev calls the previous handler's HandleCmdUI method.  
			This should be called from the overridden OnHandleCmdUI method 
			to preserve the chain of previous handlers assigned to the 
			CmdTargetController.

			\param pCmdUI pointer to the CCmdUI class.

			\return true if message is handled
		*/
		bool CmdMsgHandler::HandleCmdUIPrev(CCmdUI* pCmdUI)
		{
			bool bRslt = false;
			CmdMsgHandler* pHandler = dynamic_cast<CmdMsgHandler*>(GetPrevHandler());
			if (pHandler != NULL)
			{
				bRslt = pHandler->HandleCmdUI(pCmdUI);
			}
			return bRslt;
		}
		

		/////////////////////////////////////////////////
		
		/** OnHandleCmd is a private pure virtual method that must be 
			overridden in derived classes to provide the actual handling 
			of the Cmd message.  It is called by the public HandleCmd method.
		
			A call to HandleCmdPrev should be made to assure any previous 
			handlers are called. 
			
			\param nID the ID handle. In the case where a handler is mapped 
			to a series of IDs, this identifies the particular ID that is 
			being handled.
																					
			\return true if message is handled
		*/
		// SBJ 06.04.26 no implementation for a pure virtual
		// bool CmdMsgHandler::OnHandleCmd(UINT nID) = 0;
		
		

		/** OnHandleCmdUI is a private virtual method that can be overridden 
			in derived classes to provide specific behavior for the CmdUI
			message.  It is called by the public HandleCmdUI method.

			A call to HandleCmdUIPrev should be made to assure any previous 
			handlers are called. 

			\param pCmdUI pointer to the CCmdUI class. See MFC documentation
			for information on CCmdUI.

			\return true if message is handled
		*/
		bool CmdMsgHandler::OnHandleCmdUI(CCmdUI* pCmdUI)
		{
			pCmdUI->Enable(true);

			return true;
		}

			
	}
	
}

//*** Modification History ***
// $Log:  $