PATCH: [ 1530352 ] Start flashing WinMerge window when folder compare is ready

diff --git a/Src/Changes.txt b/Src/Changes.txt
index 335962d..ef12b73 100644 (file)
--- a/Src/Changes.txt
+++ b/Src/Changes.txt
@@ -2,6 +2,10 @@ Src\Changes.txt
 Add new items to top.
 (This summarizes all changes to all files under Src, including Src\Languages.)
 
+2006-07-30 Kimmo
+ PATCH: [ 1530352 ] Start flashing WinMerge window when folder compare is ready
+  Src: DirView.cpp MainFrm.cpp MainFrm.h
+
 2006-07-29 Takashi
  PATCH: [ 1529915 ] Refresh menu on DirView does not work correctly
   Src: DirActions.cpp DirScan.cpp

diff --git a/Src/DirView.cpp b/Src/DirView.cpp
index 91510af..b40a223 100644 (file)
--- a/Src/DirView.cpp
+++ b/Src/DirView.cpp
@@ -2040,6 +2040,7 @@ LRESULT CDirView::OnUpdateUIMessage(WPARAM wParam, LPARAM lParam)
        clock_t compareEnd = clock();
        if (compareEnd - m_compareStart > TimeToSignalCompare * CLOCKS_PER_SEC)
                MessageBeep(IDOK);
+       GetMainFrame()->StartFlashing();
 
        return 0; // return value unused
 }

diff --git a/Src/MainFrm.cpp b/Src/MainFrm.cpp
index 7e4327e..2970b58 100644 (file)
--- a/Src/MainFrm.cpp
+++ b/Src/MainFrm.cpp
@@ -149,6 +149,8 @@ BEGIN_MESSAGE_MAP(CMainFrame, CMDIFrameWnd)
        ON_COMMAND(ID_WINDOW_CLOSEALL, OnWindowCloseAll)
        ON_UPDATE_COMMAND_UI(ID_WINDOW_CLOSEALL, OnUpdateWindowCloseAll)
        ON_COMMAND(ID_FILE_SAVEPROJECT, OnSaveProject)
+       ON_WM_TIMER()
+       ON_WM_ACTIVATE()
        //}}AFX_MSG_MAP
 END_MESSAGE_MAP()
 
@@ -165,9 +167,7 @@ static UINT indicators[] =
        ID_INDICATOR_SCRL,
 };
 
-/**
- * @brief Relative (to WinMerge executable ) path to local help file.
- */
+/** @brief Relative (to WinMerge executable ) path to local help file. */
 static const TCHAR DocsPath[] = _T("\\Docs\\WinMerge.chm");
 
 /**
@@ -183,6 +183,12 @@ static const TCHAR DocsURL[] = _T("http://winmerge.org/2.4/manual/index.html");
  */
 static const TCHAR DefaultRelativeFilterPath[] = _T("WinMergeFilters");
 
+/** @brief Timer ID for window flashing timer. */
+static const UINT ID_TIMER_FLASH = 1;
+
+/** @brief Timeout for window flashing timer, in milliseconds. */
+static const UINT WINDOW_FLASH_TIMEOUT = 500;
+
 /////////////////////////////////////////////////////////////////////////////
 // CMainFrame construction/destruction
 
@@ -191,19 +197,19 @@ static const TCHAR DefaultRelativeFilterPath[] = _T("WinMergeFilters");
  * @todo Preference for logging?
  */
 CMainFrame::CMainFrame()
+: m_bFlashing(FALSE)
+, m_bFirstTime(TRUE)
+, m_bEscShutdown(FALSE)
+, m_bClearCaseTool(FALSE)
+, m_bShowErrors(TRUE)
+, m_CheckOutMulti(FALSE)
+, m_bVCProjSync(FALSE)
+, m_bVssSuppressPathCheck(FALSE)
 {
-       m_bFirstTime = TRUE;
-       m_bEscShutdown = FALSE;
-       m_bClearCaseTool = FALSE;
        ZeroMemory(&m_pMenus[0], sizeof(m_pMenus));
        OptionsInit(); // Implementation in OptionsInit.cpp
        UpdateCodepageModule();
 
-       m_bShowErrors = TRUE;
-       m_CheckOutMulti = FALSE;
-       m_bVCProjSync = FALSE;
-       m_bVssSuppressPathCheck = FALSE;
-
        InitializeSourceControlMembers();
        g_bUnpackerMode = theApp.GetProfileInt(_T("Settings"), _T("UnpackerMode"), PLUGIN_MANUAL);
        // uncomment this when the GUI allows to toggle the mode
@@ -2768,22 +2774,33 @@ void CMainFrame::OnToolsLoadConfig()
 /**
  * @brief Send current option settings into codepage module
  */
-void
-CMainFrame::UpdateCodepageModule()
+void CMainFrame::UpdateCodepageModule()
 {
        // Get current codepage settings from the options module
        // and push them into the codepage module
        updateDefaultCodepage(m_options.GetInt(OPT_CP_DEFAULT_MODE), m_options.GetInt(OPT_CP_DEFAULT_CUSTOM));
 }
 
-void
-CMainFrame::OnTimer(UINT nIDEvent)
+/**
+ * @brief Handle timer events.
+ * @param [in] nIDEvent Timer that timed out.
+ */
+void CMainFrame::OnTimer(UINT nIDEvent)
 {
-       if (nIDEvent == WM_NONINTERACTIVE)
+       switch (nIDEvent)
        {
-               KillTimer(nIDEvent);
+       case WM_NONINTERACTIVE:
+               KillTimer(WM_NONINTERACTIVE);
                PostMessage(WM_CLOSE);
+               break;
+       
+       case ID_TIMER_FLASH:
+               // This timer keeps running until window is activated
+               // See OnActivate()
+               FlashWindow(TRUE);
+               break;
        }
+       CMDIFrameWnd::OnTimer(nIDEvent);
 }
 
 /**
@@ -3032,3 +3049,41 @@ void CMainFrame::OnSaveProject()
        pathsDlg.m_sFilter = filterNameOrMask;
        sht.DoModal();
 }
+
+/** 
+ * @brief Start flashing window if window is inactive.
+ */
+void CMainFrame::StartFlashing()
+{
+       CWnd * activeWindow = GetActiveWindow();
+       if (activeWindow != this)
+       {
+               FlashWindow(TRUE);
+               m_bFlashing = TRUE;
+               SetTimer(ID_TIMER_FLASH, WINDOW_FLASH_TIMEOUT, NULL);
+       }
+}
+
+/** 
+ * @brief Stop flashing window when window is activated.
+ *
+ * If WinMerge is inactive when compare finishes, we start flashing window
+ * to alert user. When user activates WinMerge window we stop flashing.
+ * @param [in] nState Tells if window is being activated or deactivated.
+ * @param [in] pWndOther Pointer to window whose status is changing.
+ * @param [in] Is window minimized?
+ */
+void CMainFrame::OnActivate(UINT nState, CWnd* pWndOther, BOOL bMinimized)
+{
+       CMDIFrameWnd::OnActivate(nState, pWndOther, bMinimized);
+
+       if (nState == WA_ACTIVE || nState == WA_CLICKACTIVE)
+       {
+               if (m_bFlashing)
+               {
+                       m_bFlashing = FALSE;
+                       FlashWindow(FALSE);
+                       KillTimer(ID_TIMER_FLASH);
+               }
+       }
+}

diff --git a/Src/MainFrm.h b/Src/MainFrm.h
index 216ab9e..4cc5d1b 100644 (file)
--- a/Src/MainFrm.h
+++ b/Src/MainFrm.h
@@ -129,6 +129,7 @@ public:
        void ResetOptions() { OptionsInit(); }
        static void CenterToMainFrame(CDialog * dlg);
        static void SetMainIcon(CDialog * dlg);
+       void StartFlashing();
 
 // Overrides
        // ClassWizard generated virtual function overrides
@@ -155,6 +156,7 @@ public:
        VSSHelper m_vssHelper; /**< Helper class for VSS integration */
        SyntaxColors * GetMainSyntaxColors() { return m_pSyntaxColors; }
        BOOL m_bClearCaseTool; /**< WinMerge is executed as an external Rational ClearCase compare/merge tool. */
+       BOOL m_bFlashing; /**< Window is flashing. */
 
        /**
         * @name Version Control System (VCS) integration.
@@ -264,6 +266,7 @@ protected:
        afx_msg void OnWindowCloseAll();
        afx_msg void OnUpdateWindowCloseAll(CCmdUI* pCmdUI);
        afx_msg void OnSaveProject();
+       afx_msg void OnActivate(UINT nState, CWnd* pWndOther, BOOL bMinimized);
        //}}AFX_MSG
        DECLARE_MESSAGE_MAP()