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

A line containing a sequence of glyph-runs. More...

#include <juce_TextLayout.h>

Collaboration diagram for juce::TextLayout::Line:

Public Member Functions

 Line ()=default
 
 Line (const Line &)
 
 Line (Line &&) noexcept=default
 
 Line (Range< int > stringRange, Point< float > lineOrigin, float ascent, float descent, float leading, int numRunsToPreallocate)
 
 ~Line () noexcept=default
 
Rectangle< floatgetLineBounds () const noexcept
 Returns the smallest rectangle which contains all the glyphs in this line. More...
 
Range< floatgetLineBoundsX () const noexcept
 Returns the X position range which contains all the glyphs in this line. More...
 
Range< floatgetLineBoundsY () const noexcept
 Returns the Y position range which contains all the glyphs in this line. More...
 
Lineoperator= (const Line &)
 
Lineoperator= (Line &&) noexcept=default
 
void swap (Line &other) noexcept
 

Public Attributes

float ascent = 0.0f
 
float descent = 0.0f
 
float leading = 0.0f
 
Point< floatlineOrigin
 The line's baseline origin. More...
 
OwnedArray< Runruns
 The glyph-runs in this line. More...
 
Range< intstringRange
 The character range that this line represents in the original string that was used to create it. More...
 

Detailed Description

A line containing a sequence of glyph-runs.

Constructor & Destructor Documentation

◆ Line() [1/4]

juce::TextLayout::Line::Line ( )
default

◆ Line() [2/4]

juce::TextLayout::Line::Line ( Range< int stringRange,
Point< float lineOrigin,
float  ascent,
float  descent,
float  leading,
int  numRunsToPreallocate 
)

◆ Line() [3/4]

juce::TextLayout::Line::Line ( const Line )

◆ Line() [4/4]

juce::TextLayout::Line::Line ( Line &&  )
defaultnoexcept

◆ ~Line()

juce::TextLayout::Line::~Line ( )
defaultnoexcept

Member Function Documentation

◆ getLineBounds()

Rectangle<float> juce::TextLayout::Line::getLineBounds ( ) const
noexcept

Returns the smallest rectangle which contains all the glyphs in this line.

◆ getLineBoundsX()

Range<float> juce::TextLayout::Line::getLineBoundsX ( ) const
noexcept

Returns the X position range which contains all the glyphs in this line.

◆ getLineBoundsY()

Range<float> juce::TextLayout::Line::getLineBoundsY ( ) const
noexcept

Returns the Y position range which contains all the glyphs in this line.

◆ operator=() [1/2]

Line& juce::TextLayout::Line::operator= ( const Line )

◆ operator=() [2/2]

Line& juce::TextLayout::Line::operator= ( Line &&  )
defaultnoexcept

◆ swap()

void juce::TextLayout::Line::swap ( Line other)
noexcept

Member Data Documentation

◆ ascent

float juce::TextLayout::Line::ascent = 0.0f

◆ descent

float juce::TextLayout::Line::descent = 0.0f

◆ leading

float juce::TextLayout::Line::leading = 0.0f

◆ lineOrigin

Point<float> juce::TextLayout::Line::lineOrigin

The line's baseline origin.

◆ runs

OwnedArray<Run> juce::TextLayout::Line::runs

The glyph-runs in this line.

◆ stringRange

Range<int> juce::TextLayout::Line::stringRange

The character range that this line represents in the original string that was used to create it.


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