juce::detail::ShapedTextOptions Class Reference

#include <juce_SimpleShapedText.h>

Collaboration diagram for juce::detail::ShapedTextOptions:

Public Member Functions
const auto &	getAdditiveLineSpacing () const
const auto &	getAlignmentWidth () const
const auto &	getAllowBreakingInsideWord () const
const auto &	getDrawLinesInFull () const
const auto &	getEllipsis () const
const auto &	getFirstLineIndent () const
const auto &	getFontsForRange () const
const auto &	getHeight () const
const auto &	getJustification () const
const auto &	getLanguage () const
const auto &	getLeading () const
const auto &	getMaxNumLines () const
const auto &	getReadingDirection () const
const auto &	getTrailingWhitespacesShouldFit () const
const auto &	getWordWrapWidth () const
const auto &	isBaselineAtZero () const
bool	operator!= (const ShapedTextOptions &other) const
bool	operator== (const ShapedTextOptions &other) const
ShapedTextOptions	withAdditiveLineSpacing (float x) const
ShapedTextOptions	withAlignmentWidth (float x) const
ShapedTextOptions	withAllowBreakingInsideWord (bool x=true) const
ShapedTextOptions	withBaselineAtZero (bool x=true) const
ShapedTextOptions	withDrawLinesInFull (bool x=true) const
ShapedTextOptions	withEllipsis (String x=String::charToString((juce_wchar) 0x2026)) const
ShapedTextOptions	withFirstLineIndent (float x) const
ShapedTextOptions	withFont (Font x) const
ShapedTextOptions	withFonts (const detail::RangedValues< Font > &x) const
ShapedTextOptions	withHeight (float x) const
ShapedTextOptions	withJustification (Justification x) const
ShapedTextOptions	withLanguage (StringRef x) const
ShapedTextOptions	withLeading (float x) const
ShapedTextOptions	withMaxNumLines (int64 x) const
ShapedTextOptions	withReadingDirection (std::optional< TextDirection > x) const
ShapedTextOptions	withTrailingWhitespacesShouldFit (bool x=true) const
ShapedTextOptions	withWordWrapWidth (float x) const

Private Member Functions
auto	tie () const

Private Attributes
float	additiveLineSpacing = 0.0f
std::optional< float >	alignmentWidth
bool	allowBreakingInsideWord = false
bool	baselineAtZero = false
bool	drawLinesInFull = false
String	ellipsis
float	firstLineIndent = 0.0f
detail::RangedValues< Font >	fontsForRange
std::optional< float >	height
Justification	justification { Justification::topLeft }
String	language = SystemStats::getDisplayLanguage()
float	leading = 1.0f
int64	maxNumLines = std::numeric_limits<int64>::max()
std::optional< TextDirection >	readingDir
bool	trailingWhitespacesShouldFit = true
std::optional< float >	wordWrapWidth

Member Function Documentation

getAdditiveLineSpacing()

const auto & juce::detail::ShapedTextOptions::getAdditiveLineSpacing ( ) const

inline

References additiveLineSpacing.

getAlignmentWidth()

const auto & juce::detail::ShapedTextOptions::getAlignmentWidth ( ) const

inline

References alignmentWidth.

getAllowBreakingInsideWord()

const auto & juce::detail::ShapedTextOptions::getAllowBreakingInsideWord ( ) const

inline

References allowBreakingInsideWord.

getDrawLinesInFull()

const auto & juce::detail::ShapedTextOptions::getDrawLinesInFull ( ) const

inline

References drawLinesInFull.

getEllipsis()

const auto & juce::detail::ShapedTextOptions::getEllipsis ( ) const

inline

References ellipsis.

getFirstLineIndent()

const auto & juce::detail::ShapedTextOptions::getFirstLineIndent ( ) const

inline

References firstLineIndent.

getFontsForRange()

const auto & juce::detail::ShapedTextOptions::getFontsForRange ( ) const

inline

References fontsForRange.

getHeight()

const auto & juce::detail::ShapedTextOptions::getHeight ( ) const

inline

References height.

getJustification()

const auto & juce::detail::ShapedTextOptions::getJustification ( ) const

inline

References justification.

getLanguage()

const auto & juce::detail::ShapedTextOptions::getLanguage ( ) const

inline

References language.

getLeading()

const auto & juce::detail::ShapedTextOptions::getLeading ( ) const

inline

References leading.

getMaxNumLines()

const auto & juce::detail::ShapedTextOptions::getMaxNumLines ( ) const

inline

References maxNumLines.

getReadingDirection()

const auto & juce::detail::ShapedTextOptions::getReadingDirection ( ) const

inline

References readingDir.

getTrailingWhitespacesShouldFit()

const auto & juce::detail::ShapedTextOptions::getTrailingWhitespacesShouldFit ( ) const

inline

References trailingWhitespacesShouldFit.

getWordWrapWidth()

const auto & juce::detail::ShapedTextOptions::getWordWrapWidth ( ) const

inline

References wordWrapWidth.

isBaselineAtZero()

const auto & juce::detail::ShapedTextOptions::isBaselineAtZero ( ) const

inline

References baselineAtZero.

operator!=()

bool juce::detail::ShapedTextOptions::operator!= ( const ShapedTextOptions &  other ) const

inline

References tie().

operator==()

bool juce::detail::ShapedTextOptions::operator== ( const ShapedTextOptions &  other ) const

inline

References tie().

tie()

auto juce::detail::ShapedTextOptions::tie ( ) const

inlineprivate

References additiveLineSpacing, alignmentWidth, allowBreakingInsideWord, baselineAtZero, ellipsis, firstLineIndent, fontsForRange, height, justification, language, leading, maxNumLines, readingDir, trailingWhitespacesShouldFit, and wordWrapWidth.

Referenced by operator!=(), and operator==().

withAdditiveLineSpacing()

ShapedTextOptions juce::detail::ShapedTextOptions::withAdditiveLineSpacing ( float  x ) const

inline

References additiveLineSpacing, and juce::withMember().

withAlignmentWidth()

ShapedTextOptions juce::detail::ShapedTextOptions::withAlignmentWidth ( float  x ) const

inline

References alignmentWidth, and juce::withMember().

withAllowBreakingInsideWord()

ShapedTextOptions juce::detail::ShapedTextOptions::withAllowBreakingInsideWord ( bool  x = true ) const

inline

References allowBreakingInsideWord, and juce::withMember().

withBaselineAtZero()

ShapedTextOptions juce::detail::ShapedTextOptions::withBaselineAtZero ( bool  x = true ) const

inline

References baselineAtZero, and juce::withMember().

withDrawLinesInFull()

ShapedTextOptions juce::detail::ShapedTextOptions::withDrawLinesInFull ( bool  x = true ) const

inline

References drawLinesInFull, and juce::withMember().

withEllipsis()

ShapedTextOptions juce::detail::ShapedTextOptions::withEllipsis ( String  x = String::charToString ((juce_wchar) 0x2026) ) const

inline

References ellipsis, and juce::withMember().

withFirstLineIndent()

ShapedTextOptions juce::detail::ShapedTextOptions::withFirstLineIndent ( float  x ) const

inline

References firstLineIndent, and juce::withMember().

withFont()

ShapedTextOptions juce::detail::ShapedTextOptions::withFont ( Font  x ) const

inline

References fontsForRange, juce::detail::RangedValues< T >::set(), and juce::withMember().

withFonts()

ShapedTextOptions juce::detail::ShapedTextOptions::withFonts ( const detail::RangedValues< Font > &  x ) const

inline

References fontsForRange, and juce::withMember().

withHeight()

ShapedTextOptions juce::detail::ShapedTextOptions::withHeight ( float  x ) const

inline

References height, and juce::withMember().

withJustification()

ShapedTextOptions juce::detail::ShapedTextOptions::withJustification ( Justification  x ) const

inline

References justification, and juce::withMember().

withLanguage()

ShapedTextOptions juce::detail::ShapedTextOptions::withLanguage ( StringRef  x ) const

inline

References language, and juce::withMember().

withLeading()

ShapedTextOptions juce::detail::ShapedTextOptions::withLeading ( float  x ) const

inline

References leading, and juce::withMember().

withMaxNumLines()

ShapedTextOptions juce::detail::ShapedTextOptions::withMaxNumLines ( int64  x ) const

inline

References maxNumLines, and juce::withMember().

withReadingDirection()

ShapedTextOptions juce::detail::ShapedTextOptions::withReadingDirection ( std::optional< TextDirection >  x ) const

inline

References readingDir, and juce::withMember().

withTrailingWhitespacesShouldFit()

ShapedTextOptions juce::detail::ShapedTextOptions::withTrailingWhitespacesShouldFit ( bool  x = true ) const

inline

References trailingWhitespacesShouldFit, and juce::withMember().

withWordWrapWidth()

ShapedTextOptions juce::detail::ShapedTextOptions::withWordWrapWidth ( float  x ) const

inline

References juce::withMember(), and wordWrapWidth.

Member Data Documentation

additiveLineSpacing

float juce::detail::ShapedTextOptions::additiveLineSpacing = 0.0f

private

Referenced by getAdditiveLineSpacing(), tie(), and withAdditiveLineSpacing().

alignmentWidth

std::optional<float> juce::detail::ShapedTextOptions::alignmentWidth

private

Referenced by getAlignmentWidth(), tie(), and withAlignmentWidth().

allowBreakingInsideWord

bool juce::detail::ShapedTextOptions::allowBreakingInsideWord = false

private

Referenced by getAllowBreakingInsideWord(), tie(), and withAllowBreakingInsideWord().

baselineAtZero

bool juce::detail::ShapedTextOptions::baselineAtZero = false

private

Referenced by isBaselineAtZero(), tie(), and withBaselineAtZero().

drawLinesInFull

bool juce::detail::ShapedTextOptions::drawLinesInFull = false

private

Referenced by getDrawLinesInFull(), and withDrawLinesInFull().

ellipsis

String juce::detail::ShapedTextOptions::ellipsis

private

Referenced by getEllipsis(), tie(), and withEllipsis().

firstLineIndent

float juce::detail::ShapedTextOptions::firstLineIndent = 0.0f

private

Referenced by getFirstLineIndent(), tie(), and withFirstLineIndent().

fontsForRange

detail::RangedValues<Font> juce::detail::ShapedTextOptions::fontsForRange

private

Initial value:

= std::invoke ([&]
    {
        detail::RangedValues<Font> result;
        detail::Ranges::Operations ops;
        result.set ({ 0, std::numeric_limits<int64>::max() }, FontOptions { 15.0f }, ops);
        return result;
    })

Referenced by getFontsForRange(), tie(), withFont(), and withFonts().

height

std::optional<float> juce::detail::ShapedTextOptions::height

private

Referenced by getHeight(), tie(), and withHeight().

justification

Justification juce::detail::ShapedTextOptions::justification { Justification::topLeft }

private

Referenced by getJustification(), tie(), and withJustification().

language

String juce::detail::ShapedTextOptions::language = SystemStats::getDisplayLanguage()

private

Referenced by getLanguage(), tie(), and withLanguage().

leading

float juce::detail::ShapedTextOptions::leading = 1.0f

private

Referenced by getLeading(), tie(), and withLeading().

maxNumLines

int64 juce::detail::ShapedTextOptions::maxNumLines = std::numeric_limits<int64>::max()

private

Referenced by getMaxNumLines(), tie(), and withMaxNumLines().

readingDir

std::optional<TextDirection> juce::detail::ShapedTextOptions::readingDir

private

Referenced by getReadingDirection(), tie(), and withReadingDirection().

trailingWhitespacesShouldFit

bool juce::detail::ShapedTextOptions::trailingWhitespacesShouldFit = true

private

Referenced by getTrailingWhitespacesShouldFit(), tie(), and withTrailingWhitespacesShouldFit().

wordWrapWidth

std::optional<float> juce::detail::ShapedTextOptions::wordWrapWidth

private

Referenced by getWordWrapWidth(), tie(), and withWordWrapWidth().

---

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

• juce_SimpleShapedText.h