Support Forum       G3D Web Page     
Public Types | Public Member Functions | Public Attributes | List of all members
G3D::TextOutput::Settings Class Reference

Public Types

enum  NewlineStyle {
  NEWLINE_WINDOWS,
  NEWLINE_UNIX
}
 Style of newline used by word wrapping and by (optional) conversion. More...
 
enum  WordWrapMode {
  WRAP_NONE,
  WRAP_WITHOUT_BREAKING,
  WRAP_ALWAYS
}
 
WRAP_NONE Word wrapping is disabled WRAP_WITHOUT_BREAKING Word-wrap, but don't break continuous lines that are longer than numColumns (default) WRAP_ALWAYS Wrap even if it means breaking a continuous line or a quoted string. More...
 

Public Member Functions

 Settings ()
 

Public Attributes

bool allowWordWrapInsideDoubleQuotes
 Is word-wrapping allowed to insert newlines inside double quotes? Default: false. More...
 
bool convertNewlines
 If true, all newlines are converted to NewlineStyle regardless of how they start out. More...
 
String falseSymbol
 Used by writeBoolean. More...
 
NewlineStyle newlineStyle
 
int numColumns
 Number of columns for word wrapping. More...
 
int spacesPerIndent
 Number of spaces in each indent. More...
 
String trueSymbol
 Used by writeBoolean. More...
 
WordWrapMode wordWrap
 Defaults to WRAP_WITHOUT_BREAKING. More...
 

Member Enumeration Documentation

◆ NewlineStyle

Style of newline used by word wrapping and by (optional) conversion.

default: Windows: NEWLINE_WINDOWS, Linux, OS X: NEWLINE_UNIX.

Enumerator
NEWLINE_WINDOWS 
NEWLINE_UNIX 

◆ WordWrapMode


WRAP_NONE Word wrapping is disabled WRAP_WITHOUT_BREAKING Word-wrap, but don't break continuous lines that are longer than numColumns (default) WRAP_ALWAYS Wrap even if it means breaking a continuous line or a quoted string.

Word wrapping is only allowed at whitespaces ('\n', '\r', '\t', ' '); it will not occur after commas, punctuation, minus signs, or any other characters

Enumerator
WRAP_NONE 
WRAP_WITHOUT_BREAKING 
WRAP_ALWAYS 

Constructor & Destructor Documentation

◆ Settings()

G3D::TextOutput::Settings::Settings ( )
inline

Member Data Documentation

◆ allowWordWrapInsideDoubleQuotes

bool G3D::TextOutput::Settings::allowWordWrapInsideDoubleQuotes

Is word-wrapping allowed to insert newlines inside double quotes? Default: false.

◆ convertNewlines

bool G3D::TextOutput::Settings::convertNewlines

If true, all newlines are converted to NewlineStyle regardless of how they start out.

Default: true.

◆ falseSymbol

String G3D::TextOutput::Settings::falseSymbol

Used by writeBoolean.

◆ newlineStyle

NewlineStyle G3D::TextOutput::Settings::newlineStyle

Referenced by Settings().

◆ numColumns

int G3D::TextOutput::Settings::numColumns

Number of columns for word wrapping.

Default: 8

◆ spacesPerIndent

int G3D::TextOutput::Settings::spacesPerIndent

Number of spaces in each indent.

Default: 4

◆ trueSymbol

String G3D::TextOutput::Settings::trueSymbol

Used by writeBoolean.

◆ wordWrap

WordWrapMode G3D::TextOutput::Settings::wordWrap

Defaults to WRAP_WITHOUT_BREAKING.


documentation generated on Wed Nov 24 2021 08:02:01 using doxygen 1.8.15