juce_Font.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  Font  final
{
public:
    //==============================================================================
    enum FontStyleFlags
    {
        plain       = 0,    
        bold        = 1,    
        italic      = 2,    
        underlined  = 4     
    };
 
    //==============================================================================
    Font (float fontHeight, int styleFlags = plain);

    Font (const String& typefaceName, float fontHeight, int styleFlags);

    Font (const String& typefaceName, const String& typefaceStyle, float fontHeight);

    Font (const Font& other) noexcept;

    Font (const Typeface::Ptr& typeface);

    Font();

    Font (Font&& other) noexcept;

    Font& operator= (Font&& other) noexcept;

    Font& operator= (const Font& other) noexcept;
 
    bool operator== (const Font& other) const noexcept;
    bool operator!= (const Font& other) const noexcept;

    ~Font() noexcept;
 
    //==============================================================================
    void setTypefaceName (const String& faceName);

    String getTypefaceName() const noexcept;
 
    //==============================================================================
    String getTypefaceStyle() const noexcept;

    void setTypefaceStyle (const String& newStyle);

    JUCE_NODISCARD Font withTypefaceStyle (const String& newStyle) const;

    StringArray getAvailableStyles() const;
 
    //==============================================================================
    static const String& getDefaultSansSerifFontName();

    static const String& getDefaultSerifFontName();

    static const String& getDefaultMonospacedFontName();

    static const String& getDefaultStyle();

    static Typeface::Ptr getDefaultTypefaceForFont (const Font& font);
 
    //==============================================================================
    JUCE_NODISCARD Font withHeight (float height) const;

    JUCE_NODISCARD Font withPointHeight (float heightInPoints) const;

    void setHeight (float newHeight);

    void setHeightWithoutChangingWidth (float newHeight);

    float getHeight() const noexcept;

    float getHeightInPoints() const;

    float getAscent() const;

    float getAscentInPoints() const;

    float getDescent() const;

    float getDescentInPoints() const;
 
    //==============================================================================
    int getStyleFlags() const noexcept;

    JUCE_NODISCARD Font withStyle (int styleFlags) const;

    void setStyleFlags (int newFlags);
 
    //==============================================================================
    void setBold (bool shouldBeBold);

    JUCE_NODISCARD Font boldened() const;

    bool isBold() const noexcept;

    void setItalic (bool shouldBeItalic);
    JUCE_NODISCARD Font italicised() const;
    bool isItalic() const noexcept;

    void setUnderline (bool shouldBeUnderlined);
    bool isUnderlined() const noexcept;
 
    //==============================================================================
    float getHorizontalScale() const noexcept;

    JUCE_NODISCARD Font withHorizontalScale (float scaleFactor) const;

    void setHorizontalScale (float scaleFactor);

    static float getDefaultMinimumHorizontalScaleFactor() noexcept;

    static void setDefaultMinimumHorizontalScaleFactor (float newMinimumScaleFactor) noexcept;

    float getExtraKerningFactor() const noexcept;

    JUCE_NODISCARD Font withExtraKerningFactor (float extraKerning) const;

    void setExtraKerningFactor (float extraKerning);
 
    //==============================================================================
    void setSizeAndStyle (float newHeight,
                          int newStyleFlags,
                          float newHorizontalScale,
                          float newKerningAmount);

    void setSizeAndStyle (float newHeight,
                          const String& newStyle,
                          float newHorizontalScale,
                          float newKerningAmount);
 
    //==============================================================================
    int getStringWidth (const String& text) const;

    float getStringWidthFloat (const String& text) const;

    void getGlyphPositions (const String& text, Array<int>& glyphs, Array<float>& xOffsets) const;
 
    //==============================================================================
   #ifndef DOXYGEN
    [[deprecated ("This method is unsafe, use getTypefacePtr() instead.")]]
    Typeface* getTypeface() const;
   #endif

    Typeface::Ptr getTypefacePtr() const;

    static void findFonts (Array<Font>& results);

    static StringArray findAllTypefaceNames();

    static StringArray findAllTypefaceStyles (const String& family);
 
    //==============================================================================
    static const String& getFallbackFontName();

    static void setFallbackFontName (const String& name);

    static const String& getFallbackFontStyle();

    static void setFallbackFontStyle (const String& style);
 
    //==============================================================================
    String toString() const;

    static Font fromString (const String& fontDescription);
 
private:
    //==============================================================================
    static bool compare (const Font&, const Font&) noexcept;
 
    void dupeInternalIfShared();
    void checkTypefaceSuitability();
    float getHeightToPointsFactor() const;
 
    friend struct GraphicsFontHelpers;
 
    class SharedFontInternal;
    ReferenceCountedObjectPtr<SharedFontInternal> font;
 
    JUCE_LEAK_DETECTOR (Font)
};
 
} // namespace juce