paulxstretch/deps/juce/modules/juce_gui_basics/mouse/juce_TooltipClient.h
essej 25bd5d8adb git subrepo clone --branch=sono6good https://github.com/essej/JUCE.git deps/juce
subrepo:
  subdir:   "deps/juce"
  merged:   "b13f9084e"
upstream:
  origin:   "https://github.com/essej/JUCE.git"
  branch:   "sono6good"
  commit:   "b13f9084e"
git-subrepo:
  version:  "0.4.3"
  origin:   "https://github.com/ingydotnet/git-subrepo.git"
  commit:   "2f68596"
2022-04-18 17:51:22 -04:00

89 lines
2.8 KiB
C++

/*
==============================================================================
This file is part of the JUCE library.
Copyright (c) 2020 - 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 6 End-User License
Agreement and JUCE Privacy Policy (both effective as of the 16th June 2020).
End User License Agreement: www.juce.com/juce-6-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
{
//==============================================================================
/**
Components that want to use pop-up tooltips should implement this interface.
A TooltipWindow will wait for the mouse to hover over a component that
implements the TooltipClient interface, and when it finds one, it will display
the tooltip returned by its getTooltip() method.
@see TooltipWindow, SettableTooltipClient
@tags{GUI}
*/
class JUCE_API TooltipClient
{
public:
/** Destructor. */
virtual ~TooltipClient() = default;
/** Returns the string that this object wants to show as its tooltip. */
virtual String getTooltip() = 0;
};
//==============================================================================
/**
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 TooltipClient, TooltipWindow
@tags{GUI}
*/
class JUCE_API SettableTooltipClient : public TooltipClient
{
public:
//==============================================================================
/** Destructor. */
~SettableTooltipClient() override = default;
//==============================================================================
/** Assigns a new tooltip to this object. */
virtual void setTooltip (const String& newTooltip) { tooltipString = newTooltip; }
/** Returns the tooltip assigned to this object. */
String getTooltip() override { return tooltipString; }
protected:
SettableTooltipClient() = default;
private:
String tooltipString;
};
} // namespace juce