Filter Library

Camera

Interface Physics

ControlNumSpinCtrl.h

/*
 * ControlNumSpinCtrl.h - a spin control for real numbers.
 *
 * This file is part of the Camera Filter Library.
 * Computer Aided Measurement Environment for Realtime Atomic imaging (Camera)
 *
 * Copyright (C) 2004-2005, Leiden Probe Microscopy.
 * Copyright (C) 2004-2005, Universiteit Leiden.
 *
 * This spin control is based on:
 * CNumSpinCtrl - a simple numeric spin control, By Damir Valiulin
 * See http://www.codeproject.com/miscctrl/numspinctrl.asp
 *
 * Authors: Martin J. Moene (original)
 *
 * $Id: ControlNumSpinCtrl.h 202 2005-05-12 11:00:48Z moene $
 */

#ifndef CFL_CONTROLNUMSPINCTRL_H
#define CFL_CONTROLNUMSPINCTRL_H

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

/**
 * \addtogroup cfl_controlnumspincontrol Numeric Spin Control
 * \brief numeric spin control.
 *
 * This section contains a numeric spin control class:
 * - CNumSpinCtrl
 *
 * Usually the spin control is combined with a \ref cfl_controlnumedit to display
 * the numeric value. Special about CNumSpinCtrl is that it allows you to spin real
 * numbers.
 *
 * Here is how you may use a spin control of type CNumSpinCtrl in a dialog.
 * \code
 * // mydialog.h - header
 *
 * class MyDialog
 * {
 * public:
 *    MyDialog( CWnd* pParent = NULL );
 *
 * protected:
 *    virtual void DoDataExchange( CDataExchange* pDX );
 *
 *    //{{AFX_MSG(MyDialog)
 *    virtual BOOL OnInitDialog();
 *    afx_msg void OnChangeFactor();
 *    afx_msg void OnDeltaposFactor( NMHDR* pNMHDR, LRESULT* pResult );
 *    //}}AFX_MSG
 *    DECLARE_MESSAGE_MAP()
 *
 * private:
 *    CIntegerEdit c_txtFactor;
 *    CNumSpinCtrl c_spnFactor;
 *    bool         initialized;
 * };
 * \endcode
 *
 * Please note the member variable \c initialized. Under some circumestances
 * messages start coming, while not all controls are fully initialized and
 * messages should not be handled yet. This happens for example when you
 * auto-buddy an edit control with a spin control.
 * (See also \ref newcomer_avoidgetdlgitem "[GETDLGITEM]".)
 *
 * \code
 * // mydialog.cpp - implementation
 *
 * MyDialog::MyDialog( CWnd* pParent ) :
 *    c_txtFactor( true   ),  // signed
 *    initialized( false  )   // don't handle messages yet; see OnInitDialog()
 * {
 *    //{{AFX_DATA_INIT(MyDialog)
 *    //}}AFX_DATA_INIT
 * }
 *
 * void MyDialog::DoDataExchange( CDataExchange* pDX )
 * {
 *    CDialog::DoDataExchange(pDX);
 *    //{{AFX_DATA_MAP(MyDialog)
 *    DDX_Control(pDX, IDC_MYDIALOG_TEXTFACTOR, c_txtFactor );
 *    DDX_Control(pDX, IDC_MYDIALOG_SPINFACTOR, c_spnFactor );
 *    //}}AFX_DATA_MAP
 * }
 *
 * BEGIN_MESSAGE_MAP( MyDialog )
 *    //{{AFX_MSG_MAP(MyDialog)
 *    ON_EN_CHANGE( IDC_MYDIALOG_TEXTFACTOR, OnChangeFactor )
 *    ON_NOTIFY   ( UDN_DELTAPOS, IDC_MYDIALOG_SPINFACTOR, OnDeltaposFactor )
 *    //}}AFX_MSG_MAP
 * END_MESSAGE_MAP()
 *
 * BOOL MyDialog::OnInitDialog()
 * {
 *    CFilterDlg::OnInitDialog();
 *
 *    c_spnFactor.SetRangeAndDelta( -1, 1, 0.01 );
 *    c_spnFactor = 0.1;
 *
 *    UpdateData( FALSE ); // transfer data from variables to controls
 *
 *    initialized = true;  // dialog initialized
 *
 *    return TRUE;         // we set the focus
 * }
 *
 * // optional handler for c_txtFactor:
 *
 * void CFilterDlg_Clad::OnChangeFactor()
 * {
 *     // ensure dialog has been initialized:
 *
 *    if ( !initialized )
 *       return ;
 *
 *    //  Transfer data from controls to filter variables:
 *
 *    Q_ASSERT( 0 != UpdateData() );
 *
 *    //
 *    // put your event handling code here, if any.
 *    //
 * }
 *
 * // optional handler for c_spnFactor:
 *
 * void MyDialog::OnDeltaposFactor( NMHDR* pNMHDR, LRESULT* pResult )
 * {
 *    // ensure dialog has been initialized:
 *
 *    if ( !initialized )
 *       return ;
 *
 *    NM_UPDOWN* pNMUpDown = (NM_UPDOWN*)pNMHDR;
 *
 *    //
 *    // put your event handling code here, if any.
 *    //
 *
 *    *pResult = 0;        // result
 * }
 * \endcode
 *
 * Note that the entries for c_txtFactor and c_spnFactor in DoDataExchange() are
 * required for the typical behaviour of these controls.
 * Handlers OnChangeFactor and OnDeltaposFactor() are only needed if you want to
 * do something special when the edit control changes or when the spin button is
 * pressed.
 *
 * @{
 */

DECLARE_CLASS( CNumSpinCtrl );          // declare various types for class

/**
 * a spin control for real numbers.
 *
 * CNumSpinCtrl is a spin control for real numbers that can be combined with a
 * \ref cfl_controlnumedit.
 *
 * Class CNumSpinCtrl enables you to:
 * - get and set the range to spin and the delta, e.g. SetRangeAndDelta(),
 * - set the format string to represent the number in a buddy control, SetFormat()
 * - get and set a new position, e.g. GetPos(), operator double(), operator=()
 * - increase or decrease the position with delta, operator++(), operator--()
 *
 * Make sure that the control is included in method DoDataExchange() of the
 * dialog classes where you use the spin control.
 *
 * Class CNumSpinCtrl is a slightly modified version of the class CNumSpinCtrl by
 * Damir Valiulin \ref valiulin_numspinctrl "[NUMSPINCTRL]".
 */

class CNumSpinCtrl : public CSpinButtonCtrl
{
   typedef CNumSpinCtrl self;           ///< this type

   DECLARE_DYNAMIC( CNumSpinCtrl )

public:
   typedef double real_type;            ///< real number type
   typedef long   integer_type;         ///< integer number type

   ///
   /// \name Construction
   /// @{

   CNumSpinCtrl();
   virtual ~CNumSpinCtrl();

   /// @}
   /// \name Operators
   /// @{

   operator     double       ();
   operator     int          ();
   operator     long         ();
   operator     unsigned long();

   self&        operator=    ( double        value );
   self&        operator=    ( int           value );
   self&        operator=    ( long          value );
   self&        operator=    ( unsigned long value );

   self&        operator++   ()    ;
   void         operator++   (int) ;
   self&        operator--   ()    ;
   void         operator--   (int) ;

   /// @}
   /// \name Predicates
   /// @{

   /// @}
   /// \name Accessors
   /// @{

   void         GetRangeAndDelta( real_type& lower, real_type& upper, real_type& delta );

   double       GetPos( );
   integer_type GetPosInt();

   /// @}
   /// \name Mutators
   /// @{

   void         SetRangeAndDelta( real_type lower, real_type upper, real_type delta );

   void         SetPos( double        value );
   void         SetPos( int           value );
   void         SetPos( long          value );
   void         SetPos( unsigned long value );

   void         SetFormat( LPCTSTR lpszFormatString = NULL );

   void         Select();

   /// @}

   // ClassWizard generated virtual function overrides
   //{{AFX_VIRTUAL(CNumSpinCtrl)
protected:
   virtual void PreSubclassWindow();
   //}}AFX_VIRTUAL

protected:
   void         InitSpinCtrl();
   void         SetIntPos (real_type pos);
   void         SetValueForBuddy (real_type val);

protected:
   //{{AFX_MSG(CNumSpinCtrl)
   afx_msg BOOL OnDeltapos( NMHDR* pNMHDR, LRESULT* pResult );
   afx_msg int  OnCreate  ( LPCREATESTRUCT lpCreateStruct   );
   //}}AFX_MSG

   DECLARE_MESSAGE_MAP()

protected:
   real_type    m_MinVal;               ///< minimum value
   real_type    m_MaxVal;               ///< maximum value
   real_type    m_Delta;                ///< stepping value
   UINT         m_IntRange;             ///< minimum value
   CString      m_csFormat;             ///< printf format string
};

//{{AFX_INSERT_LOCATION}}
// Microsoft Developer Studio will insert additional declarations immediately before the previous line.

/// @} cfl_controlnumspincontrol

/**
 * convert to double.
 */

inline CNumSpinCtrl::operator double()
{
   return GetPos();
}

/**
 * convert to int.
 */

inline CNumSpinCtrl::operator int()
{
   return GetPosInt();
}

/**
 * convert to long.
 */

inline CNumSpinCtrl::operator long()
{
   return GetPosInt();
}

/**
 * convert to unsigned long.
 */

inline CNumSpinCtrl::operator unsigned long()
{
   return GetPosInt();
}

/**
 * assign double.
 */

inline CNumSpinCtrl::self& CNumSpinCtrl::operator=( double value )
{
   SetPos( value );
   return *this;
}

/**
 * assign int.
 */

inline CNumSpinCtrl::self& CNumSpinCtrl::operator=( int value )
{
   SetPos( value );
   return *this;
}

/**
 * assign long.
 */

inline CNumSpinCtrl::self& CNumSpinCtrl::operator=( long value )
{
   SetPos( value );
   return *this;
}

/**
 * assign unsigned long.
 */

inline CNumSpinCtrl::self& CNumSpinCtrl::operator=( unsigned long value )
{
   SetPos( value );
   return *this;
}

/**
 * pre-increment with delta.
 */

inline CNumSpinCtrl::self& CNumSpinCtrl::operator++()
{
   SetPos( GetPos() + m_Delta );
   return *this;
}

/**
 * post-increment with delta (returns void).
 */

inline void CNumSpinCtrl::operator++(int)
{
   this->operator++();
}

/**
 * pre-decrement with delta.
 */

inline CNumSpinCtrl::self& CNumSpinCtrl::operator--()
{
   SetPos( GetPos() - m_Delta );
   return *this;
}

/**
 * post-decrement with delta (returns void).
 */

inline void CNumSpinCtrl::operator--(int)
{
   this->operator--();
}

/**
 * the current position as integer.
 */

inline CNumSpinCtrl::integer_type CNumSpinCtrl::GetPosInt()
{
   return static_cast<integer_type>( GetPos() );
}

/**
 * set the new positon.
 */

inline void CNumSpinCtrl::SetPos( int value )
{
   SetPos( static_cast<real_type>( value ) );
}

/**
 * set the new positon.
 */

inline void CNumSpinCtrl::SetPos( long value )
{
   SetPos( static_cast<real_type>( value ) );
}

/**
 * set the new positon.
 */

inline void CNumSpinCtrl::SetPos( unsigned long value )
{
   SetPos( static_cast<real_type>( value ) );
}

#endif // CFL_CONTROLNUMSPINCTRL_H

/*
 * end of file
 */

---