MFC Grid manual

CLongFormat Class Reference

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

#include <Dapfor/Common/LongFormat.h>

Inheritance diagram for CLongFormat:


Public Types
enum	Style { Decimal, Hex }
	Format styles. More...
Public Member Functions
	CLongFormat (Style=Decimal, bool showZero=true, TCHAR thousandSeparator=_T(' '), bool showHexPrefix=true, bool showNonSignificantZero=false)
	Constructor.
	CLongFormat (const CLongFormat &)
	Copy constructor.
	~CLongFormat ()
	Virtual destructor.
virtual TString	FormatStl (long val, const CDataObject *pDO) const
	The function converts non-formatted value of long type to the formatted string.
virtual bool	ParseStl (const TString &, long &val, const CDataObject *pDO) const
	The function converts the formatted string to the non-formatted value of long type.
virtual CString	FormatMfc (long val, const CDataObject *pDO) const
	The function converts non-formatted value of long type to the formatted MFC string.
virtual bool	ParseMfc (const CString &str, long &val, const CDataObject *pDO) const
	The function converts the formatted MFC string to the non-formatted 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 long-type value to its text presentation and vice versa.

 Format examples:

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

 Output strings:
 1. 1 234 567
 2. -1 234 567
 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

CLongFormat	(	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 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.

CLongFormat ( const CLongFormat & format )

Copy constructor.

Parameters:

[in] format to be copied

Member Function Documentation

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

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

Parameters:

`[in]`	val	Non formatted value of 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,
		long &	val,
		const CDataObject *	pDO
	)			const `[virtual]`

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

Parameters:

`[in]`	str	Formatted string.
`[in,out]`	val	Value of 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	(	long	val,
		const CDataObject *	pDO
	)			const `[virtual]`

The function converts non-formatted value of 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,
		long &	val,
		const CDataObject *	pDO
	)			const `[virtual]`

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

Parameters:

`[in]`	str	MFC string to be formatted.
`[in,out]`	val	A value of the 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

CLongFormat::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

CLongFormat Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation