MFC Grid manual

CULongFormat Class Reference

Transforms unsigned long-type value to its text presentation and vice versa. More...

#include <Dapfor/Common/ULongFormat.h>

Inheritance diagram for CULongFormat:

CFormat

List of all members.


Public Types

enum  Style { Decimal, Hex }
 Format styles. More...

Public Member Functions

 CULongFormat (Style=Decimal, bool showZero=true, TCHAR thousandSeparator=_T(' '), bool showHexPrefix=true, bool showNonSignificantZero=false)
 Constructor.
 CULongFormat (const CULongFormat &)
 Copy constructor.
 ~CULongFormat ()
 Virtual destructor.
virtual TString FormatStl (unsigned long val, const CDataObject *pDO) const
 The function converts non-formatted value of unsigned long type to the formatted string.
virtual bool ParseStl (const TString &, unsigned long &val, const CDataObject *pDO) const
 The function converts the formatted string to the non-formatted value of unsigned long type.
virtual CString FormatMfc (unsigned long val, const CDataObject *pDO) const
 The function converts non-formatted value of unsigned long type to the formatted MFC string.
virtual bool ParseMfc (const CString &str, unsigned long &val, const CDataObject *pDO) const
 The function converts the formatted MFC string to the non-formatted unsigned long-type value.
virtual CFormat * Clone () const
 Creates a deep copy of a format.
virtual void Serialize (CSerializer &serializer)
 Serializes a format.
TCHAR GetSeparator () const
 Gets ASCII symbol, representing a thousand separator.
void SetSeparator (TCHAR chSeparator)
 Sets a new thousand separator.
Style GetStyle () const
 Gets a current style of a format.
void SetStyle (Style style)
 Sets a new format style.

Static Public Member Functions

static int GetSerializeVertion ()
 Serialization version.

Detailed Description

Transforms unsigned long-type value to its text presentation and vice versa. 

 Format examples:

 1. CULongFormat().FormatStl(1234567, 0);
 2. CULongFormat().FormatStl(-1234567, 0);
 3. CULongFormat(CULongFormat.Hex, true, _T(' '), false, false).FormatStl(1234567, 0);
 4. CULongFormat(CULongFormat.Hex, true, _T(' '), true, false).FormatStl(1234567, 0);
 5. CULongFormat(CULongFormat.Hex, true, _T(' '), true, true).FormatStl(1234567, 0);

 Output strings:

 1. 1 234 567
 2. 4 293 732 729
 3. 12D687
 4. 0x12D687
 5. 0x0012D687

Member Enumeration Documentation

enum Style

Format styles.

Enumerator:
Decimal  Display long as decimal number.
Hex  Display long as hexadecimal number.

Constructor & Destructor Documentation

CULongFormat ( Style  style = Decimal,
bool  showZero = true,
TCHAR  thousandSeparator = _T(' '),
bool  showHexPrefix = true,
bool  showNonSignificantZero = false 
)

Constructor.

Parameters:
[in] style Style of a format.
[in] showZero Indicates whether it should show symbols if unformatted value equals to 0.
[in] thousandSeparator ACSII symbol, to separate the thousands.
[in] showHexPrefix indicates whether it should add a hexadecimal prefix '0x'.
[in] showNonSignificantZero indicates whether it should show non-significant zeros in order to keep a constant number of digits for a hexadecimal style.

CULongFormat ( const CULongFormat &  format  ) 

Copy constructor.

Parameters:
[in] format to be copied

Member Function Documentation

TString FormatStl ( unsigned long  val,
const CDataObject *  pDO 
) const [virtual]

The function converts non-formatted value of unsigned long type to the formatted string.

Parameters:
[in] val Non formatted value of unsigned long type.
[in] pDO Pointer to CDataObject. This parameter is optional and may be zero.
Returns:
Formatted string that is a result of conversion.

Reimplemented from CFormat.

bool ParseStl ( const TString &  str,
unsigned long &  val,
const CDataObject *  pDO 
) const [virtual]

The function converts the formatted string to the non-formatted value of unsigned long type.

Parameters:
[in] str Formatted string.
[in,out] val Value of unsigned long type that is a result of conversion.
[in] pDO Pointer to CDataObject. This parameter is optional and may be zero.
Returns:
True, if the string has been successfully parsed. Otherwise false.

Reimplemented from CFormat.

CString FormatMfc ( unsigned long  val,
const CDataObject *  pDO 
) const [virtual]

The function converts non-formatted value of unsigned long type to the formatted MFC string.

Parameters:
[in] val Non-formatted MFC string to be formatted.
[in] pDO Pointer to CDataObject. This parameter is optional and may be zero.
Returns:
Formatted string that is a result of conversion.

Reimplemented from CFormat.

bool ParseMfc ( const CString &  str,
unsigned long &  val,
const CDataObject *  pDO 
) const [virtual]

The function converts the formatted MFC string to the non-formatted unsigned long-type value.

Parameters:
[in] str MFC string to be formatted.
[in,out] val A value of the unsigned long type that is a result of the parsing.
[in] pDO Pointer to CDataObject. This parameter is optional and may be zero.
Returns:
True, if the string has been successfully parsed. Otherwise false.

Reimplemented from CFormat.

CFormat * Clone (  )  const [virtual]

Creates a deep copy of a format.

Returns:
Deep copy of a format object.

Implements CFormat.

void Serialize ( CSerializer &  serializer  )  [virtual]

Serializes a format.

Parameters:
[in] serializer Object, into which a format object is serialized.

Reimplemented from CFormat.

TCHAR GetSeparator (  )  const [inline]

Gets ASCII symbol, representing a thousand separator.

Returns:
Thousand separator

void SetSeparator ( TCHAR  separator  )  [inline]

Sets a new thousand separator.

Parameters:
[in] separator ASCII symbol, representing a thousand separator

CULongFormat::Style GetStyle (  )  const [inline]

Gets a current style of a format.

Returns:
format style

void SetStyle ( Style  style  )  [inline]

Sets a new format style.

Parameters:
[in] style A new format style