Filter Library

Camera

Interface Physics

FilterDlg.cpp

/*
 * FilterDlg.cpp - base class for filter dialogs.
 *
 * This file is part of the Camera Filter Library.
 * Computer Aided Measurement Environment for Realtime Atomic imaging (Camera)
 *
 * Copyright (C) 2004, Leiden Probe Microscopy.
 * Copyright (C) 2004, Universiteit Leiden.
 *
 * Authors: M. Seynen (original), Martin J. Moene
 *
 * $Id: FilterDlg.cpp 150 2005-04-25 09:02:30Z moene $
 */

#include "stdafx.h"                     // for common (pre-compiled) headers
//#include <cfl/stdafx.h>                 // for common (pre-compiled) headers
#include <cfl/resource.h>               // for messages and other resources

#include <Camera/InterfaceDll.h>        // Camera--Filter Library interface
#include <Camera/CameraGeneralDefines.h>// for g_d2PI

#include <cfl/ScanBaseBuffer.h>         // for class CScanBaseBuffer
#include <cfl/ScanFilter.h>             // this filter's header
#include <cfl/FilterDlg.h>              // this filter's dialog

#ifdef _DEBUG
#define new DEBUG_NEW
#undef THIS_FILE
static char THIS_FILE[] = __FILE__;
#endif

/*
 * prototypes:
 */
static bool SetMouseMsgHook   ( HWND hwndDlg );
static void RemoveMouseMsgHook( );

/*
 * massage map:
 */
BEGIN_MESSAGE_MAP(CFilterDlg, CDialog)
   //{{AFX_MSG_MAP(CFilterDlg)
   ON_EN_KILLFOCUS(IDC_BUFFEROUTNAME, OnKillfocusBufferoutname)
   ON_BN_CLICKED(IDHELP, OnHelp)
   ON_WM_TIMER()
   ON_WM_DESTROY()
   //}}AFX_MSG_MAP
   ON_MESSAGE( TTM_RELAYEVENT, OnRelayEvent )
END_MESSAGE_MAP()

/*
 * (default) constructor:
 */
CFilterDlg::CFilterDlg( CWnd* pParent /* =NULL */ ) :
   CDialog( CFilterDlg::IDD, pParent ),
   m_bInEditModeless( false ),
   m_bInitialized( false )
{
//   Q_LOG( _T("CFilterDlg::CFilterDlg()") );

   //{{AFX_DATA_INIT(CFilterDlg)
   // NOTE: the ClassWizard will add member initialization here
   //}}AFX_DATA_INIT

   /*
    * for embedded help:
    */
   m_timerHelpId = 0;
   m_curHelpId   = IDC_EMBEDDEDHELP;
}

/*
 * destructor: remove mouse message hook.
 */
CFilterDlg::~CFilterDlg()
{
//   Q_LOG( _T("CFilterDlg::~CFilterDlg()") );

   /*
    * for embedded help:
    */
   RemoveMouseMsgHook();
}

/*
 * Dialog Data Exchange (DDX) / Dialog Data Validation (DDV) support.
 */
void CFilterDlg::DoDataExchange(CDataExchange* pDX)
{
//    Q_LOG( _T("CFilterDlg::DoDataExchange()") );

  CDialog::DoDataExchange(pDX);
   //{{AFX_DATA_MAP(CFilterDlg)
      // NOTE: the ClassWizard will add DDX and DDV calls here
   //}}AFX_DATA_MAP
}

/*
 * OK button message handler.
 */
void CFilterDlg::OnOK()
{
//   Q_LOG( _T("CFilterDlg::OnOK()") );

   /*
    * save the current filter settings.
    */
   m_pFilter->WriteFilterSettings();

   if ( InEditModeless() )
   {
      /*
       * Let the application handle the cleanup:
       */
      AfxGetMainWnd()->SendMessage( WMU_DELETEFILTER, 0, 0 );
      return ;
   }

   Q_ASSERT( m_pDoc    && "ensure m_pDoc"    );
   Q_ASSERT( m_pFilter && "ensure m_pFilter" );

   /*
    * let the caller (some CScanView) handle the cleanup.
    */
   m_pDoc->UpdateAllViews( NULL, SCANVIEWUPDATE_FILTEROPERATIONDONE, m_pFilter );
}

/*
 * Cancel button message handler.
 */
void CFilterDlg::OnCancel()
{
//   Q_LOG( _T("CFilterDlg::OnCancel()") );

   if ( InEditModeless() )
   {
      /*
       * Let the application handle the cleanup:
       */
      AfxGetMainWnd()->SendMessage( WMU_DELETEFILTER, 0, 0 );
      return ;
   }

   Q_ASSERT( m_pDoc    && "ensure m_pDoc"    );
   Q_ASSERT( m_pFilter && "ensure m_pFilter" );

   /*
    * Let the caller (some CScanView) handle the cleanup; cancel only the current view.
    */
   m_pDoc->UpdateAllViews( NULL, SCANVIEWUPDATE_FILTEROPERATIONCANCEL, m_pFilter );
}

/*
 * Help button handler.
 */
void CFilterDlg::OnHelp()
{
//   Q_LOG( _T("CFilterDlg::OnHelp()") );

   SetEmbeddedHelp( _T("This help is not yet available" ) );
}

/*
 * update view and in Edit mode also update the stored filter settings.
 */
void CFilterDlg::UpdateView()
{
//   Q_LOG( _T("CFilterDlg::UpdateView()") );

   if ( InEditModeless() )
   {
      /*
       * update stored parameter settings for use with online/script filtering:
       */
      m_pFilter->WriteFilterSettings();

      return ;
   }

   Q_ASSERT( m_pDoc && "ensure m_pDoc" );

   m_pDoc->UpdateAllViews( NULL, SCANVIEWUPDATE_REDRAWBUFFER, m_pFilter->m_lpsbOut );
}

/*
 * initialize dialog.
 */
BOOL CFilterDlg::OnInitDialog()
{
//   Q_LOG( _T("CFilterDlg::OnInitDialog()") );

   CDialog::OnInitDialog();

   /*
    * guard for EditModeless(): has no buffers:
    */
   if ( !InEditModeless() )
   {
      SetDlgItemText( IDC_BUFFERINNAME, m_pFilter->m_lpsbIn->m_csBufferName );
   }
   //SetDlgItemText( IDC_BUFFEROUTNAME, m_pFilter->m_lpsbOut->m_csBufferName );

   /*
    * hook mouse for embedded help:
    */
   SetMouseMsgHook(*this);

   return TRUE;
}

/*
 * obtain a scan buffer.
 */
CScanBaseBuffer *CFilterDlg::BrowseForScanBuffer()
{
//   Q_LOG( _T("CFilterDlg::BrowseForScanBuffer()") );

   if ( InEditModeless() )
   {
      return NULL;
   }

   CMDIFrameWnd *pMain = (CMDIFrameWnd *)AfxGetMainWnd();

   CScanBaseBuffer *lpBuffer = NULL;
   pMain->SendMessage( WMU_SCANVIEWBROWSEFORBUFFER, 0, (LPARAM) &lpBuffer );

   return lpBuffer;
}

/*
 * update view for new output buffername.
 */
void CFilterDlg::OnKillfocusBufferoutname()
{
//   Q_LOG( _T("CFilterDlg::OnKillfocusBufferoutname()") );

   /*
    * guard for EditModeless(): has no buffers:
    */
   if ( InEditModeless() )
   {
      return ;
   }

   GetDlgItemText( IDC_BUFFEROUTNAME, m_pFilter->m_lpsbOut->m_csBufferName );

   if ( m_pFilter->m_lpsbOut->m_pwData )
   {
      UpdateView();
   }
}

/*
 * disable the input and output buffername controls for the EditModeless dialog.
 */
void CFilterDlg::DisableBufferControls()
{
//   Q_LOG( _T("CFilterDlg::DisableBufferControls()") );

   int IdcList[] =
   {
      IDC_BUFFERINNAME,
      IDC_BUFFEROUTNAME,
   };

   for ( int i = 0; i < dim(IdcList); ++i )
   {
      CWnd* wnd = GetDlgItem( IdcList[i]  );

      if ( wnd )
      {
         wnd->EnableWindow( FALSE );
      }
   }
}

/* ------------------------------------------------------------------
 *
 * KeyHelp from http://www.keyworks.net/
 */

/*
 * set the text in the embedded help control (id).
 */
void CFilterDlg::SetEmbeddedHelp( UINT id )
{
   CString s;
   if ( s.LoadString( id ) )
   {
      SetEmbeddedHelp( s );
   }
}

/*
 * set the text in the embedded help control (C-string).
 */
void CFilterDlg::SetEmbeddedHelp( LPCTSTR lpString )
{
   SetDlgItemText( IDC_EMBEDDEDHELP, lpString );
}

#pragma warning( push, 3 )              // disable unreferenced parameter warning

/*
 * get the (help) id of the dialog's control under the mouse cursor.
 */
LRESULT CFilterDlg::OnRelayEvent(WPARAM wParam, LPARAM lParam)
{
   /*
    * Every time we get a mouse message, we kill the timer
    */

   if ( m_timerHelpId )
   {
      KillTimer( m_timerHelpId );
      m_timerHelpId = 0;
   }

   int id = ::GetDlgCtrlID( ( (MSG*) lParam )->hwnd );

   if ( m_curHelpId != id )
   {
      if ( m_timerHelpId )
      {
         KillTimer( m_timerHelpId );
      }

      m_timerHelpId = id;

      SetTimer( m_timerHelpId, HOVER_DELAY, NULL );
   }

   return 0;
}

#pragma warning( pop )
#pragma warning( push, 3 )              // disable unreferenced parameter warning

/*
 * show embedded help if the timer fires.
 */
void CFilterDlg::OnTimer( UINT nIDEvent )
{
   /*
    * When the timer goes off, it means the mouse has been over a control
    * for HOVER_DELAY milliseconds. The id of the timer is the mapped id
    * of the html file to display.
    */

   KillTimer( m_timerHelpId );

//    m_hhctrl.NavigateChm(m_timerHelpId);

   /*
    * FIXME: IDHELP shows: IDS_COLOR8|9|"select a color" from Camera String Table.
    *
    * ?use
    *    int LoadString(
    *        HINSTANCE hInstance,  // handle to module containing string resource: <-- DLL
    *        UINT uID,             // resource identifier
    *        LPTSTR lpBuffer,      // pointer to buffer for resource
    *        int nBufferMax        // size of buffer
    *     );
    */

   CString s;
   if ( s.LoadString( m_timerHelpId ) )
   {
      SetEmbeddedHelp( s );
   }
   else
   {
      SetEmbeddedHelp( "[empty]" );
   }

    m_curHelpId   = m_timerHelpId;      // store current help id
    m_timerHelpId = 0;                  // 
}

#pragma warning( pop )                  // disable unreferenced parameter warning

/*
 * kill the timer for embedded help.
 */
void CFilterDlg::OnDestroy()
{
   if ( m_timerHelpId )
   {
      KillTimer( m_timerHelpId );
   }

    CDialog::OnDestroy();
}

/*------------------------------------------------------------------------
 * mouse event handling for embedded help
 *------------------------------------------------------------------------
 */

static LRESULT CALLBACK RelayMouseMsgHook( int nCode, WPARAM wParam, LPARAM lParam );

static HHOOK s_hkMouseMsg;
static HWND  s_hwndMouseMsgDlg;

/*
 * attach our mouse hook.
 */
static bool SetMouseMsgHook( HWND hwndDlg )
{
   /*
    * we only one hook at a time
    */

   Q_ASSERT( !s_hkMouseMsg && "only hook mouse one time" );

   s_hkMouseMsg = SetWindowsHookEx( WH_GETMESSAGE, RelayMouseMsgHook,(HINSTANCE) NULL, GetCurrentThreadId() );

   if ( s_hkMouseMsg )
   {
      s_hwndMouseMsgDlg = hwndDlg;
      return true;
   }

   return false;
}

/*
 * detach our mouse hook.
 */
static void RemoveMouseMsgHook()
{
   if ( s_hkMouseMsg )
   {
      UnhookWindowsHookEx( s_hkMouseMsg );
      s_hkMouseMsg = NULL;
   }
}

/*
 * also send the mouse messages to our dialog, if appropriate.
 */
static LRESULT CALLBACK RelayMouseMsgHook( int nCode, WPARAM wParam, LPARAM lParam )
{
   MSG* pmsg = (MSG*) lParam;

   if ( nCode < 0 || !( IsChild( s_hwndMouseMsgDlg, pmsg->hwnd ) ) )
   {
      return CallNextHookEx( s_hkMouseMsg, nCode, wParam, lParam );
   }

   switch ( pmsg->message )
   {
      case WM_MOUSEMOVE:
      case WM_LBUTTONDOWN:
      case WM_LBUTTONUP:
      case WM_RBUTTONDOWN:
      case WM_RBUTTONUP:
         SendMessage( s_hwndMouseMsgDlg, TTM_RELAYEVENT, 0, (LPARAM) pmsg );
         break;

      default:
         break;
   }

   return CallNextHookEx( s_hkMouseMsg, nCode, wParam, lParam );
}

/*
 * end of file
 */

---