juce_TextLayout.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_TEXTLAYOUT_H_INCLUDED
#define JUCE_TEXTLAYOUT_H_INCLUDED
 
 
//==============================================================================
class JUCE_API  TextLayout
{
public:
    TextLayout();
    TextLayout (const TextLayout&);
    TextLayout& operator= (const TextLayout&);
   #if JUCE_COMPILER_SUPPORTS_MOVE_SEMANTICS
    TextLayout (TextLayout&&) noexcept;
    TextLayout& operator= (TextLayout&&) noexcept;
   #endif
 
    ~TextLayout();
 
    //==============================================================================
    void createLayout (const AttributedString&, float maxWidth);
 
    void createLayout (const AttributedString&, float maxWidth, float maxHeight);
 
    void createLayoutWithBalancedLineLengths (const AttributedString&, float maxWidth);
 
    void createLayoutWithBalancedLineLengths (const AttributedString&, float maxWidth, float maxHeight);
 
    void draw (Graphics&, const Rectangle<float>& area) const;
 
    //==============================================================================
    class JUCE_API  Glyph
    {
    public:
        Glyph (int glyphCode, Point<float> anchor, float width) noexcept;
        Glyph (const Glyph&) noexcept;
        Glyph& operator= (const Glyph&) noexcept;
        ~Glyph() noexcept;
 
        int glyphCode;
 
        Point<float> anchor;
 
        float width;
 
    private:
        JUCE_LEAK_DETECTOR (Glyph)
    };
 
    //==============================================================================
    class JUCE_API  Run
    {
    public:
        Run() noexcept;
        Run (const Run&);
        Run (Range<int> stringRange, int numGlyphsToPreallocate);
        ~Run() noexcept;
 
        Font font;              
        Colour colour;          
        Array<Glyph> glyphs;    
        Range<int> stringRange; 
    private:
        Run& operator= (const Run&);
        JUCE_LEAK_DETECTOR (Run)
    };
 
    //==============================================================================
    class JUCE_API  Line
    {
    public:
        Line() noexcept;
        Line (const Line&);
        Line (Range<int> stringRange, Point<float> lineOrigin,
              float ascent, float descent, float leading, int numRunsToPreallocate);
        ~Line() noexcept;
 
        Range<float> getLineBoundsX() const noexcept;
 
        Range<float> getLineBoundsY() const noexcept;
 
        Rectangle<float> getLineBounds() const noexcept;
 
        OwnedArray<Run> runs;           
        Range<int> stringRange;         
        Point<float> lineOrigin;        
        float ascent, descent, leading;
 
    private:
        Line& operator= (const Line&);
        JUCE_LEAK_DETECTOR (Line)
    };
 
    //==============================================================================
    float getWidth() const noexcept     { return width; }
 
    float getHeight() const noexcept    { return height; }
 
    int getNumLines() const noexcept    { return lines.size(); }
 
    Line& getLine (int index) const;
 
    void addLine (Line*);
 
    void ensureStorageAllocated (int numLinesNeeded);
 
private:
    OwnedArray<Line> lines;
    float width, height;
    Justification justification;
 
    void createStandardLayout (const AttributedString&);
    bool createNativeLayout (const AttributedString&);
    void recalculateSize (const AttributedString&);
 
    JUCE_LEAK_DETECTOR (TextLayout)
};
 
#endif   // JUCE_TEXTLAYOUT_H_INCLUDED