Click here to Skip to main content
15,889,838 members
Articles / Desktop Programming / WTL

Custom Tab Controls, Tabbed Frame and Tabbed MDI

Rate me:
Please Sign up or sign in to vote.
4.90/5 (144 votes)
13 Jul 200522 min read 1.6M   35.6K   395  
An extensible framework for creating customized tabs in ATL/WTL, with a VS.NET-like tab control implementation, tabbed frames, tabbed MDI, and more.
// HtmlFrame.h : interface of the CHtmlFrame class
//
/////////////////////////////////////////////////////////////////////////////

#if !defined(AFX_HtmlFrame_H__053AD675_0AE2_11D6_8BF1_00500477589F__INCLUDED_)
#define AFX_HtmlFrame_H__053AD675_0AE2_11D6_8BF1_00500477589F__INCLUDED_

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

#ifndef __WTL_TABBED_FRAME_H__
	#error HtmlFrame.h requires TabbedFrame.h to be included first
#endif

#include "ExDispid.h"

static _ATL_FUNC_INFO TitleChangeInfo = {CC_STDCALL, VT_EMPTY, 1, { VT_BSTR } };
static _ATL_FUNC_INFO NavigateComplete2Info = {CC_STDCALL, VT_EMPTY, 2, { VT_DISPATCH, (VT_BYREF | VT_VARIANT)}};
static _ATL_FUNC_INFO DocumentCompleteInfo = {CC_STDCALL, VT_EMPTY, 2, { VT_DISPATCH, (VT_BYREF | VT_VARIANT) } };

const int ID_VIEW_SOURCE = WM_USER;

// NOTE: To have the child window created maximized, uncomment the following line,
//  and comment out the line after than
//typedef CWinTraits<WS_OVERLAPPEDWINDOW | WS_CHILD | WS_VISIBLE | WS_CLIPCHILDREN | WS_CLIPSIBLINGS | WS_MAXIMIZE, WS_EX_MDICHILD>	CHtmlFrameWinTraits;
typedef CMDIChildWinTraits CHtmlFrameWinTraits;

class CHtmlFrame :
	public CTabbedFrameImpl<CHtmlFrame, CDotNetButtonTabCtrl<CTabViewTabItem>, CTabbedMDIChildWindowImpl<CHtmlFrame, CMDIWindow, CHtmlFrameWinTraits> >,
	public IDispEventSimpleImpl<0, CHtmlFrame, &DIID_DWebBrowserEvents2>
{
protected:
	typedef CTabbedFrameImpl<CHtmlFrame, CDotNetButtonTabCtrl<CTabViewTabItem>, CTabbedMDIChildWindowImpl<CHtmlFrame, CMDIWindow, CHtmlFrameWinTraits> > baseClass;
	typedef CHtmlFrame thisClass;

public:
	DECLARE_FRAME_WND_CLASS(NULL, IDR_MDICHILD)

	CTabbedMDICommandBarCtrl* m_pCmdBar;

	CHtmlView m_HtmlView;
	CPlainTextView m_HtmlSourceView;

	int m_nHtmlViewTabIndex;
	int m_nHtmlSourceViewTabIndex;

	CComPtr<IUnknown> m_punkBrowser;

	CHtmlFrame() :
		m_pCmdBar(NULL),
		m_nHtmlViewTabIndex(-1),
		m_nHtmlSourceViewTabIndex(-1)
	{
	}

	virtual void OnFinalMessage(HWND /*hWnd*/)
	{
		delete this;
	}

	void SetCommandBarCtrlForContextMenu(CTabbedMDICommandBarCtrl* pCmdBar)
	{
		m_pCmdBar = pCmdBar;
	}

	BEGIN_MSG_MAP(CHtmlFrame)
		MESSAGE_HANDLER(WM_CREATE, OnCreate)
		MESSAGE_HANDLER(WM_DESTROY, OnDestroy)
		MESSAGE_HANDLER(WM_SETTINGCHANGE, OnSettingChange)
		MESSAGE_HANDLER(WM_FORWARDMSG, OnForwardMsg)
		MESSAGE_HANDLER(UWM_MDICHILDSHOWTABCONTEXTMENU, OnShowTabContextMenu)
		COMMAND_ID_HANDLER(ID_FILE_SAVE, OnFileSave)
		COMMAND_ID_HANDLER(ID_FILE_CLOSE, OnFileClose)
		COMMAND_ID_HANDLER(ID_VIEW_SOURCE, OnViewSource)

		CHAIN_MSG_MAP(baseClass)
	END_MSG_MAP()

// Handler prototypes (uncomment arguments if needed):
//	LRESULT MessageHandler(UINT /*uMsg*/, WPARAM /*wParam*/, LPARAM /*lParam*/, BOOL& /*bHandled*/)
//	LRESULT CommandHandler(WORD /*wNotifyCode*/, WORD /*wID*/, HWND /*hWndCtl*/, BOOL& /*bHandled*/)
//	LRESULT NotifyHandler(int /*idCtrl*/, LPNMHDR /*pnmh*/, BOOL& /*bHandled*/)

	LRESULT OnCreate(UINT uMsg, WPARAM wParam, LPARAM lParam, BOOL& bHandled)
	{
		LRESULT lRet = DefWindowProc(uMsg, wParam, lParam);
		bHandled = TRUE;

		CreateTabWindow(m_hWnd, rcDefault, (CTCS_BOTTOM | CTCS_TOOLTIPS | CTCS_HOTTRACK));

		m_HtmlView.Create(m_hWnd, rcDefault, _T("http://www.microsoft.com"), WS_CHILD | WS_VISIBLE | WS_CLIPSIBLINGS | WS_CLIPCHILDREN | WS_HSCROLL | WS_VSCROLL, WS_EX_CLIENTEDGE);
		m_HtmlSourceView.Create(m_hWnd, rcDefault, NULL, WS_CHILD | WS_VISIBLE | WS_CLIPSIBLINGS | WS_CLIPCHILDREN | WS_HSCROLL | WS_VSCROLL | ES_AUTOHSCROLL | ES_AUTOVSCROLL | ES_MULTILINE | ES_NOHIDESEL, WS_EX_CLIENTEDGE);

		m_nHtmlViewTabIndex =        this->AddTab(m_HtmlView,       _T("HTML"));
		m_nHtmlSourceViewTabIndex =  this->AddTab(m_HtmlSourceView, _T("Source"));

		// NOTE: You can mark a tab item to be highlighted like the following:
		//  (its meant to work similar to TCM_HIGHLIGHTITEM for regular tab controls)
		//this->GetTabCtrl().GetItem(1)->SetHighlighted(true);

		this->UpdateTabToolTip(m_HtmlView, _T("View the Rendered HTML"));
		this->UpdateTabToolTip(m_HtmlSourceView, _T("View the HTML Source"));

		m_HtmlView.get_Control(&m_punkBrowser);
		if(m_punkBrowser)
		{
			DispEventAdvise(m_punkBrowser, &DIID_DWebBrowserEvents2);
		}

		return lRet;
	}

	LRESULT OnDestroy(UINT /*uMsg*/, WPARAM /*wParam*/, LPARAM /*lParam*/, BOOL& bHandled)
	{
		if(m_punkBrowser)
		{
			DispEventUnadvise(m_punkBrowser, &DIID_DWebBrowserEvents2);
		}

		// Let anybody else see this that wants to
		bHandled = FALSE;
		return 0;
	}

	LRESULT OnSettingChange(UINT uMsg, WPARAM wParam, LPARAM lParam, BOOL& /*bHandled*/)
	{
		// System settings or metrics have changed.  Propogate this message
		// to all the child windows so they can update themselves as appropriate.
		this->SendMessageToDescendants(uMsg, wParam, lParam, TRUE);

		return 0;
	}

	LRESULT OnForwardMsg(UINT /*uMsg*/, WPARAM /*wParam*/, LPARAM lParam, BOOL& /*bHandled*/)
	{
		LPMSG pMsg = (LPMSG)lParam;

		if(baseClass::PreTranslateMessage(pMsg))
			return TRUE;

		int nActiveTab = this->GetTabCtrl().GetCurSel();
		if(nActiveTab == m_nHtmlViewTabIndex)
		{
			return m_HtmlView.PreTranslateMessage(pMsg);
		}
		else if(nActiveTab == m_nHtmlSourceViewTabIndex)
		{
			return m_HtmlSourceView.PreTranslateMessage(pMsg);
		}

		return FALSE;
	}

	LRESULT OnShowTabContextMenu(UINT /*uMsg*/, WPARAM /*wParam*/, LPARAM lParam, BOOL& bHandled)
	{
		bHandled = TRUE;

		POINT ptPopup = {GET_X_LPARAM(lParam), GET_Y_LPARAM(lParam)};

		// Build up the menu to show
		CMenu mnuContext;

		// Load from resource
		//mnuContext.LoadMenu(IDR_CONTEXT);

		// or build dynamically
		// (being sure to enable/disable menu items as appropriate,
		// and giving the appropriate IDs)
		if(mnuContext.CreatePopupMenu())
		{
			int cchWindowText = this->GetWindowTextLength();
			CString sWindowText;
			this->GetWindowText(sWindowText.GetBuffer(cchWindowText+1), cchWindowText+1);
			sWindowText.ReleaseBuffer();

			CString sSave(_T("&Save '"));
			sSave += sWindowText;
			sSave += _T("'");

			mnuContext.AppendMenu((MF_ENABLED | MF_STRING), ID_FILE_SAVE, sSave);
			mnuContext.AppendMenu((MF_ENABLED | MF_STRING), ID_FILE_CLOSE, _T("&Close\tCtrl+F4"));
			mnuContext.AppendMenu(MF_SEPARATOR);
			mnuContext.AppendMenu((MF_ENABLED | MF_STRING), ID_VIEW_SOURCE, _T("&View Source"));

			if(m_pCmdBar != NULL)
			{
				// NOTE: The CommandBarCtrl in our case is the mainframe's, so the commands
				//  would actually go to the main frame if we don't specify TPM_RETURNCMD.
				//  In the main frame's message map, if we don't specify
				//  CHAIN_MDI_CHILD_COMMANDS, we are not going to see those command
				//  messages. We have 2 choices here - either specify TPM_RETURNCMD,
				//  then send/post the message to our window, or don't specify
				//  TPM_RETURNCMD, and be sure to have CHAIN_MDI_CHILD_COMMANDS
				//  in the main frame's message map.

				//m_pCmdBar->TrackPopupMenu(mnuContext, TPM_LEFTALIGN | TPM_RIGHTBUTTON | TPM_TOPALIGN | TPM_VERTICAL,
				//	ptPopup.x, ptPopup.y);

				DWORD nSelection = m_pCmdBar->TrackPopupMenu(mnuContext, TPM_LEFTALIGN | TPM_RIGHTBUTTON | TPM_TOPALIGN | TPM_VERTICAL | TPM_RETURNCMD,
					ptPopup.x, ptPopup.y);
				if(nSelection != 0)
				{
					this->PostMessage(WM_COMMAND, MAKEWPARAM(nSelection, 0));
				}
			}
			else
			{
				mnuContext.TrackPopupMenuEx(TPM_LEFTALIGN | TPM_RIGHTBUTTON | TPM_TOPALIGN | TPM_VERTICAL,
					ptPopup.x, ptPopup.y, m_hWnd, NULL);
			}
		}

		return 0;
	}

	LRESULT OnFileSave(WORD /*wNotifyCode*/, WORD /*wID*/, HWND /*hWndCtl*/, BOOL& /*bHandled*/)
	{
		this->MessageBox(_T("OnFileSave"));
		return 0;
	}

	LRESULT OnFileClose(WORD /*wNotifyCode*/, WORD /*wID*/, HWND /*hWndCtl*/, BOOL& /*bHandled*/)
	{
		this->PostMessage(WM_SYSCOMMAND, SC_CLOSE, 0L);
		return 0;
	}

	LRESULT OnViewSource(WORD /*wNotifyCode*/, WORD /*wID*/, HWND /*hWndCtl*/, BOOL& /*bHandled*/)
	{
		this->DisplayTab(m_HtmlSourceView, FALSE);
		return 0;
	}

public:
	BEGIN_SINK_MAP(CHtmlFrame)
		SINK_ENTRY_INFO(0, DIID_DWebBrowserEvents2, DISPID_TITLECHANGE, &OnTitleChange, &TitleChangeInfo)
		SINK_ENTRY_INFO(0, DIID_DWebBrowserEvents2, DISPID_NAVIGATECOMPLETE2, &OnNavigateComplete2, &NavigateComplete2Info)
		SINK_ENTRY_INFO(0, DIID_DWebBrowserEvents2, DISPID_DOCUMENTCOMPLETE, &OnDocumentComplete, &DocumentCompleteInfo)
	END_SINK_MAP()

	void __stdcall OnTitleChange(BSTR sTitle)
	{
		USES_CONVERSION;
		baseClass::SetTitle(OLE2CT(sTitle));
	}

	void __stdcall OnNavigateComplete2(IDispatch* pDisp, VARIANT* /*vtURL*/)
	{
		HRESULT hr = S_OK;
		CComQIPtr<IWebBrowser2> pBrowser(pDisp);
		if(pBrowser)
		{
			//CComPtr<IHTMLDocument> pDocument;
			CComPtr<IDispatch> pDocument;
			hr = pBrowser->get_Document(&pDocument);

			CComQIPtr<IHTMLDocument2> pHtmlDocument(pDocument);
			if(pHtmlDocument)
			{
				CComPtr<IHTMLLocation> pHtmlLocation;
				pHtmlDocument->get_location(&pHtmlLocation);
				if(pHtmlLocation)
				{
					CComBSTR sHref;
					pHtmlLocation->get_href(&sHref);
					if(sHref.Length() > 0)
					{
						USES_CONVERSION;
						baseClass::SetTabToolTip(OLE2CT(sHref));
					}
				}
			}
		}
	}

	void __stdcall OnDocumentComplete(IDispatch* pDisp, VARIANT* /*vtURL*/)
	{
		HRESULT hr = S_OK;
		CComQIPtr<IWebBrowser2> pBrowser(pDisp);
		if(pBrowser)
		{
			//CComPtr<IHTMLDocument> pDocument;
			CComPtr<IDispatch> pDocument;
			hr = pBrowser->get_Document(&pDocument);

			CComQIPtr<IPersistStreamInit> pPersistStreamInit(pDocument);
			if(pPersistStreamInit)
			{
				ULARGE_INTEGER cbSize = {0};
				pPersistStreamInit->GetSizeMax(&cbSize);

				HGLOBAL hGlobal = ::GlobalAlloc(GHND, (DWORD)cbSize.QuadPart);

				if(hGlobal != NULL)
				{
					CComPtr<IStream> pStream;
					hr = ::CreateStreamOnHGlobal(hGlobal, FALSE, &pStream);
					if(pStream)
					{
						hr = pPersistStreamInit->Save(pStream, TRUE);

						// TODO: Figure out the character encoding,
						//  and translate to LPTSTR
						LPVOID sText = ::GlobalLock(hGlobal);
						SIZE_T cbText = ::GlobalSize(hGlobal);
						cbText; // avoid warning on level 4

						::SetWindowTextA(m_HtmlSourceView, (LPSTR)sText);

						::GlobalUnlock(hGlobal);
					}

					::GlobalFree(hGlobal);
				}
			}

			// We could do this if forwarding the focus didn't work
			// due to getting called too early.
			/*
			CComQIPtr<IHTMLDocument2> htmlDocument2(pDocument);
			if(htmlDocument2)
			{
				CComPtr<IHTMLWindow2> parentWindow;
				htmlDocument2->get_parentWindow(&parentWindow);
				if(parentWindow)
				{
					parentWindow->focus();
				}
			}
			*/
		}
	}
};

/////////////////////////////////////////////////////////////////////////////

//{{AFX_INSERT_LOCATION}}
// Microsoft Visual C++ will insert additional declarations immediately before the previous line.

#endif // !defined(AFX_HtmlFrame_H__053AD675_0AE2_11D6_8BF1_00500477589F__INCLUDED_)

By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.

If a file you wish to view isn't highlighted, and is a text file (not binary), please let us know and we'll add colourisation support for it.

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here


Written By
Architect
United States United States
Daniel Bowen used to work as a Software Engineer for Evans & Sutherland in Salt Lake City, Utah working on the modeling tools for high end flight simulators. He then worked for the startup company WiLife Inc. in Draper, Utah working on the software portion of an easy to use and affordable digital video surveillance system. WiLife Inc. is now part of Logitech Inc.

Comments and Discussions