Click here to Skip to main content
Click here to Skip to main content
Add your own
alternative version

The Mini Shell Extension Framework – Part III

, 18 Sep 2005
Discussion of a small C++ framework to create Windows shell extensions (IShellFolderImpl).
msf091.zip
include
columnprovider.rgs
contextmenu.rgs
contextmenu_sf.rgs
extension.rgs
extractimage_sf.rgs
infotip.rgs
infotip_sf.rgs
propertysheetext.rgs
propertysheetext_sf.rgs
shell32missing.def
shell32missing.lib
shellfolder.rgs
shellfolderwin98.rgs
vvvsample
Copy of sample1.vvv
menuicon.bmp
sample.def
sample.manifest
sample1.vvv
vvv.ico
vvvtest
sample.yyy
sample1.vvv
sample2.vvv
//
// (C) Copyright by Victor Derks <vba64@xs4all.nl>
//
// See README.TXT for the details of the software licence.
//
#pragma once


#include "cfhandler.h"
#include "enumformatetc.h"
#include "formatetc.h"
#include "dataobjectptr.h"
#include "cfperformeddropeffecthandler.h"


namespace MSF
{

template <typename T>
class CShellFolderDataObjectImpl : public IDataObject
{
public:
	typedef std::vector<CCfHandler*> CCfHandlers;
	typedef std::vector<CFormatEtc>  CFormatEtcs;


	CShellFolderDataObjectImpl() throw()
	{
		ATLTRACE2(atlTraceCOM, 0, _T("CShellFolderDataObjectImpl::CShellFolderDataObjectImpl (instance=%p)\n"), this);
	}


	~CShellFolderDataObjectImpl() throw()
	{
		ATLTRACE2(atlTraceCOM, 0, _T("CShellFolderDataObjectImpl::~CShellFolderDataObjectImpl (instance=%p)\n"), this);

		for_each(m_cfhandlers, CDeleteObject());
	}


	void Init(const ITEMIDLIST* pidlFolder, UINT cidl, const ITEMIDLIST** ppidl,
		IPerformedDropEffectSink* pperformeddropeffectsink = NULL)
	{
		m_pidldata =
			static_cast<IDataObject*>(CIDLData_CreateFromIDArray(pidlFolder, cidl, ppidl));

		RegisterCfHandler(auto_ptr<CCfHandler>(new CCfPerformedDropEffectHandler(pperformeddropeffectsink, this)));
	}


	void RegisterCfHandler(std::auto_ptr<CCfHandler> qcfhandler)
	{
		ATLASSERT(FindCfHandler(qcfhandler->GetClipFormat()) == NULL && "cannot register twice!");
		m_cfhandlers.push_back(qcfhandler.get());
		qcfhandler.release();
	}


	STDMETHOD(GetData)(FORMATETC* pformatetc, STGMEDIUM* pstgmedium)
	{
		ATLTRACE2(atlTraceCOM, 0, _T("CShellFolderDataObjectImpl::GetData cfformat=%d (%s)\n"), 
			pformatetc->cfFormat, GetClipboardFormatName(pformatetc->cfFormat).GetString());

		try
		{
			CCfHandler* pcfhandler = FindCfHandler(pformatetc->cfFormat);
			if (pcfhandler != NULL)
			{
				if (pcfhandler->CanGetData())
				{
					RaiseExceptionIfFailed(pcfhandler->Validate(*pformatetc));
					pcfhandler->GetData(*pformatetc, *pstgmedium);
					return S_OK;
				}
			}
			else
			{
				HRESULT hr = m_pidldata->GetData(pformatetc, pstgmedium);
				if (FAILED(hr))
				{
					ATLTRACE2(atlTraceCOM, 0, _T("CClipboardDataObjectImpl::GetData (pidldata failes)\n"));
				}

				return hr;
			}

			ATLTRACE2(atlTraceCOM, 0, _T("CClipboardDataObjectImpl::GetData (DV_E_FORMATETC)\n"));
			return DV_E_FORMATETC;
		}
		MSF_COM_CATCH_HANDLER()
	}


	STDMETHOD(GetDataHere)(FORMATETC* pformatetc, STGMEDIUM* pmedium)
	{
		ATLTRACE2(atlTraceCOM, 0, _T("CShellFolderDataObjectImpl::GetDataHere (instance=%p)\n"), this);

		return m_pidldata->GetDataHere(pformatetc, pmedium);
	}


	STDMETHOD(QueryGetData)(FORMATETC* pformatetc)
	{
		ATLTRACE2(atlTraceCOM, 0, _T("CShellFolderDataObjectImpl::QueryGetData, cfformat=%d (%s)\n"),
			pformatetc->cfFormat, GetClipboardFormatName(pformatetc->cfFormat).GetString());

		try
		{
			const CCfHandler* pcfhandler = FindCfHandler(pformatetc->cfFormat);
			if (pcfhandler != NULL)
			{
				if (pcfhandler->CanGetData())
					return pcfhandler->Validate(*pformatetc);

				ATLTRACE2(atlTraceCOM, 0, _T("CClipboardDataObjectImpl::QueryGetData (DV_E_FORMATETC)\n"));
				return DV_E_FORMATETC;
			}
			else
			{
				return m_pidldata->QueryGetData(pformatetc);
			}
		}
		MSF_COM_CATCH_HANDLER()
	}


	STDMETHOD(GetCanonicalFormatEtc)(FORMATETC* pformatetc, FORMATETC* pformatetcOut)
	{
		ATLTRACE2(atlTraceCOM, 0, _T("CShellFolderDataObjectImpl::GetCanonicalFormatEtc (instance=%p)\n"), this);

		return m_pidldata->GetCanonicalFormatEtc(pformatetc, pformatetcOut);
	}


	STDMETHOD(SetData)(FORMATETC* pformatetc, STGMEDIUM* pstgmedium, BOOL fRelease)
	{
		ATLTRACE2(atlTraceCOM, 0, _T("CShellFolderDataObjectImpl::SetData cfformat=%d (%s), tymed=%d, fRelease=%d\n"),
			pformatetc->cfFormat, GetClipboardFormatName(pformatetc->cfFormat).GetString(), pformatetc->tymed, fRelease);

		try
		{
			if (pformatetc->ptd != NULL)
				return DV_E_DVTARGETDEVICE;

			if (pformatetc->tymed != pstgmedium->tymed)
				return DV_E_TYMED;

			CCfHandler* pcfhandler = FindCfHandler(pformatetc->cfFormat);
			if (pcfhandler != NULL)
			{
				if (pcfhandler->CanSetData())
				{
					RaiseExceptionIfFailed(pcfhandler->Validate(*pformatetc));
					pcfhandler->SetData(*pformatetc, *pstgmedium, fRelease > 0);
					return S_OK;
				}

				return E_FAIL;
			}

			return m_pidldata->SetData(pformatetc, pstgmedium, fRelease);
		}
		MSF_COM_CATCH_HANDLER()
	}


	STDMETHOD(EnumFormatEtc)(DWORD dwDirection, IEnumFORMATETC** ppenumFormatEtc)
	{
		ATLTRACE2(atlTraceCOM, 0, _T("CShellFolderDataObjectImpl::EnumFormatEtc (dwDirection=%d)\n"), dwDirection);

		try
		{
			if (dwDirection != DATADIR_GET && dwDirection != DATADIR_SET)
				return E_INVALIDARG;

			CFormatEtcs formatetcs;
			GetRegisteredFormats(dwDirection, formatetcs);
			GetPidlDataFormats(dwDirection, formatetcs);

			*ppenumFormatEtc = SHCreateStdEnumFmtEtc(static_cast<UINT>(formatetcs.size()), &(formatetcs[0])).Detach();

			return S_OK;
		}
		MSF_COM_CATCH_HANDLER()
	}


	STDMETHOD(DAdvise)(FORMATETC* pformatetc, DWORD advf, IAdviseSink* pAdvSink, DWORD* pdwConnection)
	{
		ATLTRACE2(atlTraceCOM, 0, _T("CShellFolderDataObjectImpl::DAdvise (instance=%p)\n"), this);

		return m_pidldata->DAdvise(pformatetc, advf, pAdvSink, pdwConnection);
	}


	STDMETHOD(DUnadvise)(DWORD dwConnection)
	{
		ATLTRACE2(atlTraceCOM, 0, _T("CShellFolderDataObjectImpl::DUnadvise (instance=%p)\n"), this);

		return m_pidldata->DUnadvise(dwConnection);
	}


	STDMETHOD(EnumDAdvise)(IEnumSTATDATA** ppenumAdvise)
	{
		ATLTRACE2(atlTraceCOM, 0, _T("CShellFolderDataObjectImpl::EnumDAdvise (instance=%p)\n"), this);

		return m_pidldata->EnumDAdvise(ppenumAdvise);
	}


private:

	CCfHandler* FindCfHandler(CLIPFORMAT clipformat) const throw()
	{
		for (CCfHandlers::const_iterator it = m_cfhandlers.begin(); it != m_cfhandlers.end(); ++it)
		{
			if ((*it)->GetClipFormat() == clipformat)
			{
				return *it;
			}
		}

		return NULL;
	}


	void GetRegisteredFormats(DWORD dwDirection, CFormatEtcs& formatetcs) const
	{
		for (CCfHandlers::const_iterator it = m_cfhandlers.begin(); it != m_cfhandlers.end(); ++it)
		{
			if (dwDirection == DATADIR_GET)
			{
				if ((*it)->CanGetData())
				{
					formatetcs.push_back(CFormatEtc((*it)->GetClipFormat()));
				}
			}
			else
			{
				if ((*it)->CanSetData())
				{
					formatetcs.push_back(CFormatEtc((*it)->GetClipFormat()));
				}
			}
		}
	}


	void GetPidlDataFormats(DWORD dwDirection, CFormatEtcs& formatetcs)
	{
		IEnumFORMATETCPtr renumformatetc = m_pidldata.EnumFormatEtc(dwDirection);

		CFormatEtc formatetc;
		while (renumformatetc.Next(formatetc))
		{
			formatetcs.push_back(formatetc);
		}
	}


	// Member variables.
	IDataObjectPtr m_pidldata;
	CCfHandlers    m_cfhandlers;
};

} // end MSF namespace

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

About the Author

Victor Derks
Software Developer (Senior) Schneider Electric
Netherlands Netherlands
Victor lives in Nijmegen, the oldest city in The Netherlands.
He studied Applied Physics in Delft and now works for GE Healthcare.

| Advertise | Privacy | Mobile
Web01 | 2.8.140709.1 | Last Updated 18 Sep 2005
Article Copyright 2005 by Victor Derks
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid