openshot-audio  0.1.6
Classes | Public Types | Public Member Functions | List of all members
juce::AttributedString Class Reference

#include <juce_graphics.h>

Classes

class  Attribute
 

Public Types

enum  WordWrap { none, byWord, byChar }
 
enum  ReadingDirection { natural, leftToRight, rightToLeft }
 

Public Member Functions

 AttributedString ()
 
 AttributedString (const String &text)
 
 AttributedString (const AttributedString &)
 
AttributedStringoperator= (const AttributedString &)
 
 ~AttributedString ()
 
const StringgetText () const noexcept
 
void setText (const String &newText)
 
void append (const String &textToAppend)
 
void append (const String &textToAppend, const Font &font)
 
void append (const String &textToAppend, Colour colour)
 
void append (const String &textToAppend, const Font &font, Colour colour)
 
void append (const AttributedString &other)
 
void clear ()
 
void draw (Graphics &g, const Rectangle< float > &area) const
 
Justification getJustification () const noexcept
 
void setJustification (Justification newJustification) noexcept
 
WordWrap getWordWrap () const noexcept
 
void setWordWrap (WordWrap newWordWrap) noexcept
 
ReadingDirection getReadingDirection () const noexcept
 
void setReadingDirection (ReadingDirection newReadingDirection) noexcept
 
float getLineSpacing () const noexcept
 
void setLineSpacing (float newLineSpacing) noexcept
 
int getNumAttributes () const noexcept
 
const AttributegetAttribute (int index) const noexcept
 
void setColour (Range< int > range, Colour colour)
 
void setColour (Colour colour)
 
void setFont (Range< int > range, const Font &font)
 
void setFont (const Font &font)
 

Detailed Description

A text string with a set of colour/font settings that are associated with sub-ranges of the text.

An attributed string lets you create a string with varied fonts, colours, word-wrapping, layout, etc., and draw it using AttributedString::draw().

See also
TextLayout

Member Enumeration Documentation

Types of reading direction that can be used.

See also
getReadingDirection, setReadingDirection
Enumerator
natural 
leftToRight 
rightToLeft 

Types of word-wrap behaviour.

See also
getWordWrap, setWordWrap
Enumerator
none 

No word-wrapping: lines extend indefinitely.

byWord 

Lines are wrapped on a word boundary.

byChar 

Lines are wrapped on a character boundary.

Constructor & Destructor Documentation

AttributedString::AttributedString ( )

Creates an empty attributed string.

AttributedString::AttributedString ( const String text)
explicit

Creates an attributed string with the given text.

AttributedString::AttributedString ( const AttributedString other)
AttributedString::~AttributedString ( )

Destructor.

Member Function Documentation

void AttributedString::append ( const String textToAppend)

Appends some text (with a default font and colour).

void AttributedString::append ( const String textToAppend,
const Font font 
)

Appends some text, with a specified font, and the default colour (black).

void AttributedString::append ( const String textToAppend,
Colour  colour 
)

Appends some text, with a specified colour, and the default font.

void AttributedString::append ( const String textToAppend,
const Font font,
Colour  colour 
)

Appends some text, with a specified font and colour.

void AttributedString::append ( const AttributedString other)

Appends another AttributedString to this one. Note that this will only append the text, fonts, and colours - it won't copy any other properties such as justification, line-spacing, etc from the other object.

void AttributedString::clear ( )

Resets the string, clearing all text and attributes. Note that this won't affect global settings like the justification type, word-wrap mode, etc.

void AttributedString::draw ( Graphics g,
const Rectangle< float > &  area 
) const

Draws this string within the given area. The layout of the string within the rectangle is controlled by the justification value passed to setJustification().

const Attribute* juce::AttributedString::getAttribute ( int  index) const
inlinenoexcept

Returns one of the string's attributes. The index provided must be less than getNumAttributes(), and >= 0.

Justification juce::AttributedString::getJustification ( ) const
inlinenoexcept

Returns the justification that should be used for laying-out the text. This may include both vertical and horizontal flags.

float juce::AttributedString::getLineSpacing ( ) const
inlinenoexcept

Returns the extra line-spacing distance.

int juce::AttributedString::getNumAttributes ( ) const
inlinenoexcept

Returns the number of attributes that have been added to this string.

ReadingDirection juce::AttributedString::getReadingDirection ( ) const
inlinenoexcept

Returns the reading direction for the text.

const String& juce::AttributedString::getText ( ) const
inlinenoexcept

Returns the complete text of this attributed string.

WordWrap juce::AttributedString::getWordWrap ( ) const
inlinenoexcept

Returns the word-wrapping behaviour.

AttributedString & AttributedString::operator= ( const AttributedString other)
void AttributedString::setColour ( Range< int range,
Colour  colour 
)

Adds a colour attribute for the specified range.

void AttributedString::setColour ( Colour  colour)

Removes all existing colour attributes, and applies this colour to the whole string.

void AttributedString::setFont ( Range< int range,
const Font font 
)

Adds a font attribute for the specified range.

void AttributedString::setFont ( const Font font)

Removes all existing font attributes, and applies this font to the whole string.

void AttributedString::setJustification ( Justification  newJustification)
noexcept

Sets the justification that should be used for laying-out the text. This may include both vertical and horizontal flags.

void AttributedString::setLineSpacing ( float  newLineSpacing)
noexcept

Sets an extra line-spacing distance.

void AttributedString::setReadingDirection ( ReadingDirection  newReadingDirection)
noexcept

Sets the reading direction that should be used for the text.

void AttributedString::setText ( const String newText)

Replaces all the text. This will change the text, but won't affect any of the colour or font attributes that have been added.

void AttributedString::setWordWrap ( WordWrap  newWordWrap)
noexcept

Sets the word-wrapping behaviour.


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