Skip to content

Latest commit

 

History

History
255 lines (141 loc) · 4.37 KB

RendererConfig.md

File metadata and controls

255 lines (141 loc) · 4.37 KB

RendererConfig

struct RendererConfig

Required header: <Eclog/RendererConfig.h>

The RendererConfig struct represents a renderer configuration (See Renderer).

Member enumerations

Name Description
Scheme Scheme.
Formatting Format.
IndentCharacter Indent character.

Member functions

Name Description
(constructor) Constructor.

Member variables

Name Description
formatting Text formatting.
linebreak Line-break style.
indentCharacter Indent character.
indentSize Indent size.
insertSpaceAfterColon Insert space after colon.
placeOpenBracketOnNewLineForObjects Place open bracket on new line for objects.
placeOpenBracketOnNewLineForArrays Place open bracket on new line for arrays.
encloseRootObjectWithCurlyBrackets Enclose root object with curly brackets.
useQuotedStringsOnly Use quoted strings only.
useCommasToSeparateItems Use commas to separate items.
useStringsToRepresentInfinitiesAndNaNs Use strings to represent infinities and NaNs.
enableComments Enable comments.

Scheme

enum Scheme

scheme_typical

Scheme: typical.

scheme_json_compatible

Scheme: JSON-compatible.


Formatting

enum Formatting

Values

formatting_regular

Formatting: regular.

formatting_compact

Formatting: compact.


IndentCharacter

enum IndentCharacter

Values

indent_character_tab

Indent character: horizontal tab.

indent_character_space

Indent character: space.


(constructor)

explicit RendererConfig(Scheme scheme = scheme_typical);

Constructs a RendererConfig.

Parameters

Scheme scheme The predefined scheme for specifying the initial value of member variables.


formatting

Formatting formatting

Text formatting.

Typical scheme: formatting_regular.

JSON-compatible scheme: formatting_regular.


linebreak

Linebreak linebreak

Line-break style.

Typical scheme: LF.

JSON-compatible scheme: LF.


indentCharacter

IndentCharacter indentCharacter

Indent character.

Typical scheme: indent_character_tab.

JSON-compatible scheme: indent_character_tab.


indentSize

int indentSize

Indent size.

Typical scheme: 1.

JSON-compatible scheme: 1.


insertSpaceAfterColon

bool insertSpaceAfterColon

Insert space after colon.

Typical scheme: true.

JSON-compatible scheme: true.

placeOpenBracketOnNewLineForObjects

bool placeOpenBracketOnNewLineForObjects

Place open bracket on new line for objects.

Typical scheme: true.

JSON-compatible scheme: true.


placeOpenBracketOnNewLineForArrays

bool placeOpenBracketOnNewLineForArrays

Place open bracket on new line for arrays.

Typical scheme: true.

JSON-compatible scheme: true.


encloseRootObjectWithCurlyBrackets

bool encloseRootObjectWithCurlyBrackets

Enclose root object with curly brackets.

Typical scheme: false.

JSON-compatible scheme: true.


useQuotedStringsOnly

bool useQuotedStringsOnly

Use quoted strings only.

Typical scheme: false.

JSON-compatible scheme: true.


useCommasToSeparateItems

bool useCommasToSeparateItems

Use commas to separate items.

Typical scheme: false.

JSON-compatible scheme: true.


useStringsToRepresentInfinitiesAndNaNs

bool useStringsToRepresentInfinitiesAndNaNs

Use strings to represent infinities and NaNs.

Typical scheme: false.

JSON-compatible scheme: true.


enableComments

bool enableComments

Enable comments.

Typical scheme: true.

JSON-compatible scheme: false.