#include <juce_TooltipWindow.h>
Classes | |
| struct | LookAndFeelMethods |
Public Types | |
| enum | ColourIds { backgroundColourId = 0x1001b00 , textColourId = 0x1001c00 , outlineColourId = 0x1001c10 } |
| Public Types inherited from juce::Component | |
| enum class | FocusContainerType { none , focusContainer , keyboardFocusContainer } |
| enum | FocusChangeType { focusChangedByMouseClick , focusChangedByTabKey , focusChangedDirectly } |
Private Types | |
| enum | ShownManually { yes , no } |
Private Member Functions | |
| void | displayTipInternal (Point< int >, const String &, ShownManually) |
| std::unique_ptr< AccessibilityHandler > | createAccessibilityHandler () override |
| void | paint (Graphics &) override |
| void | mouseEnter (const MouseEvent &) override |
| void | mouseDown (const MouseEvent &) override |
| void | mouseWheelMove (const MouseEvent &, const MouseWheelDetails &) override |
| void | timerCallback () override |
| void | updatePosition (const String &, Point< int >, Rectangle< int >) |
| Private Member Functions inherited from juce::Timer | |
| virtual | ~Timer () |
| void | startTimer (int intervalInMilliseconds) noexcept |
| void | startTimerHz (int timerFrequencyHz) noexcept |
| void | stopTimer () noexcept |
| bool | isTimerRunning () const noexcept |
| int | getTimerInterval () const noexcept |
| Timer () noexcept | |
| Timer (const Timer &) noexcept | |
Private Attributes | |
| Point< float > | lastMousePos |
| SafePointer< Component > | lastComponentUnderMouse |
| String | tipShowing |
| String | lastTipUnderMouse |
| String | manuallyShownTip |
| int | millisecondsBeforeTipAppears |
| unsigned int | lastCompChangeTime = 0 |
| unsigned int | lastHideTime = 0 |
| bool | reentrant = false |
| bool | dismissalMouseEventOccurred = false |
Detailed Description
A window that displays a pop-up tooltip when the mouse hovers over another component.
To enable tooltips in your app, just create a single instance of a TooltipWindow object. Note that if you instantiate more than one instance of this class with the same parentComponent (even if both TooltipWindow's parentComponent is nil), you'll end up with multiple tooltips being shown! To avoid this use a SharedResourcePointer to instantiate the TooltipWindow only once.
For audio plug-ins (which should not be opening native windows) it is better to add a TooltipWindow as a member variable to the editor and ensure that the editor is the parentComponent of your TooltipWindow. This will ensure that your TooltipWindow is scaled according to your editor and the DAWs scaling setting.
The TooltipWindow object will then stay invisible, waiting until the mouse hovers for the specified length of time - it will then see if it's currently over a component which implements the TooltipClient interface, and if so, it will make itself visible to show the tooltip in the appropriate place.
@tags{GUI}
Member Enumeration Documentation
◆ ColourIds
| enum juce::TooltipWindow::ColourIds |
A set of colour IDs to use to change the colour of various aspects of the tooltip.
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 | |
|---|---|
| backgroundColourId | The colour to fill the background with. |
| textColourId | The colour to use for the text. |
| outlineColourId | The colour to use to draw an outline around the tooltip. |
◆ ShownManually
Constructor & Destructor Documentation
◆ TooltipWindow()
|
explicit |
Creates a tooltip window.
Make sure your app only creates one instance of this class, otherwise you'll get multiple overlaid tooltips appearing. The window will initially be invisible and will make itself visible when it needs to display a tip.
To change the style of tooltips, see the LookAndFeel class for its tooltip methods.
- Parameters
-
parentComponent if set to nullptr, the TooltipWindow will appear on the desktop, otherwise the tooltip will be added to the given parent component. millisecondsBeforeTipAppears the time for which the mouse has to stay still before a tooltip will be shown
- See also
- TooltipClient, LookAndFeel::drawTooltip, LookAndFeel::getTooltipBounds
◆ ~TooltipWindow()
|
override |
Destructor.
Member Function Documentation
◆ createAccessibilityHandler()
|
overrideprivatevirtual |
Override this method to return a custom AccessibilityHandler for this component.
The default implementation creates and returns a AccessibilityHandler object with an unspecified role, meaning that it will be visible to accessibility clients but without a specific role, action callbacks or interfaces. To control how accessibility clients see and interact with your component subclass AccessibilityHandler, implement the desired behaviours, and return an instance of it from this method in your component subclass.
The accessibility handler you return here is guaranteed to be destroyed before its Component, so it's safe to store and use a reference back to the Component inside the AccessibilityHandler if necessary.
- See also
- getAccessibilityHandler
Reimplemented from juce::Component.
◆ displayTip()
Can be called to manually force a tip to be shown at a particular location.
The tip will be shown until hideTip() is called, or a dismissal mouse event occurs.
- See also
- hideTip
◆ displayTipInternal()
|
private |
◆ getDesktopScaleFactor()
|
overridevirtual |
Returns the default scale factor to use for this component when it is placed on the desktop. The default implementation of this method just returns the value from Desktop::getGlobalScaleFactor(), but it can be overridden if a particular component has different requirements. The method only used if this component is added to the desktop - it has no effect for child components.
Reimplemented from juce::Component.
◆ getTipFor()
Asks a component for its tooltip. This can be overridden if you need custom lookup behaviour or to modify the strings.
◆ hideTip()
| void juce::TooltipWindow::hideTip | ( | ) |
Can be called to manually hide the tip if it's showing.
◆ mouseDown()
|
overrideprivatevirtual |
Called when a mouse button is pressed.
The MouseEvent object passed in contains lots of methods for finding out which button was pressed, as well as which modifier keys (e.g. shift, ctrl) were held down at the time.
Once a button is held down, the mouseDrag method will be called when the mouse moves, until the button is released.
- Parameters
-
Event details about the position and status of the mouse event, including the source component in which it occurred
- See also
- mouseUp, mouseDrag, mouseDoubleClick, contains
Reimplemented from juce::Component.
◆ mouseEnter()
|
overrideprivatevirtual |
Called when the mouse first enters a component.
If the mouse button isn't pressed and the mouse moves into a component, this will be called to let the component react to this.
When the mouse button is pressed and held down while being moved in or out of a component, no mouseEnter or mouseExit callbacks are made - only mouseDrag messages are sent to the component that the mouse was originally clicked on, until the button is released.
- Parameters
-
Event details about the position and status of the mouse event, including the source component in which it occurred
- See also
- mouseExit, mouseDrag, mouseMove, contains
Reimplemented from juce::Component.
◆ mouseWheelMove()
|
overrideprivatevirtual |
Called when the mouse-wheel is moved.
This callback is sent to the component that the mouse is over when the wheel is moved.
If not overridden, a component will forward this message to its parent, so that parent components can collect mouse-wheel messages that happen to child components which aren't interested in them. (Bear in mind that if you attach a component as a mouse-listener to other components, then those wheel moves will also end up calling this method and being passed up to the parents, which may not be what you intended to happen).
- Parameters
-
Event details about the mouse event wheel details about the mouse wheel movement
Reimplemented from juce::Component.
◆ paint()
Components can override this method to draw their content.
The paint() method gets called when a region of a component needs redrawing, either because the component's repaint() method has been called, or because something has happened on the screen that means a section of a window needs to be redrawn.
Any child components will draw themselves over whatever this method draws. If you need to paint over the top of your child components, you can also implement the paintOverChildren() method to do this.
If you want to cause a component to redraw itself, this is done asynchronously - calling the repaint() method marks a region of the component as "dirty", and the paint() method will automatically be called sometime later, by the message thread, to paint any bits that need refreshing. In JUCE (and almost all modern UI frameworks), you never redraw something synchronously.
You should never need to call this method directly - to take a snapshot of the component you could use createComponentSnapshot() or paintEntireComponent().
- Parameters
-
g the graphics context that must be used to do the drawing operations.
- See also
- repaint, paintOverChildren, Graphics
Reimplemented from juce::Component.
◆ setMillisecondsBeforeTipAppears()
Changes the time before the tip appears. This lets you change the value that was set in the constructor.
◆ timerCallback()
|
overrideprivatevirtual |
The user-defined callback routine that actually gets called periodically.
It's perfectly ok to call startTimer() or stopTimer() from within this callback to change the subsequent intervals.
Implements juce::Timer.
◆ updatePosition()
|
private |
Member Data Documentation
◆ dismissalMouseEventOccurred
|
private |
◆ lastCompChangeTime
|
private |
◆ lastComponentUnderMouse
|
private |
◆ lastHideTime
|
private |
◆ lastMousePos
|
private |
◆ lastTipUnderMouse
|
private |
◆ manuallyShownTip
|
private |
◆ millisecondsBeforeTipAppears
|
private |
◆ reentrant
|
private |
◆ tipShowing
|
private |
The documentation for this class was generated from the following files:
- /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_gui_basics/windows/juce_TooltipWindow.h
- /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_gui_basics/windows/juce_TooltipWindow.cpp
Generated on for LMMS by
1.16.1