JUCE  v6.1.6 (6.0.8-1114)
JUCE API
Looking for a senior C++ dev?
I'm looking for work. Hire me!
juce::NewLine Class Reference

This class is used for represent a new-line character sequence. More...

#include <juce_NewLine.h>

Public Member Functions

 operator String () const
 Returns the default new-line sequence that the library uses. More...
 
 operator StringRef () const noexcept
 Returns the default new-line sequence that the library uses. More...
 

Static Public Member Functions

static const char * getDefault () noexcept
 Returns the default new-line sequence that the library uses. More...
 

Detailed Description

This class is used for represent a new-line character sequence.

To write a new-line to a stream, you can use the predefined 'newLine' variable, e.g.

myOutputStream << "Hello World" << newLine << newLine;

The exact character sequence that will be used for the new-line can be set and retrieved with OutputStream::setNewLineString() and OutputStream::getNewLineString().

@tags{Core}

Member Function Documentation

◆ getDefault()

static const char* juce::NewLine::getDefault ( )
inlinestaticnoexcept

Returns the default new-line sequence that the library uses.

See also
OutputStream::setNewLineString()

Referenced by juce::operator+(), juce::operator+=(), and juce::operator<<().

◆ operator String()

juce::NewLine::operator String ( ) const
inline

Returns the default new-line sequence that the library uses.

See also
getDefault()

◆ operator StringRef()

juce::NewLine::operator StringRef ( ) const
inlinenoexcept

Returns the default new-line sequence that the library uses.

See also
OutputStream::setNewLineString()

The documentation for this class was generated from the following file:
juce::newLine
NewLine newLine
A predefined object representing a new-line, which can be written to a string or stream.