#include <juce_gui_basics.h>

Inheritance diagram for juce::HyperlinkButton:

Public Types
enum	ColourIds { textColourId = 0x1001f00 }

Public Types inherited from juce::Button
enum	ConnectedEdgeFlags { ConnectedOnLeft = 1, ConnectedOnRight = 2, ConnectedOnTop = 4, ConnectedOnBottom = 8 }

enum	ButtonState { buttonNormal, buttonOver, buttonDown }

Public Types inherited from juce::Component
enum	FocusChangeType { focusChangedByMouseClick, focusChangedByTabKey, focusChangedDirectly }

Public Member Functions
	HyperlinkButton (const String &linkText, const URL &linkURL)

	HyperlinkButton ()

	~HyperlinkButton ()

void	setFont (const Font &newFont, bool resizeToMatchComponentHeight, Justification justificationType=Justification::horizontallyCentred)

void	setURL (const URL &newURL) noexcept

const URL &	getURL () const noexcept

void	changeWidthToFitText ()

Public Member Functions inherited from juce::Button
virtual	~Button ()

void	setButtonText (const String &newText)

const String &	getButtonText () const

bool	isDown () const noexcept

bool	isOver () const noexcept

void	setToggleState (bool shouldBeOn, NotificationType notification)

bool	getToggleState () const noexcept

Value &	getToggleStateValue () noexcept

void	setClickingTogglesState (bool shouldAutoToggleOnClick) noexcept

bool	getClickingTogglesState () const noexcept

void	setRadioGroupId (int newGroupId, NotificationType notification=sendNotification)

int	getRadioGroupId () const noexcept

void	addListener (Listener *newListener)

void	removeListener (Listener *listener)

virtual void	triggerClick ()

void	setCommandToTrigger (ApplicationCommandManager *commandManagerToUse, CommandID commandID, bool generateTooltip)

CommandID	getCommandID () const noexcept

void	addShortcut (const KeyPress &)

void	clearShortcuts ()

bool	isRegisteredForShortcut (const KeyPress &) const

void	setRepeatSpeed (int initialDelayInMillisecs, int repeatDelayInMillisecs, int minimumDelayInMillisecs=-1) noexcept

void	setTriggeredOnMouseDown (bool isTriggeredOnMouseDown) noexcept

uint32	getMillisecondsSinceButtonDown () const noexcept

void	setTooltip (const String &newTooltip) override

void	setConnectedEdges (int connectedEdgeFlags)

int	getConnectedEdgeFlags () const noexcept

bool	isConnectedOnLeft () const noexcept

bool	isConnectedOnRight () const noexcept

bool	isConnectedOnTop () const noexcept

bool	isConnectedOnBottom () const noexcept

void	setState (ButtonState newState)

ButtonState	getState () const noexcept

	JUCE_DEPRECATED (void setToggleState(bool, bool))

Public Member Functions inherited from juce::Component
	Component () noexcept

virtual	~Component ()

	Component (const String &componentName) noexcept

const String &	getName () const noexcept

virtual void	setName (const String &newName)

const String &	getComponentID () const noexcept

void	setComponentID (const String &newID)

virtual void	setVisible (bool shouldBeVisible)

bool	isVisible () const noexcept

bool	isShowing () const

virtual void	addToDesktop (int windowStyleFlags, void *nativeWindowToAttachTo=nullptr)

void	removeFromDesktop ()

bool	isOnDesktop () const noexcept

ComponentPeer *	getPeer () const

virtual void	userTriedToCloseWindow ()

virtual void	minimisationStateChanged (bool isNowMinimised)

virtual float	getDesktopScaleFactor () const

void	toFront (bool shouldAlsoGainFocus)

void	toBack ()

void	toBehind (Component *other)

void	setAlwaysOnTop (bool shouldStayOnTop)

bool	isAlwaysOnTop () const noexcept

int	getX () const noexcept

int	getY () const noexcept

int	getWidth () const noexcept

int	getHeight () const noexcept

int	getRight () const noexcept

Point< int >	getPosition () const noexcept

int	getBottom () const noexcept

const Rectangle< int > &	getBounds () const noexcept

Rectangle< int >	getLocalBounds () const noexcept

Rectangle< int >	getBoundsInParent () const noexcept

int	getScreenX () const

int	getScreenY () const

Point< int >	getScreenPosition () const

Rectangle< int >	getScreenBounds () const

Point< int >	getLocalPoint (const Component *sourceComponent, Point< int > pointRelativeToSourceComponent) const

Point< float >	getLocalPoint (const Component *sourceComponent, Point< float > pointRelativeToSourceComponent) const

Rectangle< int >	getLocalArea (const Component *sourceComponent, const Rectangle< int > &areaRelativeToSourceComponent) const

Point< int >	localPointToGlobal (Point< int > localPoint) const

Point< float >	localPointToGlobal (Point< float > localPoint) const

Rectangle< int >	localAreaToGlobal (const Rectangle< int > &localArea) const

void	setTopLeftPosition (int x, int y)

void	setTopLeftPosition (Point< int > newTopLeftPosition)

void	setTopRightPosition (int x, int y)

void	setSize (int newWidth, int newHeight)

void	setBounds (int x, int y, int width, int height)

void	setBounds (const Rectangle< int > &newBounds)

void	setBounds (const RelativeRectangle &newBounds)

void	setBounds (const String &newBoundsExpression)

void	setBoundsRelative (float proportionalX, float proportionalY, float proportionalWidth, float proportionalHeight)

void	setBoundsInset (const BorderSize< int > &borders)

void	setBoundsToFit (int x, int y, int width, int height, Justification justification, bool onlyReduceInSize)

void	setCentrePosition (int x, int y)

void	setCentreRelative (float x, float y)

void	centreWithSize (int width, int height)

void	setTransform (const AffineTransform &transform)

AffineTransform	getTransform () const

bool	isTransformed () const noexcept

int	proportionOfWidth (float proportion) const noexcept

int	proportionOfHeight (float proportion) const noexcept

int	getParentWidth () const noexcept

int	getParentHeight () const noexcept

Rectangle< int >	getParentMonitorArea () const

int	getNumChildComponents () const noexcept

Component *	getChildComponent (int index) const noexcept

int	getIndexOfChildComponent (const Component *child) const noexcept

Component *	findChildWithID (StringRef componentID) const noexcept

void	addChildComponent (Component *child, int zOrder=-1)

void	addChildComponent (Component &child, int zOrder=-1)

void	addAndMakeVisible (Component *child, int zOrder=-1)

void	addAndMakeVisible (Component &child, int zOrder=-1)

void	addChildAndSetID (Component *child, const String &componentID)

void	removeChildComponent (Component *childToRemove)

Component *	removeChildComponent (int childIndexToRemove)

void	removeAllChildren ()

void	deleteAllChildren ()

Component *	getParentComponent () const noexcept

template<class TargetClass >
TargetClass *	findParentComponentOfClass () const

Component *	getTopLevelComponent () const noexcept

bool	isParentOf (const Component *possibleChild) const noexcept

virtual void	childrenChanged ()

virtual bool	hitTest (int x, int y)

void	setInterceptsMouseClicks (bool allowClicksOnThisComponent, bool allowClicksOnChildComponents) noexcept

void	getInterceptsMouseClicks (bool &allowsClicksOnThisComponent, bool &allowsClicksOnChildComponents) const noexcept

bool	contains (Point< int > localPoint)

bool	reallyContains (Point< int > localPoint, bool returnTrueIfWithinAChild)

Component *	getComponentAt (int x, int y)

Component *	getComponentAt (Point< int > position)

void	repaint ()

void	repaint (int x, int y, int width, int height)

void	repaint (const Rectangle< int > &area)

void	setBufferedToImage (bool shouldBeBuffered)

Image	createComponentSnapshot (const Rectangle< int > &areaToGrab, bool clipImageToComponentBounds=true, float scaleFactor=1.0f)

void	paintEntireComponent (Graphics &context, bool ignoreAlphaLevel)

void	setPaintingIsUnclipped (bool shouldPaintWithoutClipping) noexcept

void	setComponentEffect (ImageEffectFilter *newEffect)

ImageEffectFilter *	getComponentEffect () const noexcept

LookAndFeel &	getLookAndFeel () const noexcept

void	setLookAndFeel (LookAndFeel *newLookAndFeel)

virtual void	lookAndFeelChanged ()

void	sendLookAndFeelChange ()

void	setOpaque (bool shouldBeOpaque)

bool	isOpaque () const noexcept

void	setBroughtToFrontOnMouseClick (bool shouldBeBroughtToFront) noexcept

bool	isBroughtToFrontOnMouseClick () const noexcept

void	setWantsKeyboardFocus (bool wantsFocus) noexcept

bool	getWantsKeyboardFocus () const noexcept

void	setMouseClickGrabsKeyboardFocus (bool shouldGrabFocus)

bool	getMouseClickGrabsKeyboardFocus () const noexcept

void	grabKeyboardFocus ()

bool	hasKeyboardFocus (bool trueIfChildIsFocused) const

void	moveKeyboardFocusToSibling (bool moveToNext)

virtual KeyboardFocusTraverser *	createFocusTraverser ()

int	getExplicitFocusOrder () const

void	setExplicitFocusOrder (int newFocusOrderIndex)

void	setFocusContainer (bool shouldBeFocusContainer) noexcept

bool	isFocusContainer () const noexcept

bool	isEnabled () const noexcept

void	setEnabled (bool shouldBeEnabled)

void	setAlpha (float newAlpha)

float	getAlpha () const

void	setMouseCursor (const MouseCursor &cursorType)

virtual MouseCursor	getMouseCursor ()

void	updateMouseCursor () const

virtual void	paintOverChildren (Graphics &g)

virtual void	mouseMove (const MouseEvent &event) override

virtual void	mouseDoubleClick (const MouseEvent &event) override

virtual void	mouseWheelMove (const MouseEvent &event, const MouseWheelDetails &wheel) override

virtual void	mouseMagnify (const MouseEvent &event, float scaleFactor)

void	setRepaintsOnMouseActivity (bool shouldRepaint) noexcept

void	addMouseListener (MouseListener *newListener, bool wantsEventsForAllNestedChildComponents)

void	removeMouseListener (MouseListener *listenerToRemove)

void	addKeyListener (KeyListener *newListener)

void	removeKeyListener (KeyListener *listenerToRemove)

virtual bool	keyStateChanged (bool isKeyDown)

virtual void	modifierKeysChanged (const ModifierKeys &modifiers)

virtual void	focusOfChildComponentChanged (FocusChangeType cause)

bool	isMouseOver (bool includeChildren=false) const

bool	isMouseButtonDown () const

bool	isMouseOverOrDragging () const

Point< int >	getMouseXYRelative () const

virtual void	resized ()

virtual void	moved ()

virtual void	childBoundsChanged (Component *child)

virtual void	parentSizeChanged ()

virtual void	broughtToFront ()

void	addComponentListener (ComponentListener *newListener)

void	removeComponentListener (ComponentListener *listenerToRemove)

void	postCommandMessage (int commandId)

int	runModalLoop ()

void	enterModalState (bool takeKeyboardFocus=true, ModalComponentManager::Callback *callback=nullptr, bool deleteWhenDismissed=false)

void	exitModalState (int returnValue)

bool	isCurrentlyModal () const noexcept

bool	isCurrentlyBlockedByAnotherModalComponent () const

virtual bool	canModalEventBeSentToComponent (const Component *targetComponent)

virtual void	inputAttemptWhenModal ()

NamedValueSet &	getProperties () noexcept

const NamedValueSet &	getProperties () const noexcept

Colour	findColour (int colourId, bool inheritFromParent=false) const

void	setColour (int colourId, Colour newColour)

void	removeColour (int colourId)

bool	isColourSpecified (int colourId) const

void	copyAllExplicitColoursTo (Component &target) const

virtual MarkerList *	getMarkers (bool xAxis)

void *	getWindowHandle () const

Positioner *	getPositioner () const noexcept

void	setPositioner (Positioner *newPositioner)

void	setCachedComponentImage (CachedComponentImage *newCachedImage)

CachedComponentImage *	getCachedComponentImage () const noexcept

	JUCE_DEPRECATED (Point< int > relativePositionToGlobal(Point< int >) const)

	JUCE_DEPRECATED (Point< int > globalPositionToRelative(Point< int >) const)

	JUCE_DEPRECATED (Point< int > relativePositionToOtherComponent(const Component *, Point< int >) const)

Public Member Functions inherited from juce::MouseListener
virtual	~MouseListener ()

Public Member Functions inherited from juce::SettableTooltipClient
virtual	~SettableTooltipClient ()

virtual String	getTooltip ()

Public Member Functions inherited from juce::TooltipClient
virtual	~TooltipClient ()

Protected Member Functions
void	clicked () override

void	colourChanged () override

void	paintButton (Graphics &, bool isMouseOver, bool isButtonDown) override

Protected Member Functions inherited from juce::Button
	Button (const String &buttonName)

virtual void	clicked (const ModifierKeys &modifiers)

virtual void	buttonStateChanged ()

virtual void	internalClickCallback (const ModifierKeys &)

void	handleCommandMessage (int commandId) override

void	mouseEnter (const MouseEvent &) override

void	mouseExit (const MouseEvent &) override

void	mouseDown (const MouseEvent &) override

void	mouseDrag (const MouseEvent &) override

void	mouseUp (const MouseEvent &) override

bool	keyPressed (const KeyPress &) override

void	paint (Graphics &) override

void	parentHierarchyChanged () override

void	visibilityChanged () override

void	focusGained (FocusChangeType) override

void	focusLost (FocusChangeType) override

void	enablementChanged () override

Protected Member Functions inherited from juce::Component
virtual ComponentPeer *	createNewPeer (int styleFlags, void *nativeWindowToAttachTo)

Protected Member Functions inherited from juce::SettableTooltipClient
	SettableTooltipClient ()

Additional Inherited Members
Static Public Member Functions inherited from juce::Component
static Component *JUCE_CALLTYPE	getCurrentlyFocusedComponent () noexcept

static void JUCE_CALLTYPE	unfocusAllComponents ()

static void JUCE_CALLTYPE	beginDragAutoRepeat (int millisecondsBetweenCallbacks)

static bool JUCE_CALLTYPE	isMouseButtonDownAnywhere () noexcept

static int JUCE_CALLTYPE	getNumCurrentlyModalComponents () noexcept

static Component *JUCE_CALLTYPE	getCurrentlyModalComponent (int index=0) noexcept

Detailed Description

A button showing an underlined weblink, that will launch the link when it's clicked.

See also: Button

Member Enumeration Documentation

◆ ColourIds

enum juce::HyperlinkButton::ColourIds

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 also: Component::setColour, Component::findColour, LookAndFeel::setColour, LookAndFeel::findColour

Enumerator
textColourId	The colour to use for the URL text.

Constructor & Destructor Documentation

◆ HyperlinkButton() [1/2]

HyperlinkButton::HyperlinkButton	(	const String &	linkText,
		const URL &	linkURL
	)

Creates a HyperlinkButton.

Parameters

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::getButtonText() method
linkURL	the URL to launch when the user clicks the button

◆ HyperlinkButton() [2/2]

HyperlinkButton::HyperlinkButton ( )

Creates a HyperlinkButton.

◆ ~HyperlinkButton()

HyperlinkButton::~HyperlinkButton ( )

Destructor.

Member Function Documentation

◆ changeWidthToFitText()

void HyperlinkButton::changeWidthToFitText ( )

Resizes the button horizontally to fit snugly around the text.

This won't affect the button's height.

◆ clicked()

void HyperlinkButton::clicked ( )

overrideprotectedvirtual

This method is called when the button has been clicked.

Subclasses can override this to perform whatever they actions they need to do.

Alternatively, a ButtonListener can be added to the button, and these listeners will be called when the click occurs.

See also: triggerClick

Reimplemented from juce::Button.

◆ colourChanged()

void HyperlinkButton::colourChanged ( )

overrideprotectedvirtual

This method is called when a colour is changed by the setColour() method.

See also: setColour, findColour

Reimplemented from juce::Component.

◆ getURL()

const URL& juce::HyperlinkButton::getURL ( ) const

inlinenoexcept

Returns the URL that the button will trigger.

◆ paintButton()

void HyperlinkButton::paintButton	(	Graphics &	g,
		bool	isMouseOverButton,
		bool	isButtonDown
	)

overrideprotectedvirtual

Subclasses should override this to actually paint the button's contents.

It's better to use this than the paint method, because it gives you information about the over/down state of the button.

Parameters

g	the graphics context to use
isMouseOverButton	true if the button is either in the 'over' or 'down' state
isButtonDown	true if the button should be drawn in the 'down' position

Implements juce::Button.

◆ setFont()

void HyperlinkButton::setFont	(	const Font &	newFont,
		bool	resizeToMatchComponentHeight,
		Justification	justificationType = `Justification::horizontallyCentred`
	)

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.

◆ setURL()

void HyperlinkButton::setURL ( const URL & newURL )

noexcept

Changes the URL that the button will trigger.

The documentation for this class was generated from the following files:

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ColourIds

Constructor & Destructor Documentation

◆ HyperlinkButton() [1/2]

◆ HyperlinkButton() [2/2]

◆ ~HyperlinkButton()

Member Function Documentation

◆ changeWidthToFitText()

◆ clicked()

◆ colourChanged()

◆ getURL()

◆ paintButton()

◆ setFont()

◆ setURL()