Click here to Skip to main content
Click here to Skip to main content
Add your own
alternative version
Go to top

The Ultimate Toolbox - Updates and User Contributions

, 12 Feb 2013
Updates and User Contributions for the Ultimate Toolbox Libraries
OutlookDemoUpdate.zip
Ultimate Grid
Demos
OutlookStyle
OutlookStyle.aps
OutlookStyle.dsp
OutlookStyle.dsw
OutlookStyle.suo
res
bitmap1.bmp
bmattach.bmp
bmp00001.bmp
bmp00002.bmp
bmp00003.bmp
Flags.bmp
OutlookStyle.ico
OutlookStyleDoc.ico
Toolbar.bmp
toolbar1.bmp
toolbar2.bmp
toolbarf.bmp
UltimateGrid72_Src_Update01.zip
CellTypes
Include
Source
UltimateGrid72_Src_Update02.zip
DataSources
ODBC
OleDB
EditControls
UltimateGrid72_Src_Update03.zip
UltimateGrid72_Src_Update04.zip
UltimateGrid73_src.zip
BuildDLL
Build DLL.dsp
Build DLL.dsw
res
BuildLib
ugmfclib.dsp
ugmfclib.dsw
Lib
Skel
UltimateTCP-IP42_Src_Update01.zip
Ultimate TCP-IP
Include
Security
Include
Source
source
UltimateTCP-IP42_Src_Update02.zip
Examples
Client
Mail
icon1.ico
icon2.ico
MailClientS.suo
test.dsp
test.dsw
UltimateTCP-IP42_Src_Update03.zip
ultimatetoolbox93_src_update01.zip
Ultimate Toolbox
include
source
UltimateToolbox93_Src_Update02.zip
lib
Build DLLs
Build Libs
UltimateToolbox93_Src_Update03.zip
UltimateToolbox93_Src_Update04.zip
UltimateToolbox93_Src_Update05.zip
// ==========================================================================
// 							Class Specification : CUTMaskedEdit
// ==========================================================================

//// This software along with its related components, documentation and files ("The Libraries")
// is � 1994-2007 The Code Project (1612916 Ontario Limited) and use of The Libraries is
// governed by a software license agreement ("Agreement").  Copies of the Agreement are
// available at The Code Project (www.codeproject.com), as part of the package you downloaded
// to obtain this file, or directly from our office.  For a copy of the license governing
// this software, you may contact us at legalaffairs@codeproject.com, or by calling 416-849-8900.
                          
// //////////////////////////////////////////////////////////////////////////

// Properties:
//	NO	Abstract class (does not have any objects)
//	YES	Derived from CEdit

//	YES	Is a Cwnd.                     
//	YES	Two stage creation (constructor & Create())
//	YES	Has a message map
//	NO	Needs a resource (template)

//	NO	Persistent objects (saveable on disk)      
//	NO	Uses exceptions

// //////////////////////////////////////////////////////////////////////////

// Desciption :         
//  The Masked Edit control provides restricted data input as well as formatted data output. 
//  This control supplies visual cues about the type of data being entered or displayed.
//  
//  The Masked Edit control generally behaves as a standard text box control with enhancements 
//  for optional masked input and formatted output. If you don't use an input mask, the Masked 
//  Edit control behaves much like a standard text box.
//  
//  If you define an input mask, each character position in the Masked Edit control maps to either 
//  a placeholder of a specified type or a literal character. Literal characters, or literals, can 
//  give visual cues about the type of data being used. For example, the parentheses surrounding 
//  the area code of a telephone number are literals: (206).
//  
//  If you attempt to enter a character that conflicts with the input mask, the control generates a 
//  ValidationError beep. We could throw an exception but I think this is too heavy.  The input mask 
//  prevents you from entering invalid characters into the control.
//  
//  When you define an input mask, the Masked Edit control behaves differently from the standard text box. 
//  The insertion point automatically skips over literals as you enter data or move the insertion point.
//  
//  When you insert or delete a character, all nonliteral characters to the right of the insertion point 
//  are shifted, as necessary. If shifting these characters leads to a validation error, the insertion or 
//  deletion is prevented, and a ValidationError beep is triggered.
//  
//  Suppose the Mask property is defined as "?###", and the current value of the Text property is "A12." 
//  If you attempt to insert the letter "B" to the left of the letter "A," the "A" would shift to the right. 
//  Since the second value of the input mask requires a number, the letter "A" would cause the control to 
//  generate a ValidationError beep.
//  
//  The Masked Edit control also validates the parameter value of the SetInputText function the user passes 
//  at run time. If you use the SetInputText function so that it conflicts with the input mask, the function 
//  will return an errorcode.
//  
//  You may select text in the same way as for a standard text box control. When selected text is deleted, 
//  the control attempts to shift the remaining characters to the right of the selection. However, any 
//  remaining character that might cause a validation error during this shift is deleted, and no 
//  ValidationError beep is generated.
//  
//  Normally, when a selection in the Masked Edit control is copied onto the Clipboard, the entire selection, 
//  including literals, is transferred onto the Clipboard. You can use the SetClipMode function to define the 
//  behavior for transferring only user-entered data onto the Clipboard or not - literal characters that are 
//  part of the input mask are not copied.
//  
//  You are able to attach a CUTMaskedEdit to an existing edit control by subclassing the latter. 

//  Mask character  Description 
//  --------------  ----------------------------------------------------------------------------------------------
//        #         Digit placeholder. (0-9)
//  
//        .         Decimal placeholder. The actual character used is the one specified as the decimal placeholder 
//                  in your international settings. This character is treated as a literal for masking purposes.
//  
//        ,         Thousands separator. The actual character used is the one specified as the thousands separator 
//                  in your international settings. This character is treated as a literal for masking purposes.
//  
//        :         Time separator. The actual character used is the one specified as the time separator in your 
//                  international settings. This character is treated as a literal for masking purposes.
//  
//        /         Date separator. The actual character used is the one specified as the date separator in your 
//                  international settings. This character is treated as a literal for masking purposes.
//  
//        A         Alphanumeric character placeholder (0-9 and a-Z)
//  
//        &         Character placeholder. Valid values for this placeholder are ANSI characters in the following 
//                  ranges: 32-126 and 128-255.
//  
//        ?         Alphabetic placeholder (a-Z)
//  
//        >         Alphabetic placeholder, but forces them to Uppercase chars (A-Z)
//  
//        <         Alphabetic placeholder,  but forces them to lowercase (a-z)
//  
//        \         Treat the next character in the mask string as a literal. This allows you to include 
//                  the '#', '&', 'A', '<', '>',and '?' characters in the mask. This character is treated as a 
//                  literal for masking purposes.
//  
//  Literal         All other symbols are displayed as literals; that is, as themselves.

// Remark:
//		***

// Prerequisites (necessary conditions):
//		***

/////////////////////////////////////////////////////////////////////////////
#ifndef __UTMaskedEdit_h__
#define __UTMaskedEdit_h__

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

//#include "OXDllExt.h"
#ifndef UG_CLASS_DECL
#define UG_CLASS_DECL
#endif

#include "ugctrl.h"


#ifndef __AFXTEMPL_H__
#include <afxtempl.h>
#define __AFXTEMPL_H__
#endif


#ifndef WM_OX_APP
// You can redefine WM_OX_APP by defining it before including this file
#define WM_OX_APP					WM_APP + 100
#endif
// validation notification sent to parent window 
#ifndef OXMEN_VALIDATE
#define OXMEN_VALIDATE				(WM_OX_APP + 210)
#endif

// for OXMEN_VALIDATE notification we supply our structure where:
//		hdr					-	standard NMHDR structure
//		bValid				-	result of validation (TRUE - valid, FALSE - invalid)
//		bDefaultValidation	-	if equals TRUE and bValid is TRUE still control defined
//								virtual OnValidate function will be called
//		nPosition			-	real position where cursor should be set if bValid is FALSE
typedef struct tagMENMHDR
{
	NMHDR hdr;
	BOOL bValid;
	BOOL bDefaultValidation;
	int nPosition;
} MENMHDR, *LPMENMHDR;

const TCHAR chNULL   = _T('\0') ;
const TCHAR chCR     = _T('\r') ;
const TCHAR chLF     = _T('\n') ;
const TCHAR chSPACE  = _T(' ' ) ;
const TCHAR chPERIOD = _T('.' ) ;
const TCHAR chCOMMA  = _T(',' ) ;
const TCHAR chCOLON  = _T(':' ) ;
const TCHAR chSLASH  = _T('/' ) ;

/////////////////////////////////////////////////////////////////////////////
// CMaskData object

const TCHAR chMaskPlaceholderDECIMALSEPARATOR   = _T('.')  ;
const TCHAR chMaskPlaceholderTHOUSANDSSEPARATOR = _T(',')  ;
const TCHAR chMaskPlaceholderTIMESEPARATOR      = _T(':')  ;
const TCHAR chMaskPlaceholderDATESEPARATOR      = _T('/')  ;
const TCHAR chMaskPlaceholderDIGIT              = _T('#')  ;
const TCHAR chMaskPlaceholderALPHANUMERIC       = _T('A')  ;
const TCHAR chMaskPlaceholderALPHABETIC         = _T('?')  ;
const TCHAR chMaskPlaceholderALPHABETICUPPER    = _T('>')  ;
const TCHAR chMaskPlaceholderALPHABETICLOWER    = _T('<')  ;
const TCHAR chMaskPlaceholderCHARACTER          = _T('&')  ;
const TCHAR chMaskPlaceholderLITERALESCAPE      = _T('\\') ;

enum enumMaskDataType
{
	MaskDataTypeDECIMALSEPARATOR=0,  // Decimal separator. 
	MaskDataTypeTHOUSANDSSEPARATOR,  // Thousands separator. 
	MaskDataTypeTIMESEPARATOR     ,  // Time separator. 
	MaskDataTypeDATESEPARATOR     ,  // Date separator. 
	MaskDataTypeDIGIT             ,  // # digit placeholder (0-9). 
	MaskDataTypeALPHANUMERIC      ,  // A alphanumeric character placeholder (0-9 and a-Z). 
	MaskDataTypeALPHABETIC        ,  // ? Alphabetic placeholder (a-Z). 
	MaskDataTypeALPHAETICUPPER    ,  // > Alphabetic placeholder, but forced to Uppercase characters (A-Z). 
	MaskDataTypeALPHAETICLOWER    ,  // < Alphabetic placeholder, but forced to Lowercase characters (a-z). 
	MaskDataTypeCHARACTER         ,  // # character placeholder (ANSI characters 32-126 and 128-255). 
	MaskDataTypeLITERALESCAPE     ,  // All other symbols are displayed as themselves. 
	MaskDataTypeLITERAL           ,  // All other symbols are displayed as themselves. 
	MASKDATATYPECOUNT
} ;

class UG_CLASS_DECL CMaskData : public CObject
{
	DECLARE_DYNCREATE(CMaskData)
	
public:
	CMaskData() ;

// Attributes
public:
	enumMaskDataType m_eType   ;
	TCHAR            m_chValue ;
	
// Operations
public:
	void  operator=(const CMaskData& src) ;
	BOOL  IsInputData   () ;
	BOOL  IsValidInput  (TCHAR chNewChar) ;
	TCHAR PreProcessChar(TCHAR chNewChar) ;
	
	// Diagnostic Support
#ifdef _DEBUG
public:
	virtual void AssertValid() const ;
	virtual void Dump(CDumpContext& dc) const ;
#endif
};

/////////////////////////////////////////////////////////////////////////////
// CUTMaskedEdit window

class UG_CLASS_DECL CUTMaskedEdit : public CUGEditBase
{
	DECLARE_DYNAMIC(CUTMaskedEdit)

// Data members -------------------------------------------------------------
protected:
	CTypedPtrList<CObList, CMaskData*> m_listData;
	BOOL m_bInsertMode;
	TCHAR m_chPromptSymbol;
	TCHAR m_chIntlDecimal;
	TCHAR m_chIntlThousands;
	TCHAR m_chIntlTime;
	TCHAR m_chIntlDate;
	BOOL m_bAutoTab;	

	int m_nSetTextSemaphor;
	int m_bNotifyParent;
	
// Member functions ---------------------------------------------------------
public:
	// --- In     : pszMask - A Mask can already be specified at construction time.
	// --- Out    :
	// --- Returns:
	// --- Effect : Constructs the object
	CUTMaskedEdit(LPCTSTR pszMask=_T("")) ;
	
	// --- In     :
	// --- Out    :
	// --- Returns:
	// --- Effect : Destructor of the object
	virtual ~CUTMaskedEdit() ;
	
	// --- In     : dwStyle    - edit control styles. 
	//            : rect       - edit control size and position. 
	//            : pParentWnd - edit control parent window. 
	//            : nID        - edit control ID. 
	// --- Out    : 
	// --- Returns:	True on success. 
	// --- Effect : Same as CEdit create except that it sets the mask after creation. 
	BOOL Create(DWORD dwStyle, const RECT& rect, CWnd* pParentWnd, UINT nID) ;
	
public:
	// --- In     :
	// --- Out    : 
	// --- Returns:	the current mask. 
	// --- Effect : 
	CString GetMask() const ;
	
	// --- In     : pszMask - new mask. 
	// --- Out    :
	// --- Returns:
	// --- Effect : Changing the mask may empty a possible filled masked edit. 
	void    SetMask(LPCTSTR pszMask=_T("")) ;

	// --- In     :
	// --- Out    :
	// --- Returns: The fully formated mask with all input data. 
	// --- Effect : 
	CString ShowMask() const ;

	// --- In     :
	// --- Out    :
	// --- Returns:	string that represent pure data that was typed in excluding literals
	// --- Effect : 
	CString GetInputData() const ;
	
	// --- In     :	lpszText	-	string to be stripped by applying the current mask
	// --- Out    :
	// --- Returns:	string that represent pure data in the specified string 
	//				excluding literals
	// --- Effect : 
	CString GetInputData(LPCTSTR lpszText) const ;
	
	// --- In     : pszInputData - Each character is entered into the control as if the user typed it in. 
	//            : nBeginPos    - Begin position for inserting or overwriting the Insert symbols in the mask. 
	//            : bAllowPrompt - whether or not the prompt symbol is a valid input character. 
	// --- Out    :
	// --- Returns: True if some data was inserted. 
	// --- Effect : Use to programmatically insert pszInputData into the masked edit control. 
	//            : The mask is applied to the Inputdata. 
	BOOL    SetInputData(LPCTSTR pszInputData, int nBeginPos=0, BOOL bAllowPrompt=TRUE) ;

	// --- In     :
	// --- Out    :
	// --- Returns: the current prompt symbol. 
	// --- Effect : 
	TCHAR   GetPromptSymbol() ;
	
	// --- In     : chNewPromptSymbol - new prompt symbol cannot be null, carriage return or line feed. 
	// --- Out    :
	// --- Returns:
	// --- Effect : The default is a space. 
	void    SetPromptSymbol(TCHAR chNewPromptSymbol) ;
	
	// --- In     : bOnlyInput - set to true to clear just the data. 
	// --- Out    :
	// --- Returns:
	// --- Effect : Clears the contents of the masked edit.  Depending on the bOnlyInput clears all data (mask + input) or only input data
	void    EmptyData(BOOL bOnlyInput=FALSE) ;

	// --- In     : 
	// --- Out    :
	// --- Returns:	TRUE if the control has only mask and prompt symbols, 
	//				or FALSE otherwise
	// --- Effect : Retrieves the flag that specifies whether the control
	//				is populated with some text other than mask or prompt 
	//				symbols or not
	BOOL	IsInputEmpty() ;

	// --- In     :
	// --- Out    :
	// --- Returns: The insert mode. 
	// --- Effect : 
	BOOL    GetInsertMode() const ;
	
	// --- In     :
	// --- Out    :
	// --- Returns:
	// --- Effect : Changes the insert mode. 
	void    SetInsertMode(BOOL bInsertMode) ;

	// --- In     :
	// --- Out    :
	// --- Returns:
	// --- Effect : This function gets called when a user error occurs. 
	virtual void ValidationError() ;
	
	// --- In     :
	// --- Out    :
	// --- Returns: if data is valid  
	// --- Effect : This function gets called when control lost focus. User can 
	// ---			validate data typed in the control
	virtual BOOL OnValidate() ;
	
	// --- In     :
	// --- Out    :
	// --- Returns: TRUE if AutoTab mode is set, or FALSE otherwise. 
	// --- Effect : 
	BOOL    GetAutoTab() const ;
	
	// --- In     :	bAutoTab	-	if TRUE then set the control in AutoTab mode,
	//								orthewise set control in Normal mode	
	// --- Out    :
	// --- Returns:
	// --- Effect : Changes the AutoTab mode. If AutoTab mode is set then when 
	//				the last allowed symbol is typed the focus goes to next 
	//				control with WS_TABSTOP style. AutoTab mode is not set by default
	void    SetAutoTab(BOOL bAutoTab) ;

	// --- In     :	nRealPos	-	real position in edit control (taking into account 
	//								all symbols including literals)
	// --- Out    :
	// --- Returns: corresponding logical position (taking into account only 
	//				non-literals) or -1 if real position corresponds to literal. 
	// --- Effect : convert real position within masked edit control to corresponding
	//				logical one
	int    RPtoLP(int nRealPos) const ;
	
	// --- In     :	nLogicalPos	-	logical position in edit control (taking into 
	//								account only non-literals)
	// --- Out    :
	// --- Returns: corresponding real position (taking into account all symbols 
	//				including literals) or -1 if nLogicalPos is not valid logical 
	//				position. 
	// --- Effect : convert logical position within masked edit control to 
	//				corresponding real one
	int    LPtoRP(int nLogicalPos) const ;

// Internal Member functions ------------------------------------------------
protected:
	void    DeleteContents() ;
	
	BOOL    IsInputData(int nPosition) const ;

	int     DeleteRange             (int nSelectionStart, int nSelectionEnd) ;
	int     InsertAt                (int nSelectionStart, TCHAR chNewChar  ) ;
	int     SetAt                   (int nSelectionStart, TCHAR chNewChar  ) ;
	int     GetNextInputLocation    (int nSelectionStart) ;
	int     GetPreviousInputLocation(int nSelectionStart) ;
	int     GetEmptyInputLocation   (int nSelectionStart) ;

	void    Update                      (int nSelectionStart=0) ;  // UpdateInsertionPoint is automatic. 
	void    UpdateInsertionPointForward (int nSelectionStart) ;
	void    UpdateInsertionPointBackward(int nSelectionStart) ;

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

	BOOL NotifyParent(UINT nNotificationID);

	
// Generated message map functions
protected:
	//{{AFX_MSG(CUTMaskedEdit)
	afx_msg void OnKeyDown (UINT nChar, UINT nRepCnt, UINT nFlags) ;
	afx_msg void OnChar    (UINT nChar, UINT nRepCnt, UINT nFlags) ;
	afx_msg void OnSetFocus(CWnd* pOldWnd) ;
	afx_msg void OnKillfocus();
	afx_msg void OnLButtonDown(UINT nFlags, CPoint point);
	//}}AFX_MSG
	// v7.2 - update 02 - 64-bit - changed these from LONG, UINT, LONG to LRESULT, WPARAM, LPARAM
	afx_msg LRESULT OnCut(WPARAM wParam, LPARAM lParam) ;
	afx_msg LRESULT OnCopy(WPARAM wParam, LPARAM lParam) ;
	afx_msg LRESULT OnPaste(WPARAM wParam, LPARAM lParam) ;
	afx_msg LRESULT OnClear(WPARAM wParam, LPARAM lParam) ;
	afx_msg LRESULT OnSetText(WPARAM wParam, LPARAM lParam) ;
	
	DECLARE_MESSAGE_MAP()
};

#endif // __UTMaskedEdit_h__
/////////////////////////////////////////////////////////////////////////////

By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.

If a file you wish to view isn't highlighted, and is a text file (not binary), please let us know and we'll add colourisation support for it.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Share

About the Author

The Ultimate Toolbox
Web Developer
Canada Canada
In January 2005, David Cunningham and Chris Maunder created TheUltimateToolbox.com, a new group dedicated to the continued development, support and growth of Dundas Software’s award winning line of MFC, C++ and ActiveX control products.
 
Ultimate Grid for MFC, Ultimate Toolbox for MFC, and Ultimate TCP/IP have been stalwarts of C++/MFC development for a decade. Thousands of developers have used these products to speed their time to market, improve the quality of their finished products, and enhance the reliability and flexibility of their software.
Group type: Organisation

387 members


| Advertise | Privacy | Mobile
Web04 | 2.8.140926.1 | Last Updated 13 Feb 2013
Article Copyright 2008 by The Ultimate Toolbox
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid