JUCE  v5.1.1-3-g1a0b28c73
JUCE API
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 SettableTooltipClient:
Collaboration diagram for SettableTooltipClient:

Public Member Functions

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

Protected Member Functions

 SettableTooltipClient ()
 

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 also
TooltipClient, TooltipWindow

Constructor & Destructor Documentation

◆ ~SettableTooltipClient()

SettableTooltipClient::~SettableTooltipClient ( )
inline

Destructor.

◆ SettableTooltipClient()

SettableTooltipClient::SettableTooltipClient ( )
inlineprotected

Member Function Documentation

◆ getTooltip()

String SettableTooltipClient::getTooltip ( )
inlineoverridevirtual

Returns the tooltip assigned to this object.

Implements TooltipClient.

Reimplemented in ComboBox.

◆ setTooltip()

virtual void SettableTooltipClient::setTooltip ( const String newTooltip)
inlinevirtual

Assigns a new tooltip to this object.

Reimplemented in ComboBox, Button, and FilenameComponent.

Member Data Documentation

◆ tooltipString

String SettableTooltipClient::tooltipString
private

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