127 lines
4.4 KiB
C++
127 lines
4.4 KiB
C++
/*
|
|
==============================================================================
|
|
|
|
This file is part of the JUCE library.
|
|
Copyright (c) 2017 - ROLI Ltd.
|
|
|
|
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 5 End-User License
|
|
Agreement and JUCE 5 Privacy Policy (both updated and effective as of the
|
|
27th April 2017).
|
|
|
|
End User License Agreement: www.juce.com/juce-5-licence
|
|
Privacy Policy: www.juce.com/juce-5-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
|
|
{
|
|
|
|
//==============================================================================
|
|
/**
|
|
A button showing an underlined weblink, that will launch the link
|
|
when it's clicked.
|
|
|
|
@see Button
|
|
|
|
@tags{GUI}
|
|
*/
|
|
class JUCE_API HyperlinkButton : public Button
|
|
{
|
|
public:
|
|
//==============================================================================
|
|
/** Creates a HyperlinkButton.
|
|
|
|
@param linkText the text that will be displayed in the button - this is
|
|
also set as the Component's name, but the text can be
|
|
changed later with the Button::setButtonText() method
|
|
@param linkURL the URL to launch when the user clicks the button
|
|
*/
|
|
HyperlinkButton (const String& linkText,
|
|
const URL& linkURL);
|
|
|
|
/** Creates a HyperlinkButton. */
|
|
HyperlinkButton();
|
|
|
|
/** Destructor. */
|
|
~HyperlinkButton() override;
|
|
|
|
//==============================================================================
|
|
/** Changes the font to use for the text.
|
|
|
|
If resizeToMatchComponentHeight is true, the font's height will be adjusted
|
|
to match the size of the component.
|
|
*/
|
|
void setFont (const Font& newFont,
|
|
bool resizeToMatchComponentHeight,
|
|
Justification justificationType = Justification::horizontallyCentred);
|
|
|
|
//==============================================================================
|
|
/** A set of colour IDs to use to change the colour of various aspects of the link.
|
|
|
|
These constants can be used either via the Component::setColour(), or LookAndFeel::setColour()
|
|
methods.
|
|
|
|
@see Component::setColour, Component::findColour, LookAndFeel::setColour, LookAndFeel::findColour
|
|
*/
|
|
enum ColourIds
|
|
{
|
|
textColourId = 0x1001f00, /**< The colour to use for the URL text. */
|
|
};
|
|
|
|
//==============================================================================
|
|
/** Changes the URL that the button will trigger. */
|
|
void setURL (const URL& newURL) noexcept;
|
|
|
|
/** Returns the URL that the button will trigger. */
|
|
const URL& getURL() const noexcept { return url; }
|
|
|
|
//==============================================================================
|
|
/** Resizes the button horizontally to fit snugly around the text.
|
|
|
|
This won't affect the button's height.
|
|
*/
|
|
void changeWidthToFitText();
|
|
|
|
//==============================================================================
|
|
/** Sets the style of justification to be used for positioning the text.
|
|
(The default is Justification::centred)
|
|
*/
|
|
void setJustificationType (Justification justification);
|
|
|
|
/** Returns the type of justification, as set in setJustificationType(). */
|
|
Justification getJustificationType() const noexcept { return justification; }
|
|
|
|
protected:
|
|
//==============================================================================
|
|
/** @internal */
|
|
void clicked() override;
|
|
/** @internal */
|
|
void colourChanged() override;
|
|
/** @internal */
|
|
void paintButton (Graphics&, bool, bool) override;
|
|
|
|
private:
|
|
//==============================================================================
|
|
URL url;
|
|
Font font;
|
|
bool resizeFont;
|
|
Justification justification;
|
|
|
|
Font getFontToUse() const;
|
|
|
|
JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (HyperlinkButton)
|
|
};
|
|
|
|
} // namespace juce
|