Filter Library

Camera

Interface Physics

FilterDlg.h

/*
 * FilterDlg.h - 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.
 *
 * Original author(s): ?
 *
 * $Id: FilterDlg.h 219 2005-06-13 11:07:15Z moene $
 */

#ifndef CFL_FILTERDLG_H
#define CFL_FILTERDLG_H

#if _MSC_VER > 1000
#pragma once
#endif // _MSC_VER > 1000

DECLARE_CLASS( CScanView );
DECLARE_CLASS( CScanFilter );
DECLARE_CLASS( CScanBaseBuffer );

/**
 * \addtogroup cfl_dialog
 *

This is the group documentation.

 *
 * @{
 */

DECLARE_CLASS( CFilterDlg );

/**
 * base class for scan filters dialogs.
 */

class CFilterDlg : public CDialog
{
public:
   ///
   /// \name Constructors
   /// @{

   /**
    * (default) constructor.
    */
   CFilterDlg( CWnd* pParent = NULL );

   /**
    * destructor: remove mouse message hook.
    */
   virtual ~CFilterDlg( );

   /// @}

   /**
    * set filter and document.
    */
   void SetParameters( CScanFilterPtr pFilter, CDocument* pDoc );

   /**
    * update the view and in Edit mode also update the stored filter settings.
    */
   void UpdateView();

   /**
    * true if in EditModeless().
    */
   bool InEditModeless();

   /**
    * dialog is being used for EditModeless.
    */
   void SetEditModeless();

   /**
    * diable the input and output buffer controls for EditModeless().
    */
   void DisableBufferControls();

protected:
   /**
    * set embedded help for given uId.
    */
   virtual void SetEmbeddedHelp( UINT uId );

   /**
    * set embedded help to given string.
    */
   virtual void SetEmbeddedHelp( LPCTSTR lpString );

   // ClassWizard generated virtual function overrides
   //{{AFX_VIRTUAL(CFilterDlg)
   virtual void DoDataExchange( CDataExchange* pDX );    ///< DDX/DDV support
   //}}AFX_VIRTUAL

protected:
   // Generated message map functions
   //{{AFX_MSG(CFilterDlg)
   virtual void OnOK();                 ///< Ok handler, update filter settings in registry
   virtual void OnCancel();             ///< Cancel handler
   virtual BOOL OnInitDialog();         ///< initialize dialog handler
   afx_msg void OnHelp();               ///< Help handler
   afx_msg void OnKillfocusBufferoutname(); ///< Output buffer name handler
   afx_msg void OnTimer(UINT nIDEvent); ///< handler for embedded help timer
   afx_msg void OnDestroy();            ///< handler to remove embedded help timer
   //}}AFX_MSG

   /**
    * get the (help) id of the dialog's control under the mouse cursor.
    */
   LRESULT OnRelayEvent( WPARAM wParam, LPARAM lParam );

   DECLARE_MESSAGE_MAP()

   /**
    * user interface to select a buffer.
    */
   CScanBaseBufferPtr BrowseForScanBuffer();

protected:
   /**
    * the filter.
    */
   CScanFilter* m_pFilter;

   /**
    * the document.
    */
   CDocument* m_pDoc;

   /**
    * dialog is a ModalEdit.
    */
   bool m_bInEditModeless;

   /**
    * dialog initialization has completed.
    */
   bool m_bInitialized;

   /**
    * keep track of current mouse-over help id.
    */
   int m_curHelpId;

   /**
    * current timer id.
    */
   UINT m_timerHelpId;

private:
   //{{AFX_DATA(CFilterDlg)
   enum { IDD = IDD_FILTERDLG };
   //}}AFX_DATA

   enum { HOVER_DELAY = 300, };         // milliseconds before embedded help window changes
};

//{{AFX_INSERT_LOCATION}}
// Microsoft Visual C++ will insert additional declarations immediately before the previous line.

/// @} cfl_scanfilterdialog

/*
 * set filter and document; NULL for pDoc sets edit modeless flag.
 */
inline void CFilterDlg::SetParameters( CScanFilterPtr pFilter, CDocument* pDoc )
{
   m_pFilter = pFilter;
   m_pDoc    = pDoc;
   
   if ( NULL == pDoc )
   {
      SetEditModeless();
   }
}

/*
 * dialog is being used for EditModeless.
 */
inline void CFilterDlg::SetEditModeless()
{
   m_bInEditModeless = true;
}

/*
 * true if in EditModeless().
 */
inline bool CFilterDlg::InEditModeless()
{
   return m_bInEditModeless;
}

#endif // #ifndef CFL_FILTERDLG_H

/*
 * end of file
 */

---