juce_HyperlinkButton.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  HyperlinkButton  : public Button
{
public:
    //==============================================================================
    HyperlinkButton (const String& linkText,
                     const URL& linkURL);

    HyperlinkButton();

    ~HyperlinkButton() override;
 
    //==============================================================================
    void setFont (const Font& newFont,
                  bool resizeToMatchComponentHeight,
                  Justification justificationType = Justification::horizontallyCentred);
 
    //==============================================================================
    enum ColourIds
    {
        textColourId             = 0x1001f00, 
    };
 
    //==============================================================================
    void setURL (const URL& newURL) noexcept;

    const URL& getURL() const noexcept                          { return url; }
 
    //==============================================================================
    void changeWidthToFitText();
 
    //==============================================================================
    void setJustificationType (Justification justification);

    Justification getJustificationType() const noexcept         { return justification; }
 
protected:
    //==============================================================================
    void clicked() override;
    void colourChanged() override;
    void paintButton (Graphics&, bool, bool) override;
 
private:
    //==============================================================================
    using Button::clicked;
    Font getFontToUse() const;
 
    //==============================================================================
    URL url;
    Font font;
    bool resizeFont;
    Justification justification;
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (HyperlinkButton)
};
 
} // namespace juce