Auto Sample

This is one of the samples that comes with the MFC version of NSELib.

This sample is available for Delphi too.

This sample demonstrates the usage of stock objects that come with NSELib: Automatic namespace extensions (CAutoNameSpaceExtension), shortcut items (CShortcutNameSpaceItem) and action items (CActionNameSpaceItem).

AutoExtension.h

This is the header file for the class CAutoExtension.

#if !defined(AFX_AUTOEXTENSION_H__EA233978_B84E_488C_97B1_D4EC18997720__INCLUDED_)
#define AFX_AUTOEXTENSION_H__EA233978_B84E_488C_97B1_D4EC18997720__INCLUDED_

#include "NameSpaceExtension.h"
#include "AutoNameSpaceExtension.h"


//TODO: Standard columns - change and add as you need

#define AUTO_COLUMN_NAME		0
#define AUTO_COLUMN_SIZE		1
#define AUTO_COLUMN_TYPE		2
#define AUTO_COLUMN_MODIFIED	3

#define SIG_AUTO 'AUTO'

#define COMMAND_AUTO_ADDITEM 1



class CNameSpaceItem;
class CAutoExtension : public CAutoNameSpaceExtension
{
public:

	DECLARE_DYNCREATE(CAutoExtension);

	CAutoExtension(CNameSpaceExtension *pParent = NULL);
	virtual REFCLSID GetClassID();
	virtual CNameSpaceExtension *CreateFolder(CNameSpaceItem* pItem);
	virtual CShellUIObject *CreateUIObject(UINT cidl, const CNameSpaceItem** aItems, HWND hWndOwner);
	virtual CString GetWebPage();

	virtual CString			GetDisplayName(DWORD uFlags);
	virtual ULONG			GetAttributes();
	virtual JUNCTIONPOINT	GetJunctionPoint();
	virtual CPCATEGORY		GetCPCategory();
	virtual CString			GetProtocolPrefix();
	virtual CNameSpaceItem*	ParseItemName(LPCTSTR szName);
	virtual CString			GetFileType();
	virtual CString			GetFileExtension();

	virtual void Populate();
	virtual BOOL OnCommand(HWND hWndView, UINT idCmd);

};

#endif // !defined(AFX_AUTOEXTENSION_H__EA233978_B84E_488C_97B1_D4EC18997720__INCLUDED_)

AutoExtension.cpp

This file implements the class CAutoExtension.

This class is derived from CAutoNameSpaceExtension, not from CNameSpaceExtension. It doesn't have the functions GetFirstRegularItem etc. Instead it has the function Populate.

In the function Populate, you see how a shortcut item and an action item can be added.

When the action item is invoked, the function OnCommand is called and a new item is added.

#include "stdafx.h"
#include "AutoExtension.h"
#include "AutoItem.h"
#include "AutoUIObject.h"
#include "ActionNameSpaceItem.h"
#include "ShortcutNameSpaceItem.h"
#include 


IMPLEMENT_DYNCREATE(CAutoExtension, CNameSpaceExtension);

extern CLSID	CLSID_AutoExtension;

CAutoExtension::CAutoExtension(CNameSpaceExtension *pParent) :
CAutoNameSpaceExtension(pParent)
{
}

REFCLSID CAutoExtension::GetClassID()
{
	return CLSID_AutoExtension;
}



CNameSpaceExtension *CAutoExtension::CreateFolder(CNameSpaceItem* pItem)
{
	//TODO: Initialize the new folder

	return new CAutoExtension(this);
}

CShellUIObject *CAutoExtension::CreateUIObject(UINT cidl, const CNameSpaceItem** aItems, HWND hWndOwner)
{
	return new CAutoUIObject(this, cidl, aItems, GetPidl(), hWndOwner);
}


CString CAutoExtension::GetWebPage()
{
	return "folder.htt";
}



CString CAutoExtension::GetDisplayName(DWORD uFlags)
{
	if (!m_pParent)
	{
		return "Auto NSE";
	}
	return CNameSpaceExtension::GetDisplayName(uFlags);
}

ULONG CAutoExtension::GetAttributes()
{
	if (!m_pParent)
	{
		return	SFGAO_CANLINK | SFGAO_CANRENAME | SFGAO_DROPTARGET |
				SFGAO_BROWSABLE | SFGAO_FOLDER;
	}
	return CNameSpaceExtension::GetAttributes();
}


JUNCTIONPOINT CAutoExtension::GetJunctionPoint() 
{
	return JUNCTIONPOINT_MYCOMPUTER; 
}

CString CAutoExtension::GetProtocolPrefix()
{
	//TODO: Add a protocol prefix here to support URL protocol browsing
	return "";
}


CString CAutoExtension::GetFileType()
{
	//TODO: Add a file class here to support in-place file type browsing (ie. "txtfile")
	return "";
}

CString CAutoExtension::GetFileExtension()
{
	//TODO: Add a file type here to associate the file class with a file extension on registration (ie. "txt")
	return "";
}


CNameSpaceItem*	CAutoExtension::ParseItemName(LPCTSTR szName)
{
	//TODO: Override this method if you want to use custom parsing for paths or URLS
	//		For example - ftp://ftp.mysite.com/
	//		Default implementation enumerates the folder and compares display names to find the item

	return CNameSpaceExtension::ParseItemName(szName);
}


CPCATEGORY	CAutoExtension::GetCPCategory()
{	
	//TODO: Change the control panel category for Control Panel NSEs.
	return CPCATEGORY_DONOTADD;
}
		
void CAutoExtension::Populate()
{
	CNameSpaceItem *pNewItem = new CActionNameSpaceItem(this, "Add Item", "Run Wizard", "Execute to add a new item to this folder.", 0, COMMAND_AUTO_ADDITEM);
	AddItem(pNewItem);
	delete pNewItem;
	LPITEMIDLIST pidlControlPanel;
	::SHGetSpecialFolderLocation(NULL, CSIDL_CONTROLS, &pidlControlPanel);
	pNewItem = new CShortcutNameSpaceItem(this, "Shortcut to Control Panel", pidlControlPanel);
	AddItem(pNewItem);
	delete pNewItem;
	::ILFree(pidlControlPanel);
}

BOOL CAutoExtension::OnCommand(HWND hWndView, UINT idCmd)
{
	if (idCmd == COMMAND_AUTO_ADDITEM)
	{
		CAutoItem *pItem = new CAutoItem(this, "Item");
		AddItem(pItem);
		UpdateAddedItem(pItem);
		delete pItem;
	}
	return TRUE;
}

AutoItem.h

This is the header file for class CAutoItem.

#ifndef _AFX_AUTOITEM_H__D30AC85F_59FC_40A9_8E06_8752419B886F__IS_INCLUDED
#define _AFX_AUTOITEM_H__D30AC85F_59FC_40A9_8E06_8752419B886F__IS_INCLUDED


#include "NameSpaceItem.h"

class CNameSpaceExtension;


class CAutoItem : public CNameSpaceItem
{
public:
	DECLARE_SERIAL(CAutoItem);

	CAutoItem() {};
	CAutoItem(CNameSpaceExtension* pFolder, CString sName);

	virtual ~CAutoItem();

	virtual CString		GetDisplayName(DWORD uFlags) const;
	virtual CString		GetInfoTip(void) const;
	virtual BOOL		GetFindData(WIN32_FIND_DATAW *pFindData) const;

	virtual int			GetIconIndex(UINT uFlags, UINT *puiReturnFlags) const;
	virtual ULONG		GetAttributes() const;
	virtual CString		GetItemDetail(UINT iCol) const;
	virtual CString		GetStorageType() const;
	virtual int			CompareTo(UINT iCol, const CNameSpaceItem* pOtherItem) const;
	virtual BOOL		Rename(CString sNewName);
	virtual BOOL		Delete();

	virtual CString		GetIconModule() const;
	virtual BOOL		IsValidObject() const;
	virtual CString		GetFileAttributes() const;


	virtual void Serialize( CArchive& ar );

protected:

	CString m_sName;

};

#endif

AutoItem.cpp

This file implements the class CAutoItem.

#include "stdafx.h"
#include 

#include "AutoItem.h"
#include "AutoExtension.h"
#include "NSEUtils.h"

IMPLEMENT_SERIAL(CAutoItem, CNameSpaceItem, 1);


CAutoItem::CAutoItem(CNameSpaceExtension* pFolder, CString sName) : CNameSpaceItem(pFolder)
{
	m_sName = sName;
	
}


CAutoItem::~CAutoItem()
{
}

void CAutoItem::Serialize( CArchive& ar )
{
	CNameSpaceItem::Serialize( ar );

	//TODO: Store/Read all members ie;
	if( ar.IsStoring() )
	{
		ar << m_sName;
	} else {
		ar >> m_sName;
	}
}


BOOL CAutoItem::IsValidObject() const
{
	//TODO: Validate your object, the call the base class
	return CNameSpaceItem::IsValidObject();
}



CString CAutoItem::GetStorageType() const
{
	//TODO: Return the storage type - ie. "Word Document"
	return "StorageType";
}

CString CAutoItem::GetInfoTip() const
{
	//TODO: Return the info tip - ie. "Contains text"
	return GetDisplayName(0);
}

BOOL CAutoItem::Rename(CString sNewName)
{
	//TODO: Rename the item (cause the GetDisplayName method to return sNewName) and
	//		perform any operation to rename the object referred to.
	//		Return TRUE if OK
	return FALSE;
}

BOOL CAutoItem::Delete()
{
	//TODO: Perform any operation to delete the object referred to.
	//		Return TRUE if OK
	dynamic_cast(m_pFolder)->RemoveItem(this);
	m_pFolder->UpdateRemovedItem(this);
	return TRUE;
}

CString CAutoItem::GetDisplayName(DWORD uFlags) const
{
	//TODO:	Return the display name of your object
	return m_sName;
}

ULONG CAutoItem::GetAttributes() const
{
	//TODO: Return SFGAO_ attributes as returned by IShellFolder::GetAttributes for this item

	return	SFGAO_CANDELETE | SFGAO_CANLINK |
		SFGAO_CANCOPY | SFGAO_CANMOVE;
}

BOOL CAutoItem::GetFindData(WIN32_FIND_DATAW *pFindData) const
{
	//TODO: Fill in the WIN32_FIND_DATAW for this item, and return TRUE if OK.
	return FALSE;
}

int CAutoItem::GetIconIndex(UINT uFlags, UINT *puiReturnFlags) const
{
	//TODO: Return an icon index for this item in the file indicated by GetIconModule
	return 0;
}

CString CAutoItem::GetIconModule() const
{
	//TODO: Return the module path to your icons
	
	return CNameSpaceItem::GetIconModule();
}

CString CAutoItem::GetItemDetail(UINT iCol) const
{
	//TODO: Return the item detail for the column number (defined in CNameSpaceExtension::GetColumnTitle)
	if (iCol == 0)
	{
		return GetDisplayName(0);
	}
	return "";
}


CString CAutoItem::GetFileAttributes() const
{
	//TODO: Return attributes as a string (ie. "Read Only, System")
	return "";
}


int CAutoItem::CompareTo(UINT iCol, const CNameSpaceItem* pOtherItem) const
{
	//TODO: Compare the two items with reference to the column number.

	switch(iCol)
	{
		case AUTO_COLUMN_NAME:
		{
			return m_sName.CompareNoCase(pOtherItem->GetDisplayName(SHGDN_NORMAL));
		}
		case AUTO_COLUMN_SIZE:
		{
			WIN32_FIND_DATAW data;
			::ZeroMemory(&data, sizeof(WIN32_FIND_DATAW));
			GetFindData(&data);
			DWORD dwSize1 = data.nFileSizeLow;

			::ZeroMemory(&data, sizeof(WIN32_FIND_DATAW));
			pOtherItem->GetFindData(&data);
			DWORD dwSize2 = data.nFileSizeLow;

			if (dwSize1 == dwSize2)
			{
				return 0;
			} 
			else if (dwSize1 > dwSize2)
			{
				return 1;
			}
			else
			{
				return -1;
			}
		}
		case AUTO_COLUMN_MODIFIED:
		{
			WIN32_FIND_DATAW data;
			::ZeroMemory(&data, sizeof(WIN32_FIND_DATAW));
			GetFindData(&data);
			COleDateTime oledt1(data.ftLastWriteTime);

			::ZeroMemory(&data, sizeof(WIN32_FIND_DATAW));
			pOtherItem->GetFindData(&data);
			COleDateTime oledt2(data.ftLastWriteTime);

			if (oledt1 == oledt2)
			{
				return 0;
			}
			else if (oledt1 > oledt2)
			{
				return 1;
			}
			else
			{
				return -1;
			}
		}
		default:
		{
			CString str1 = GetItemDetail(iCol);
			CString str2 = GetItemDetail(iCol);
			return str1.Compare(str2);
		}
	}
}

AutoUIObject.h

This is the header file for class CAutoUIObject.

#if !defined(AFX_AUTOUIOBJECT_H__B8275C56_DD9A_41ED_B5F8_0F98A91DB4DC__INCLUDED_)
#define AFX_AUTOUIOBJECT_H__B8275C56_DD9A_41ED_B5F8_0F98A91DB4DC__INCLUDED_

#include "ShellUIObject.h"

class CNameSpaceItem;
class CAutoUIObject : public CShellUIObject
{
public:
	CAutoUIObject(CNameSpaceExtension *pFolder, UINT cidl, const CNameSpaceItem** aItems, LPCITEMIDLIST basePidl, HWND hWndOwner = NULL);
	CAutoUIObject();

	DECLARE_DYNCREATE(CAutoUIObject);

	virtual REFCLSID GetClassID();
	virtual UINT FillContextMenu(HMENU hmenu, UINT indexMenu, UINT idCmdFirst, UINT idCmdLast, UINT uFlags);
	virtual BOOL InvokeCommand(LPCMINVOKECOMMANDINFO lpici);
	virtual BOOL InvokeDefaultCommand();
	virtual BOOL GetFormatEtc(ULONG iIndex, FORMATETC *pfetc);
	virtual BOOL IsClipFormatSupported(CLIPFORMAT cf);
	virtual BOOL GetData(CLIPFORMAT cf, HGLOBAL hGlobal);
	virtual DWORD GetDataSize(CLIPFORMAT cf);
};

#define AUTO_COMMAND_EDIT 1
const int nAutoCommands = 1;

#endif