FmtString Struct Reference

#include <evo/impl/str.h>

Detailed Description

Explicitly format a string.

• Used with operator<<() on String, Stream, and StreamOut
  • See String Formatting and Stream Formatting

Public Types
typedef FmtString	FmtFieldType
	This type paired with field info. More...
typedef ListBase< char, StrSizeT >	StringBase
	StringBase type. More...
typedef FmtString	This
	This type More...

Public Member Functions
	FmtString (const char *str, FmtAlign align=fLEFT)
	Constructor. More...
	FmtString (const char *str, StrSizeT size, int width=-1, char ch=0)
	Constructor. More...
	FmtString (const char *str, StrSizeT size, FmtAlign align, int width=-1, char ch=0)
	Constructor. More...
	FmtString (const StringBase &str, int width=-1, char ch=0)
	Constructor. More...
	FmtString (const StringBase &str, FmtAlign align, int width=-1, char ch=0)
	Constructor. More...
	FmtString (const FmtString &str, FmtAlign align, int width, char ch=0)
	Constructor with override fields for compatibility with FmtFieldType. More...
This &	width (int width, char ch=0)
	Helper for setting padding attributes. More...

Public Attributes
FmtSetField	fmt
StringBase	str

Member Typedef Documentation

FmtFieldType

typedef FmtString FmtFieldType

This type paired with field info.

StringBase

typedef ListBase<char,StrSizeT> StringBase

StringBase type.

This

typedef FmtString This

This type

Constructor & Destructor Documentation

FmtString() [1/6]

FmtString ( const char *  str, FmtAlign  align = fLEFT  )

inline

Constructor.

Parameters

str	String pointer to format, must be terminated
align	Alignment type for string – see FmtAlign

FmtString() [2/6]

FmtString ( const char *  str, StrSizeT  size, int  width = -1, char  ch = 0  )

inline

Constructor.

Parameters

str	String pointer to format
size	String size to format
width	Width to format within, -1 for default
ch	Padding character to fill in width around string, 0 for default

FmtString() [3/6]

FmtString ( const char *  str, StrSizeT  size, FmtAlign  align, int  width = -1, char  ch = 0  )

inline

Constructor.

Parameters

str	String pointer to format
size	String size to format
align	Alignment type for string – see FmtAlign
width	Width to format within, -1 for default
ch	Padding character to fill in width around string, 0 for default

FmtString() [4/6]

FmtString ( const StringBase &  str, int  width = -1, char  ch = 0  )

inline

Constructor.

Parameters

str	String to format
width	Width to format within, -1 for default
ch	Padding character to fill in width around string, 0 for default

FmtString() [5/6]

FmtString ( const StringBase &  str, FmtAlign  align, int  width = -1, char  ch = 0  )

inline

Constructor.

Parameters

str	String to format
align	Alignment type for string – see FmtAlign
width	Width to format within, -1 for default
ch	Padding character to fill in width around string, 0 for default

FmtString() [6/6]

FmtString ( const FmtString &  str, FmtAlign  align, int  width, char  ch = 0  )

inline

Constructor with override fields for compatibility with FmtFieldType.

Parameters

str	String to format
align	Alignment type for string – see FmtAlign
width	Width to format within, -1 for default
ch	Padding character to fill in width around string, 0 for default

Member Function Documentation

width()

This& width ( int  width, char  ch = 0  )

inline

Helper for setting padding attributes.

Parameters

width	Width to format within, -1 for default
ch	Padding character to fill in width around string, 0 for default

Returns

This

Member Data Documentation

fmt

FmtSetField fmt

str

StringBase str

---

The documentation for this struct was generated from the following file:

• evo/impl/str.h