juce::SettableTooltipClient Class Reference

An implementation of TooltipClient that stores the tooltip string and a method for changing it. More...

#include <juce_TooltipClient.h>

Inheritance diagram for juce::SettableTooltipClient:

Collaboration diagram for juce::SettableTooltipClient:

Public Member Functions
	~SettableTooltipClient () override=default
	Destructor.
String	getTooltip () override
	Returns the tooltip assigned to this object.
virtual void	setTooltip (const String &newTooltip)
	Assigns a new tooltip to this object.

Protected Member Functions
	SettableTooltipClient ()=default

Private Attributes
String	tooltipString

Detailed Description

An implementation of TooltipClient that stores the tooltip string and a method for changing it.

This makes it easy to add a tooltip to a custom component, by simply adding this as a base class and calling setTooltip().

Many of the JUCE widgets already use this as a base class to implement their tooltips. See the TooltipWindow docs for more information about implementing tooltips.

See also

TooltipClient, TooltipWindow

@tags{GUI}

Constructor & Destructor Documentation

~SettableTooltipClient()

juce::SettableTooltipClient::~SettableTooltipClient ( )

overridedefault

Destructor.

SettableTooltipClient()

juce::SettableTooltipClient::SettableTooltipClient ( )

protecteddefault

Member Function Documentation

getTooltip()

String juce::SettableTooltipClient::getTooltip ( )

inlineoverridevirtual

Returns the tooltip assigned to this object.

Implements juce::TooltipClient.

Referenced by juce::detail::ButtonAccessibilityHandler::getHelp().

setTooltip()

virtual void juce::SettableTooltipClient::setTooltip ( const String &  newTooltip )

inlinevirtual

Assigns a new tooltip to this object.

Reimplemented in juce::Button, juce::FilenameComponent, and juce::ComboBox.

Member Data Documentation

tooltipString

String juce::SettableTooltipClient::tooltipString

private

---

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

• juce_TooltipClient.h