juce_AttributedString.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2015 - ROLI Ltd.
 
   Permission is granted to use this software under the terms of either:
   a) the GPL v2 (or any later version)
   b) the Affero GPL v3
 
   Details of these licenses can be found at: www.gnu.org/licenses
 
   JUCE is distributed in the hope that it will be useful, but WITHOUT ANY
   WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
   A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 
   ------------------------------------------------------------------------------
 
   To release a closed-source product which uses JUCE, commercial licenses are
   available: visit www.juce.com for more information.
 
  ==============================================================================
*/
 
#ifndef JUCE_ATTRIBUTEDSTRING_H_INCLUDED
#define JUCE_ATTRIBUTEDSTRING_H_INCLUDED
 
 
//==============================================================================
class JUCE_API  AttributedString
{
public:
    AttributedString();
 
    explicit AttributedString (const String& text);
 
    AttributedString (const AttributedString&);
    AttributedString& operator= (const AttributedString&);
   #if JUCE_COMPILER_SUPPORTS_MOVE_SEMANTICS
    AttributedString (AttributedString&&) noexcept;
    AttributedString& operator= (AttributedString&&) noexcept;
   #endif
 
    ~AttributedString();
 
    //==============================================================================
    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 (Range<int> range, Colour colour);
 
        Attribute (Range<int> range, const Font& font);
 
        Attribute (const Attribute&);
        ~Attribute();
 
        const Font* getFont() const noexcept            { return font; }
 
        const Colour* getColour() const noexcept        { return colour; }
 
        const Range<int> range;
 
    private:
        ScopedPointer<Font> font;
        ScopedPointer<Colour> colour;
 
        friend class AttributedString;
        Attribute (const Attribute&, int);
        Attribute& operator= (const Attribute&);
 
        JUCE_LEAK_DETECTOR (Attribute)
    };
 
    int getNumAttributes() const noexcept                       { return attributes.size(); }
 
    const Attribute* getAttribute (int index) const noexcept    { return attributes.getUnchecked (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;
    Justification justification;
    WordWrap wordWrap;
    ReadingDirection readingDirection;
    OwnedArray<Attribute> attributes;
 
    JUCE_LEAK_DETECTOR (AttributedString)
};
 
#endif   // JUCE_ATTRIBUTEDSTRING_H_INCLUDED