juce_AttributedString.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2022 - Raw Material Software Limited
 
   JUCE is an open source library subject to commercial or open-source
   licensing.
 
   By using JUCE, you agree to the terms of both the JUCE 7 End-User License
   Agreement and JUCE Privacy Policy.
 
   End User License Agreement: www.juce.com/juce-7-licence
   Privacy Policy: www.juce.com/juce-privacy-policy
 
   Or: You may also use this code under the terms of the GPL v3 (see
   www.gnu.org/licenses).
 
   JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
   EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
   DISCLAIMED.
 
  ==============================================================================
*/
 
namespace juce
{
 
//==============================================================================
class JUCE_API  AttributedString
{
public:
    AttributedString() = default;

    explicit AttributedString (const String& newString)  { setText (newString); }
 
    AttributedString (const AttributedString&) = default;
    AttributedString& operator= (const AttributedString&) = default;
    AttributedString (AttributedString&&) noexcept = default;
    AttributedString& operator= (AttributedString&&) noexcept = default;
 
    //==============================================================================
    const String& getText() const noexcept    { return text; }

    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         { return justification; }

    void setJustification (Justification newJustification) noexcept;
 
    //==============================================================================
    enum WordWrap
    {
        none,   
        byWord, 
        byChar, 
    };

    WordWrap getWordWrap() const noexcept                   { return wordWrap; }

    void setWordWrap (WordWrap newWordWrap) noexcept;
 
    //==============================================================================
    enum ReadingDirection
    {
        natural,
        leftToRight,
        rightToLeft,
    };

    ReadingDirection getReadingDirection() const noexcept   { return readingDirection; }

    void setReadingDirection (ReadingDirection newReadingDirection) noexcept;
 
    //==============================================================================
    float getLineSpacing() const noexcept                   { return lineSpacing; }

    void setLineSpacing (float newLineSpacing) noexcept;
 
    //==============================================================================
    class JUCE_API  Attribute
    {
    public:
        Attribute() = default;
 
        Attribute (const Attribute&) = default;
        Attribute& operator= (const Attribute&) = default;
        Attribute (Attribute&&) noexcept = default;
        Attribute& operator= (Attribute&&) noexcept = default;

        Attribute (Range<int> range, const Font& font, Colour colour) noexcept;

        Range<int> range;

        Font font;

        Colour colour { 0xff000000 };
 
    private:
        JUCE_LEAK_DETECTOR (Attribute)
    };

    int getNumAttributes() const noexcept                       { return attributes.size(); }

    const Attribute& getAttribute (int index) const noexcept    { return attributes.getReference (index); }
 
    //==============================================================================
    void setColour (Range<int> range, Colour colour);

    void setColour (Colour colour);

    void setFont (Range<int> range, const Font& font);

    void setFont (const Font& font);
 
private:
    String text;
    float lineSpacing = 0.0f;
    Justification justification = Justification::left;
    WordWrap wordWrap = AttributedString::byWord;
    ReadingDirection readingDirection = AttributedString::natural;
    Array<Attribute> attributes;
 
    JUCE_LEAK_DETECTOR (AttributedString)
};
 
} // namespace juce