MFC Grid manual

CShortFormat Class Reference

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

#include <Dapfor/Common/ShortFormat.h>

Inheritance diagram for CShortFormat:


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

 Format examples:

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

 Output strings:

 1. 1 234
 2. -1 234
 3. 4D2
 4. 0x4D2
 5. 0x04D2

Member Enumeration Documentation

enum Style

Format styles.

Enumerator:

Decimal	Display short as decimal number.
Hex	Display short as hexadecimal number.

Constructor & Destructor Documentation

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

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.

CShortFormat ( const CShortFormat & format )

Copy constructor.

Parameters:

[in] format to be copied

Member Function Documentation

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

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

Parameters:

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

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

Parameters:

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

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

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

Parameters:

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

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

CShortFormat Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation