FmtSetField Struct Reference

#include <evo/impl/str.h>

Detailed Description

Holds field and alignment formatting attributes.

• This is useful for formatting rows of text aligned by columns
  • Fields that are smaller than the field width will be filled with padding up to the width
  • Only numeric values (int, float, etc) and strings count as fields
• Used with operator<<() on String::Format or Stream::Format
  • See String Formatting and Stream Formatting
• Note: Only numeric valus (int, float, etc) and strings count as fields, this doesn't apply to others

Example

#include <evo/io.h>
#include <evo/string.h>
using namespace evo;
static Console& c = con();

int main() {
    // Format to stream
    Stream::Format(c.out) << FmtSetField(fLEFT, 6);
        << "Col A" << "Col B" << NL;
        << 1 << 2 << NL;

    // Format same output to a string
    String str;
    String::Format(str) << FmtSetField(fLEFT, 6)
        << "Col A" << "Col B" << NL;
        << 1 << 2 << NL;

    return 0;
}

Output:

Col A Col B 
1     2     

Public Member Functions
	FmtSetField (FmtAlign align=faCURRENT, int width=-1, char fill=0)
	Main constructor. More...
	FmtSetField (int width, char fill=0)
	Short constructor with default alignment. More...
void	merge (const FmtSetField &src)
	Merge source attributes (used internally). More...
FmtSetField &	reset ()
	Reset attributes to defaults (not unspecified). More...

Static Public Member Functions
static void	setup_align (int &align_padleft, int &align_padright, int align_padding, const FmtSetField *field)
	Used to setup and calculate alignment padding (used internally). More...

Public Attributes
FmtAlign	align
	Field alignment type (default: fLEFT) More...
char	fill
	Field fill character to pad up to width (default: ' ') More...
int	width
	Field width to align in (default: 0) More...

Constructor & Destructor Documentation

FmtSetField() [1/2]

FmtSetField ( FmtAlign  align = faCURRENT, int  width = -1, char  fill = 0  )

inline

Main constructor.

Parameters

align	Alignment type to use: fLEFT, fRIGHT, or fCENTER (faCURRENT for unspecified/default)
width	Field character width, (-1 for unspecified/default)
fill	Field fill character to pad up to width (0 for unspecified/default)

FmtSetField() [2/2]

FmtSetField ( int  width, char  fill = 0  )

inline

Short constructor with default alignment.

Parameters

width	Field character width, (-1 for unspecified/default)
fill	Field fill character to pad up to width (0 for unspecified/default)

Member Function Documentation

merge()

void merge ( const FmtSetField &  src )

inline

Merge source attributes (used internally).

• This copies attributes from src that aren't "unspecified"

Parameters

src	Source to merge from

reset()

FmtSetField& reset ( )

inline

Reset attributes to defaults (not unspecified).

setup_align()

static void setup_align ( int &  align_padleft, int &  align_padright, int  align_padding, const FmtSetField *  field  )

inlinestatic

Used to setup and calculate alignment padding (used internally).

Parameters

align_padleft	Set to left-padding size [out]
align_padright	Set to right-padding size [out]
align_padding	Padding width to use
field	Field attribuets to use for alignment type (field->align), NULL for no alignment

Member Data Documentation

align

FmtAlign align

Field alignment type (default: fLEFT)

fill

char fill

Field fill character to pad up to width (default: ' ')

width

int width

Field width to align in (default: 0)

---

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

• evo/impl/str.h