Filter Library

Camera

Interface Physics

ControlIntegerEdit.h

/*
 * ControlIntegerEdit.h - an integer entry field.
 *
 * 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: Martin J. Moene (original)
 *
 * $Id: ControlIntegerEdit.h 202 2005-05-12 11:00:48Z moene $
 */

#ifndef CFL_CONTROLINTEGEREDIT_H
#define CFL_CONTROLINTEGEREDIT_H

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

#include <cfl/ControlFilterEdit.h>      // for base class CFilterEdit

/**
 * \addtogroup cfl_controlnumedit Numeric Edit Control
 * \brief numeric edit control.
 *
 * @{
 */

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

/**
 * Class CIntegerEdit is a text edit field for integer number entry and validation.
 *
 * Class CIntegerEdit provides the following facilities:
 * - accept signed or unsigned numbers (also settable in the constructor), SetSigned()
 * - accept base 10 numbers or determine the base from the leading zero (octal),
 *   determine it from the leading 0x (hexadecimal), or use base 10 in the absence
 *   of both (decimal), SetUseBase()
 * - obtain the current value, GetValue(), operator integer()
 * - specify a new value, SetValue(), operator=()
 * - specify the format to display the number in, SetFormat()
 */

class CIntegerEdit : public CFilterEdit
{
   DECLARE_DYNAMIC (CIntegerEdit)

   typedef CIntegerEdit self;           ///< this type

public:
   typedef int integer;                 ///< the integer type

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

   virtual ~CIntegerEdit();
   CIntegerEdit ( bool bSigned = true, bool bUseBase = false );

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

   operator integer() const;

   self& operator= ( integer value );

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

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

   integer GetValue() const;

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

   void    SetValue  ( integer value );

   void    SetSigned ( bool bSigned  = true );
   void    SetUseBase( bool bUseBase = true );
   void    SetFormat ( const char* format = _T("%d") );

   /// @} 

protected:
   virtual bool Check( const CString &csText ) ;
   virtual bool Match( const CString &csText ) ;

private:
   bool    m_bSigned;                   ///< accept signed numbers
   bool    m_bUseBase;                  ///< determina base from leading 0[x]
   CString m_csFormat;                  ///< display format
};

/// @} cfl_controlnumedit

/**
 * destructor.
 */

inline CIntegerEdit::~CIntegerEdit()
{
   ; // do nothing
}

/**
 * (default) constructor.
 */

inline CIntegerEdit::CIntegerEdit( bool bSigned /* = true */, bool bUseBase /* = false */ ) :
   CFilterEdit(), m_bSigned( bSigned ),m_bUseBase( bUseBase ), m_csFormat( "%d" )
{
   ; // do nothing
}

/**
 * convert to integer.
 */

inline CIntegerEdit::operator CIntegerEdit::integer() const
{
   return GetValue();
}

/**
 * assign integer value.
 */

inline CIntegerEdit::self& CIntegerEdit::operator= ( integer value )
{
   SetValue( value );
   return *this;
}

/**
 * get value.
 */

inline CIntegerEdit::integer CIntegerEdit::GetValue() const
{
   return _tcstol( c_str_ptr( *this ), NULL, m_bUseBase ? 0 : 10 );
}

/**
 * set integer value.
 */

inline void CIntegerEdit::SetValue( integer value )
{
   CString txt;
   txt.Format( m_csFormat, value );
   SetWindowText ( txt );
}

/**
 * set number to unsigned, signed (default).
 */

inline void CIntegerEdit::SetSigned ( bool bSigned /* = true */ )
{
   m_bSigned = bSigned;
}

/**
 * set number to use base (0, 0x) for conversion.
 */

inline void CIntegerEdit::SetUseBase( bool bUseBase /* = true */  )
{
   m_bUseBase = bUseBase;
}


/**
 * set the presentation format [\%d].
 */

inline void CIntegerEdit::SetFormat( const char* format /* = "%d" */ )
{
   m_csFormat = format;
}

#endif // CFL_CONTROLINTEGEREDIT_H

/*
 * end of file
 */

---