Description:

Collection of attributes related to the current placeholder processed.

Note: The members of this inner class could as well be rightful members of the outer class. One object of this inner type is created as a normal member. Hence, the only reason for gathering the fields in this inner type is readability. (It has no influence on the compilation result.)

Definition at line 168 of file formatterstdimpl.hpp.

#include <formatterstdimpl.hpp>

Collaboration diagram for FormatterStdImpl::PlaceholderAttributes:

Public Field Index:
bool	AlignmentSpecified

const Box *	Arg

int	ArgIdx

int	CutContent

character	FillChar

Substring	FormatSpec

bool	IsPercentage

NumberFormat	NF

int	PreviousArgIdx

bool	SignPaddingMode

PHTypes	Type

character	TypeCode

int	TypeCodePosition

lang::Alignment	ValueAlignment

int	Width

bool	WriteBinOctHexPrefix

Field Details:

◆ AlignmentSpecified

bool AlignmentSpecified

If true, an alignment was explicitly specified. This is set to false in default implementation of resetPlaceholder.

Definition at line 228 of file formatterstdimpl.hpp.

◆ Arg

const Box* Arg

The current Box. This is set by parsePlaceholder if explicit indexing is used. Otherwise by format which invokes setArgument if parsePlaceholder did not set it yet. Set to nullptr in default implementation of resetPlaceholder.

Definition at line 174 of file formatterstdimpl.hpp.

◆ ArgIdx

int ArgIdx

The positional index of the current argument . This is set by parsePlaceholder if explicit indexing is used. Otherwise by format which invokes setArgument if parsePlaceholder did not set it yet. Set to -1 in default implementation of resetPlaceholder.

Definition at line 202 of file formatterstdimpl.hpp.

◆ CutContent

int CutContent

If not negative, the string representation of the argument is cut prior to applying any field operation. It could be also named "precision", hence the number of characters to show - even if the field will be wider. This is set to -1 in default implementation of resetPlaceholder.

Definition at line 219 of file formatterstdimpl.hpp.

◆ FillChar

character FillChar

The filling character for fields that are larger than their content. Method resetPlaceholder will set this to ' '.

Definition at line 252 of file formatterstdimpl.hpp.

◆ FormatSpec

Substring FormatSpec

The portion of the replacement field that represents the format specification. This field might be set in method parsePlaceholder and consumed in methods writeCustomFormat and parseStdFormatSpec.
This field is nulled in default implementation of resetPlaceholder.

Definition at line 180 of file formatterstdimpl.hpp.

◆ IsPercentage

bool IsPercentage

Can be true for float-types. If true, the value is multiplied with 100 and a percentage symbol '%' is printed after the value. Set to false in default implementation of resetPlaceholder.

Definition at line 248 of file formatterstdimpl.hpp.

◆ NF

NumberFormat NF

The number format object for the actual attribute. With method resetPlaceholder values found in object DefaultNumberFormat will be copied into this.

Definition at line 184 of file formatterstdimpl.hpp.

◆ PreviousArgIdx

int PreviousArgIdx

The index of the previous argument. Used when addressing previous argument number (eg. in Java formatting style this could be "%<$..."). This is set to ArgIdx in default implementation of resetPlaceholder.

Definition at line 208 of file formatterstdimpl.hpp.

◆ SignPaddingMode

bool SignPaddingMode

Forces the padding to be placed after the sign (if any) but before the digits. This is used for printing fields in the form ‘+000000120'. This alignment option is only valid for numeric types. Set to false in default implementation of resetPlaceholder.

Definition at line 234 of file formatterstdimpl.hpp.

◆ Type

PHTypes Type

The type of the attribute as specified in the placeholder. This is set to PHTypes::NotGiven in default implementation of resetPlaceholder.

Definition at line 190 of file formatterstdimpl.hpp.

◆ TypeCode

character TypeCode

This is the (format specific) type code of the current format operation. Used only to display error messages. May be used differently in derived classes. Is nulled in default implementation of resetPlaceholder.

Definition at line 257 of file formatterstdimpl.hpp.

◆ TypeCodePosition

int TypeCodePosition

This is the position in the format string where the actual type code was read from. Used for exception argument generation (FMTExceptions::IncompatibleTypeCode). If -1, the actual parse position is used.

Definition at line 224 of file formatterstdimpl.hpp.

◆ ValueAlignment

lang::Alignment ValueAlignment

The alignment of the contents within a field. This is set to Alignment in default implementation of resetPlaceholder.

Definition at line 195 of file formatterstdimpl.hpp.

◆ Width

int Width

The (minimum) width of the output. This is set to 0 in default implementation of resetPlaceholder.

Definition at line 212 of file formatterstdimpl.hpp.

◆ WriteBinOctHexPrefix

bool WriteBinOctHexPrefix

Used with binary, octal, or hexadecimal output. Specifies that the output will be prefixed by strings found in fields BinLiteralPrefix , HexLiteralPrefix or OctLiteralPrefix which default to "0b", "0o" and "0x". Set to false in default implementation of resetPlaceholder.

Definition at line 243 of file formatterstdimpl.hpp.

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

formatterstdimpl.hpp