#include <juce_BubbleMessageComponent.h>

Inheritance diagram for juce::BubbleMessageComponent:

Public Member Functions
	BubbleMessageComponent (int fadeOutLengthMs=150)
	~BubbleMessageComponent () override
void	showAt (const Rectangle< int > &position, const AttributedString &message, int numMillisecondsBeforeRemoving, bool removeWhenMouseClicked=true, bool deleteSelfAfterUse=false)
void	showAt (Component *component, const AttributedString &message, int numMillisecondsBeforeRemoving, bool removeWhenMouseClicked=true, bool deleteSelfAfterUse=false)
void	getContentSize (int &w, int &h) override
void	paintContent (Graphics &g, int w, int h) override
void	timerCallback () override
Public Member Functions inherited from juce::BubbleComponent
	~BubbleComponent () override
void	setAllowedPlacement (int newPlacement)
void	setPosition (Component *componentToPointTo, int distanceFromTarget=15, int arrowLength=10)
void	setPosition (Point< int > arrowTipPosition, int arrowLength=10)
void	setPosition (Rectangle< int > rectangleToPointTo, int distanceFromTarget=15, int arrowLength=10)
void	paint (Graphics &) override
Public Member Functions inherited from juce::Component
	Component () noexcept
	~Component () override
	Component (const String &componentName) noexcept
String	getName () const noexcept
virtual void	setName (const String &newName)
String	getComponentID () const noexcept
void	setComponentID (const String &newID)
virtual void	setVisible (bool shouldBeVisible)
bool	isVisible () const noexcept
virtual void	visibilityChanged ()
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 shouldAlsoGainKeyboardFocus)
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
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, Rectangle< int > areaRelativeToSourceComponent) const
Rectangle< float >	getLocalArea (const Component *sourceComponent, Rectangle< float > areaRelativeToSourceComponent) const
Point< int >	localPointToGlobal (Point< int > localPoint) const
Point< float >	localPointToGlobal (Point< float > localPoint) const
Rectangle< int >	localAreaToGlobal (Rectangle< int > localArea) const
Rectangle< float >	localAreaToGlobal (Rectangle< float > 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 (Rectangle< int > newBounds)
void	setBoundsRelative (float proportionalX, float proportionalY, float proportionalWidth, float proportionalHeight)
void	setBoundsRelative (Rectangle< float > proportionalArea)
void	setBoundsInset (BorderSize< int > borders)
void	setBoundsToFit (Rectangle< int > targetArea, Justification justification, bool onlyReduceInSize)
void	setCentrePosition (int x, int y)
void	setCentrePosition (Point< int > newCentrePosition)
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
const Array< Component * > &	getChildren () 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	parentHierarchyChanged ()
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	contains (Point< float > localPoint)
bool	reallyContains (Point< int > localPoint, bool returnTrueIfWithinAChild)
bool	reallyContains (Point< float > localPoint, bool returnTrueIfWithinAChild)
Component *	getComponentAt (int x, int y)
Component *	getComponentAt (Point< int > position)
Component *	getComponentAt (Point< float > position)
void	repaint ()
void	repaint (int x, int y, int width, int height)
void	repaint (Rectangle< int > area)
void	setBufferedToImage (bool shouldBeBuffered)
Image	createComponentSnapshot (Rectangle< int > areaToGrab, bool clipImageToComponentBounds=true, float scaleFactor=1.0f)
void	paintEntireComponent (Graphics &context, bool ignoreAlphaLevel)
void	setPaintingIsUnclipped (bool shouldPaintWithoutClipping) noexcept
bool	isPaintingUnclipped () const 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	setExplicitFocusOrder (int newFocusOrderIndex)
int	getExplicitFocusOrder () const
void	setFocusContainerType (FocusContainerType containerType) noexcept
bool	isFocusContainer () const noexcept
bool	isKeyboardFocusContainer () const noexcept
Component *	findFocusContainer () const
Component *	findKeyboardFocusContainer () const
void	setWantsKeyboardFocus (bool wantsFocus) noexcept
bool	getWantsKeyboardFocus () const noexcept
void	setMouseClickGrabsKeyboardFocus (bool shouldGrabFocus)
bool	getMouseClickGrabsKeyboardFocus () const noexcept
void	grabKeyboardFocus ()
void	giveAwayKeyboardFocus ()
bool	hasKeyboardFocus (bool trueIfChildIsFocused) const
void	moveKeyboardFocusToSibling (bool moveToNext)
virtual std::unique_ptr< ComponentTraverser >	createFocusTraverser ()
virtual std::unique_ptr< ComponentTraverser >	createKeyboardFocusTraverser ()
void	setHasFocusOutline (bool hasFocusOutline) noexcept
bool	hasFocusOutline () const noexcept
bool	isEnabled () const noexcept
void	setEnabled (bool shouldBeEnabled)
virtual void	enablementChanged ()
float	getAlpha () const noexcept
void	setAlpha (float newAlpha)
virtual void	alphaChanged ()
void	setMouseCursor (const MouseCursor &cursorType)
virtual MouseCursor	getMouseCursor ()
void	updateMouseCursor () const
virtual void	paintOverChildren (Graphics &g)
void	mouseMove (const MouseEvent &event) override
void	mouseEnter (const MouseEvent &event) override
void	mouseExit (const MouseEvent &event) override
void	mouseDown (const MouseEvent &event) override
void	mouseDrag (const MouseEvent &event) override
void	mouseUp (const MouseEvent &event) override
void	mouseDoubleClick (const MouseEvent &event) override
void	mouseWheelMove (const MouseEvent &event, const MouseWheelDetails &wheel) override
void	mouseMagnify (const MouseEvent &event, float scaleFactor) override
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	keyPressed (const KeyPress &key)
virtual bool	keyStateChanged (bool isKeyDown)
virtual void	modifierKeysChanged (const ModifierKeys &modifiers)
virtual void	focusGained (FocusChangeType cause)
virtual void	focusLost (FocusChangeType cause)
virtual void	focusOfChildComponentChanged (FocusChangeType cause)
bool	isMouseOver (bool includeChildren=false) const
bool	isMouseButtonDown (bool includeChildren=false) const
bool	isMouseOverOrDragging (bool includeChildren=false) 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)
virtual void	handleCommandMessage (int commandId)
void	enterModalState (bool takeKeyboardFocus=true, ModalComponentManager::Callback *callback=nullptr, bool deleteWhenDismissed=false)
void	exitModalState (int returnValue)
bool	isCurrentlyModal (bool onlyConsiderForemostModalComponent=true) 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 void	colourChanged ()
void *	getWindowHandle () const
Positioner *	getPositioner () const noexcept
void	setPositioner (Positioner *newPositioner)
void	setCachedComponentImage (CachedComponentImage *newCachedImage)
CachedComponentImage *	getCachedComponentImage () const noexcept
void	setViewportIgnoreDragFlag (bool ignoreDrag) noexcept
bool	getViewportIgnoreDragFlag () const noexcept
String	getTitle () const noexcept
void	setTitle (const String &newTitle)
String	getDescription () const noexcept
void	setDescription (const String &newDescription)
String	getHelpText () const noexcept
void	setHelpText (const String &newHelpText)
void	setAccessible (bool shouldBeAccessible)
bool	isAccessible () const noexcept
AccessibilityHandler *	getAccessibilityHandler ()
void	invalidateAccessibilityHandler ()
void	setFocusContainer (bool shouldBeFocusContainer) noexcept
void	contains (int, int)=delete
Public Member Functions inherited from juce::MouseListener
virtual	~MouseListener ()=default

Private Member Functions
void	createLayout (const AttributedString &)
void	init (int, bool, bool)
void	hide (bool fadeOut)
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
int	fadeOutLength
int	mouseClickCounter
TextLayout	textLayout
int64	expiryTime
bool	deleteAfterUse

Additional Inherited Members
Public Types inherited from juce::BubbleComponent
enum	BubblePlacement { above = 1 , below = 2 , left = 4 , right = 8 }
enum	ColourIds { backgroundColourId = 0x1000af0 , outlineColourId = 0x1000af1 }
Public Types inherited from juce::Component
enum class	FocusContainerType { none , focusContainer , keyboardFocusContainer }
enum	FocusChangeType { focusChangedByMouseClick , focusChangedByTabKey , focusChangedDirectly }
Static Public Member Functions inherited from juce::Component
static float JUCE_CALLTYPE	getApproximateScaleFactorForComponent (const Component *targetComponent)
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
Protected Member Functions inherited from juce::BubbleComponent
	BubbleComponent ()
Protected Member Functions inherited from juce::Component
virtual ComponentPeer *	createNewPeer (int styleFlags, void *nativeWindowToAttachTo)
Static Protected Member Functions inherited from juce::Component
static std::unique_ptr< AccessibilityHandler >	createIgnoredAccessibilityHandler (Component &)
Static Private Member Functions inherited from juce::Timer
static void JUCE_CALLTYPE	callAfterDelay (int milliseconds, std::function< void()> functionToCall)
static void JUCE_CALLTYPE	callPendingTimersSynchronously ()

Detailed Description

A speech-bubble component that displays a short message.

This can be used to show a message with the tail of the speech bubble pointing to a particular component or location on the screen.

See also: BubbleComponent

@tags{GUI}

Constructor & Destructor Documentation

◆ BubbleMessageComponent()

juce::BubbleMessageComponent::BubbleMessageComponent ( int fadeOutLengthMs = 150 )

Creates a bubble component.

After creating one a BubbleComponent, do the following:

add it to an appropriate parent component, or put it on the desktop with Component::addToDesktop (0).
use the showAt() method to show a message.
it will make itself invisible after it times-out (and can optionally also delete itself), or you can reuse it somewhere else by calling showAt() again.

◆ ~BubbleMessageComponent()

juce::BubbleMessageComponent::~BubbleMessageComponent ( )

override

Destructor.

Member Function Documentation

◆ createLayout()

void juce::BubbleMessageComponent::createLayout ( const AttributedString & text )

private

◆ getContentSize()

void juce::BubbleMessageComponent::getContentSize	(	int &	width,
		int &	height )

overridevirtual

Subclasses should override this to return the size of the content they want to draw inside the bubble.

Implements juce::BubbleComponent.

◆ hide()

void juce::BubbleMessageComponent::hide ( bool fadeOut )

private

◆ init()

void juce::BubbleMessageComponent::init	(	int	numMillisecondsBeforeRemoving,
		bool	removeWhenMouseClicked,
		bool	deleteSelfAfterUse )

private

◆ paintContent()

void juce::BubbleMessageComponent::paintContent	(	Graphics &	g,
		int	width,
		int	height )

overridevirtual

Subclasses should override this to draw their bubble's contents.

The graphics object's clip region and the dimensions passed in here are set up to paint just the rectangle inside the bubble.

Implements juce::BubbleComponent.

◆ showAt() [1/2]

void juce::BubbleMessageComponent::showAt	(	Component *	component,
		const AttributedString &	message,
		int	numMillisecondsBeforeRemoving,
		bool	removeWhenMouseClicked = true,
		bool	deleteSelfAfterUse = false )

Shows a message bubble next to a particular component.

This shows the bubble with its stem pointing at the given component.

Parameters

component	the component that you want to point at
message	the text to display
numMillisecondsBeforeRemoving	how long to leave it on the screen before removing itself from its parent component. If this is 0 or less, it will stay there until manually removed.
removeWhenMouseClicked	if this is true, the bubble will disappear as soon as a mouse button is pressed (anywhere on the screen)
deleteSelfAfterUse	if true, then the component will delete itself after it becomes invisible

◆ showAt() [2/2]

void juce::BubbleMessageComponent::showAt	(	const Rectangle< int > &	position,
		const AttributedString &	message,
		int	numMillisecondsBeforeRemoving,
		bool	removeWhenMouseClicked = true,
		bool	deleteSelfAfterUse = false )

Shows a message bubble at a particular position.

This shows the bubble with its stem pointing to the given location (coordinates being relative to its parent component).

Parameters

position	the coords of the object to point to
message	the text to display
numMillisecondsBeforeRemoving	how long to leave it on the screen before removing itself from its parent component. If this is 0 or less, it will stay there until manually removed.
removeWhenMouseClicked	if this is true, the bubble will disappear as soon as a mouse button is pressed (anywhere on the screen)
deleteSelfAfterUse	if true, then the component will delete itself after it becomes invisible

◆ timerCallback()

void juce::BubbleMessageComponent::timerCallback ( )

overridevirtual

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.

Member Data Documentation

◆ deleteAfterUse

bool juce::BubbleMessageComponent::deleteAfterUse

private

◆ expiryTime

int64 juce::BubbleMessageComponent::expiryTime

private

◆ fadeOutLength

int juce::BubbleMessageComponent::fadeOutLength

private

◆ mouseClickCounter

int juce::BubbleMessageComponent::mouseClickCounter

private

◆ textLayout

TextLayout juce::BubbleMessageComponent::textLayout

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_extra/misc/juce_BubbleMessageComponent.h
/home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_gui_extra/misc/juce_BubbleMessageComponent.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BubbleMessageComponent()

◆ ~BubbleMessageComponent()

Member Function Documentation

◆ createLayout()

◆ getContentSize()

◆ hide()

◆ init()

◆ paintContent()

◆ showAt() [1/2]

◆ showAt() [2/2]

◆ timerCallback()

Member Data Documentation

◆ deleteAfterUse

◆ expiryTime

◆ fadeOutLength

◆ mouseClickCounter

◆ textLayout