openshot-audio  0.1.6
Public Member Functions | List of all members
juce::BubbleMessageComponent Class Reference

#include <juce_gui_extra.h>

Inheritance diagram for juce::BubbleMessageComponent:
juce::Timer

Public Member Functions

 BubbleMessageComponent (int fadeOutLengthMs=150)
 
 ~BubbleMessageComponent ()
 
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)
 
void paintContent (Graphics &g, int w, int h)
 
void timerCallback ()
 

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

Constructor & Destructor Documentation

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::~BubbleMessageComponent ( )

Destructor.

Member Function Documentation

void BubbleMessageComponent::getContentSize ( int w,
int h 
)
void BubbleMessageComponent::paintContent ( Graphics g,
int  w,
int  h 
)
void 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).

For details about exactly how it decides where to position itself, see BubbleComponent::updatePosition().

Parameters
positionthe coords of the object to point to
messagethe text to display
numMillisecondsBeforeRemovinghow long to leave it on the screen before removing itself from its parent compnent. If this is 0 or less, it will stay there until manually removed.
removeWhenMouseClickedif this is true, the bubble will disappear as soon as a mouse button is pressed (anywhere on the screen)
deleteSelfAfterUseif true, then the component will delete itself after it becomes invisible
void 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.

For details about exactly how it decides where to position itself, see BubbleComponent::updatePosition().

Parameters
componentthe component that you want to point at
messagethe text to display
numMillisecondsBeforeRemovinghow long to leave it on the screen before removing itself from its parent compnent. If this is 0 or less, it will stay there until manually removed.
removeWhenMouseClickedif this is true, the bubble will disappear as soon as a mouse button is pressed (anywhere on the screen)
deleteSelfAfterUseif true, then the component will delete itself after it becomes invisible
void BubbleMessageComponent::timerCallback ( )
virtual

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.


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