// XTPDirWatcher.h : header file
//
// This file is a part of the XTREME CONTROLS 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(__XTPDIRWATCHER_H__)
#define __XTPDIRWATCHER_H__
//}}AFX_CODEJOCK_PRIVATE
#if _MSC_VER > 1000
#pragma once
#endif // _MSC_VER > 1000
//===========================================================================
// Summary:
// The CXTPDirWatcher is a thread class that will monitor a specified
// path for file and directory changes to occur.
// Remarks:
// Whenever an item is created, deleted or renamed the thread will send a notification to
// the its owner in the form of a WM_XTP_SHELL_NOTIFY message. The
// WPARAM value for the notification will be set to SHN_XTP_TREESELCHANGE
// if the folder list contents require updating or SHN_XTP_CONTENTSCHANGED
// if the tree contents require updating. The LPARAM value is set to
// the address of a XTP_TVITEMDATA structure that contains information
// the path monitored.
//
// Example: To use CXTPDirWatcher, add a CXTPDirWatcher* m_pDirThread member
// to your class and instantiate a new thread using AfxBeginThread:
//
// <code>
// // Start the directory monitoring thread.
// m_pDirThread = (CXTPDirWatcher*)AfxBeginThread(RUNTIME_CLASS(CXTPDirWatcher),
// THREAD_PRIORITY_NORMAL, 0, CREATE_SUSPENDED, NULL);
// </code>
// You can then specify what directory you wish to monitor by calling SetFolderData
// or SetFolderPath:
// <code>
// // Specify the folder to monitor.
// m_pDirThread->SetFolderData(this, lpTVID);
// m_pDirThread->ResumeThread();
// </code>
//
// You can add a message handler to the window receiving messages and handle your
// change event notifications. The thread will send two notifications, the wParam indicates
// what event has occurred. If wParam equal HN_XT_REFRESHFOLDER this indicates that the
// folder list has changed and needs to be updated. If wParam equals SHN_XTP_REFRESHTREE this
// indicates the folder tree has changed and needs to be updated. The lParam value represents
// a pointer to a XTP_TVITEMDATA structure for the folder:
//
// <code>
// BEGIN_MESSAGE_MAP(CNotifyWnd, CWnd)
// //{{AFX_MSG_MAP(CNotifyWnd)
// //}}AFX_MSG_MAP
// ON_MESSAGE(WM_XTP_SHELL_NOTIFY, OnUpdateShell)
// END_MESSAGE_MAP()
//
// LRESULT CNotifyWnd::OnUpdateShell(WPARAM wParam, LPARAM lParam)
// {
// switch (wParam)
// {
// case SHN_XTP_REFRESHFOLDER:
// case SHN_XTP_REFRESHTREE:
// {
// // Directory monitory thread has issued an update notification,
// // refresh the list control.
// XTP_TVITEMDATA* lpTVID = (XTP_TVITEMDATA*)lParam;
// ASSERT(lpTVID);
//
// PopulateListView(lpTVID, lpTVID->lpsfParent);
// break;
// }
//
// default:
// break;
// }
//
// return 0;
// }
// </code>
//
// When you are finished using the CXTPDirWatcher thread, you will need to free the
// memory associated with the object. To do so you can use the SAFE_DELETE
// macro like so:
//
// <code>
// SAFE_DELETE(m_pDirThread);
// </code>
//
// The CXTPDirWatcher class is used internally by the CXTPShellListCtrl and
// CXTPShellListView classes to handle refreshing the list when a file or directory
// change occurs.
//===========================================================================
class _XTP_EXT_CLASS CXTPDirWatcher : public CWinThread
{
DECLARE_DYNCREATE(CXTPDirWatcher)
public:
//-----------------------------------------------------------------------
// Summary:
// Constructs a CXTPDirWatcher object
//-----------------------------------------------------------------------
CXTPDirWatcher();
protected:
//-----------------------------------------------------------------------
// Summary:
// Destroys a CXTPDirWatcher object, handles cleanup and deallocation
//-----------------------------------------------------------------------
virtual ~CXTPDirWatcher();
public:
//-----------------------------------------------------------------------
// Summary:
// Call this member function to monitor the directory specified by strPath.
// Parameters:
// pMainWnd - Points to the window to receive change notifications.
// lpszFolderPath - Full path of directory to monitor.
// bWatchSubtree - Monitors the directory tree rooted at the specified directory
// Returns:
// TRUE if successful, otherwise returns FALSE.
//-----------------------------------------------------------------------
BOOL SetFolderPath(CWnd* pMainWnd, LPCTSTR lpszFolderPath, BOOL bWatchSubtree = FALSE);
//-----------------------------------------------------------------------
// Summary:
// Call this member function to retrieve the full path to the directory that
// is currently monitored.
// Returns:
// A CString object representing the path monitored.
//-----------------------------------------------------------------------
CString GetFolderPath() const;
//-----------------------------------------------------------------------
// Summary:
// Call this member function to monitor the directory using a pointer
// to a XTP_TVITEMDATA pointer.
// Parameters:
// pMainWnd - Pointer to the window to receive update notifications.
// lpTVID - Pointer to tree view item data.
// Returns:
// TRUE if successful, otherwise returns FALSE.
//-----------------------------------------------------------------------
BOOL SetFolderData(CWnd* pMainWnd, XTP_TVITEMDATA* lpTVID);
// ----------------------------------------------------------------------
// Summary:
// Constructs or retrieves XTP_TVITEMDATA structure information.
// Parameters:
// lpszFolderPath - Full path to directory.
// lpTVID - Reference to tree view item data.
// Remarks:
// In the first version this member function is called to return the
// a pointer to a XTP_TVITEMDATA structure for the directory that is
// currently monitored. In the second version the function constructs
// a XTP_TVITEMDATA structure from the specified path.
// Returns:
// In the first version a pointer to a XTP_TVITEMDATA structure. In
// the second version TRUE if successful, otherwise FALSE.
// ----------------------------------------------------------------------
XTP_TVITEMDATA* GetFolderData();
BOOL GetFolderData(LPCTSTR lpszFolderPath, XTP_TVITEMDATA& lpTVID); //<combine CXTPDirWatcher::GetFolderData>
//-----------------------------------------------------------------------
// Summary:
// Call this member function to determine if the specified path
// is a valid directory name.
// Parameters:
// lpszFolderPath - Full path to directory.
// Returns:
// TRUE if the path is valid, otherwise returns FALSE.
//-----------------------------------------------------------------------
BOOL IsPathValid(LPCTSTR lpszFolderPath);
//-----------------------------------------------------------------------
// Summary:
// Finishes Notification loop.
//-----------------------------------------------------------------------
void StopNotifications();
public:
//{{AFX_CODEJOCK_PRIVATE
//{{AFX_VIRTUAL(CXTPDirWatcher)
virtual BOOL InitInstance();
//}}AFX_VIRTUAL
//}}AFX_CODEJOCK_PRIVATE
protected:
//-----------------------------------------------------------------------
// Summary:
// This member function is called by the thread whenever the monitored
// directory list needs to be refreshed.
//-----------------------------------------------------------------------
virtual void RefreshFolder();
//-----------------------------------------------------------------------
// Summary:
// This member function is called by the thread whenever the monitored
// directory tree needs to be refreshed.
//-----------------------------------------------------------------------
virtual void RefreshTree();
//-----------------------------------------------------------------------
// Summary:
// Worker method with main notification loop.
// Returns:
// TRUE if succcessful, FALSE otherwise.
//-----------------------------------------------------------------------
BOOL MonitorNotifications();
//-----------------------------------------------------------------------
// Summary:
// Waits for the developer to set a new path to monitor.
// Returns:
// TRUE if succcessful, FALSE otherwise.
//-----------------------------------------------------------------------
BOOL WaitPathChangedEvent();
protected:
//{{AFX_CODEJOCK_PRIVATE
DECLARE_MESSAGE_MAP()
//{{AFX_MSG(CXTPDirWatcher)
//}}AFX_MSG
//}}AFX_CODEJOCK_PRIVATE
protected:
HANDLE m_dwMonitorEvents[4]; // Change event handles.
CString m_strFolderPath; // Path that is monitored.
XTP_TVITEMDATA m_tvid; // Tree view item data.
BOOL m_bWatchSubtree; // Monitors the directory tree.
};
/////////////////////////////////////////////////////////////////////////////
AFX_INLINE CString CXTPDirWatcher::GetFolderPath() const {
return m_strFolderPath;
}
AFX_INLINE XTP_TVITEMDATA* CXTPDirWatcher::GetFolderData() {
return &m_tvid;
}
#endif // !defined(__XTPDIRWATCHER_H__)