#include <juce_ImageButton.h>

Inheritance diagram for juce::ImageButton:

Classes
struct	LookAndFeelMethods

Public Member Functions
	ImageButton (const String &name=String())
	~ImageButton () override
void	setImages (bool resizeButtonNowToFitThisImage, bool rescaleImagesWhenButtonSizeChanges, bool preserveImageProportions, const Image &normalImage, float imageOpacityWhenNormal, Colour overlayColourWhenNormal, const Image &overImage, float imageOpacityWhenOver, Colour overlayColourWhenOver, const Image &downImage, float imageOpacityWhenDown, Colour overlayColourWhenDown, float hitTestAlphaThreshold=0.0f)
Image	getNormalImage () const
Image	getOverImage () const
Image	getDownImage () const
Public Member Functions inherited from juce::Button
	~Button () override
void	setButtonText (const String &newText)
const String &	getButtonText () const
bool	isDown () const noexcept
bool	isOver () const noexcept
void	setToggleable (bool shouldBeToggleable)
bool	isToggleable () const noexcept
void	setToggleState (bool shouldBeOn, NotificationType notification)
bool	getToggleState () const noexcept
Value &	getToggleStateValue () noexcept
void	setClickingTogglesState (bool shouldAutoToggleOnClick) noexcept
bool	getClickingTogglesState () const noexcept
void	setRadioGroupId (int newGroupId, NotificationType notification=sendNotification)
int	getRadioGroupId () const noexcept
void	addListener (Listener *newListener)
void	removeListener (Listener *listener)
virtual void	triggerClick ()
void	setCommandToTrigger (ApplicationCommandManager *commandManagerToUse, CommandID commandID, bool generateTooltip)
CommandID	getCommandID () const noexcept
void	addShortcut (const KeyPress &)
void	clearShortcuts ()
bool	isRegisteredForShortcut (const KeyPress &) const
void	setRepeatSpeed (int initialDelayInMillisecs, int repeatDelayInMillisecs, int minimumDelayInMillisecs=-1) noexcept
void	setTriggeredOnMouseDown (bool isTriggeredOnMouseDown) noexcept
bool	getTriggeredOnMouseDown () const noexcept
uint32	getMillisecondsSinceButtonDown () const noexcept
void	setTooltip (const String &newTooltip) override
void	setConnectedEdges (int connectedEdgeFlags)
int	getConnectedEdgeFlags () const noexcept
bool	isConnectedOnLeft () const noexcept
bool	isConnectedOnRight () const noexcept
bool	isConnectedOnTop () const noexcept
bool	isConnectedOnBottom () const noexcept
void	setState (ButtonState newState)
ButtonState	getState () const noexcept
void	setToggleState (bool, bool)
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
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	childrenChanged ()
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)
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 void	modifierKeysChanged (const ModifierKeys &modifiers)
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)
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
Public Member Functions inherited from juce::SettableTooltipClient
	~SettableTooltipClient () override=default
String	getTooltip () override
Public Member Functions inherited from juce::TooltipClient
virtual	~TooltipClient ()=default

Protected Member Functions
bool	hitTest (int x, int y) override
void	paintButton (Graphics &, bool, bool) override
Protected Member Functions inherited from juce::Button
	Button (const String &buttonName)
virtual void	clicked ()
virtual void	clicked (const ModifierKeys &modifiers)
virtual void	buttonStateChanged ()
virtual void	internalClickCallback (const ModifierKeys &)
void	handleCommandMessage (int commandId) override
void	mouseEnter (const MouseEvent &) override
void	mouseExit (const MouseEvent &) override
void	mouseDown (const MouseEvent &) override
void	mouseDrag (const MouseEvent &) override
void	mouseUp (const MouseEvent &) override
bool	keyPressed (const KeyPress &) override
void	paint (Graphics &) override
void	parentHierarchyChanged () override
void	visibilityChanged () override
void	focusGained (FocusChangeType) override
void	focusLost (FocusChangeType) override
void	enablementChanged () override
virtual bool	keyStateChanged (bool isKeyDown)
Protected Member Functions inherited from juce::Component
virtual ComponentPeer *	createNewPeer (int styleFlags, void *nativeWindowToAttachTo)
Protected Member Functions inherited from juce::SettableTooltipClient
	SettableTooltipClient ()=default

Private Member Functions
Image	getCurrentImage () const

Private Attributes
bool	scaleImageToFit
bool	preserveProportions
uint8	alphaThreshold
Rectangle< int >	imageBounds
Image	normalImage
Image	overImage
Image	downImage
float	normalOpacity
float	overOpacity
float	downOpacity
Colour	normalOverlay
Colour	overOverlay
Colour	downOverlay

Additional Inherited Members
Public Types inherited from juce::Button
enum	ConnectedEdgeFlags { ConnectedOnLeft = 1 , ConnectedOnRight = 2 , ConnectedOnTop = 4 , ConnectedOnBottom = 8 }
enum	ButtonState { buttonNormal , buttonOver , buttonDown }
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
Public Attributes inherited from juce::Button
std::function< void()>	onClick
std::function< void()>	onStateChange
Static Protected Member Functions inherited from juce::Component
static std::unique_ptr< AccessibilityHandler >	createIgnoredAccessibilityHandler (Component &)

Detailed Description

As the title suggests, this is a button containing an image.

The colour and transparency of the image can be set to vary when the button state changes.

See also: Button, ShapeButton, TextButton

@tags{GUI}

Constructor & Destructor Documentation

◆ ImageButton()

juce::ImageButton::ImageButton ( const String & name = String() )

explicit

Creates an ImageButton.

Use setImage() to specify the image to use. The colours and opacities that are specified here can be changed later using setImages().

Parameters

name	the name to give the component

◆ ~ImageButton()

juce::ImageButton::~ImageButton ( )

override

Destructor.

Member Function Documentation

◆ getCurrentImage()

Image juce::ImageButton::getCurrentImage ( ) const

private

◆ getDownImage()

Image juce::ImageButton::getDownImage ( ) const

Returns the image that's drawn when the button is held down.

If a valid 'down' image has been set, this will return it; otherwise it'll return the 'over' image or normal image, depending on what's available.

◆ getNormalImage()

Image juce::ImageButton::getNormalImage ( ) const

Returns the currently set 'normal' image.

◆ getOverImage()

Image juce::ImageButton::getOverImage ( ) const

Returns the image that's drawn when the mouse is over the button.

If a valid 'over' image has been set, this will return it; otherwise it'll just return the normal image.

◆ hitTest()

bool juce::ImageButton::hitTest	(	int	x,
		int	y )

overrideprotectedvirtual

Tests whether a given point is inside the component.

Overriding this method allows you to create components which only intercept mouse-clicks within a user-defined area.

This is called to find out whether a particular x, y coordinate is considered to be inside the component or not, and is used by methods such as contains() and getComponentAt() to work out which component the mouse is clicked on.

Components with custom shapes will probably want to override it to perform some more complex hit-testing.

The default implementation of this method returns either true or false, depending on the value that was set by calling setInterceptsMouseClicks() (true is the default return value).

Note that the hit-test region is not related to the opacity with which areas of a component are painted.

Applications should never call hitTest() directly - instead use the contains() method, because this will also test for occlusion by the component's parent.

Note that for components on the desktop, this method will be ignored, because it's not always possible to implement this behaviour on all platforms.

Parameters

x	the x coordinate to test, relative to the left hand edge of this component. This value is guaranteed to be greater than or equal to zero, and less than the component's width
y	the y coordinate to test, relative to the top edge of this component. This value is guaranteed to be greater than or equal to zero, and less than the component's height

Returns: true if the click is considered to be inside the component

See also: setInterceptsMouseClicks, contains

Reimplemented from juce::Component.

◆ paintButton()

void juce::ImageButton::paintButton	(	Graphics &	g,
		bool	shouldDrawButtonAsHighlighted,
		bool	shouldDrawButtonAsDown )

overrideprotectedvirtual

Subclasses should override this to actually paint the button's contents.

It's better to use this than the paint method, because it gives you information about the over/down state of the button.

Parameters

g	the graphics context to use
shouldDrawButtonAsHighlighted	true if the button is either in the 'over' or 'down' state
shouldDrawButtonAsDown	true if the button should be drawn in the 'down' position

Implements juce::Button.

◆ setImages()

void juce::ImageButton::setImages	(	bool	resizeButtonNowToFitThisImage,
		bool	rescaleImagesWhenButtonSizeChanges,
		bool	preserveImageProportions,
		const Image &	normalImage,
		float	imageOpacityWhenNormal,
		Colour	overlayColourWhenNormal,
		const Image &	overImage,
		float	imageOpacityWhenOver,
		Colour	overlayColourWhenOver,
		const Image &	downImage,
		float	imageOpacityWhenDown,
		Colour	overlayColourWhenDown,
		float	hitTestAlphaThreshold = 0.0f )

Sets up the images to draw in various states.

Parameters

resizeButtonNowToFitThisImage	if true, the button will be immediately resized to the same dimensions as the normal image
rescaleImagesWhenButtonSizeChanges	if true, the image will be rescaled to fit the button when the button's size changes
preserveImageProportions	if true then any rescaling of the image to fit the button will keep the image's x and y proportions correct - i.e. it won't distort its shape, although this might create gaps around the edges
normalImage	the image to use when the button is in its normal state. button no longer needs it.
imageOpacityWhenNormal	the opacity to use when drawing the normal image.
overlayColourWhenNormal	an overlay colour to use to fill the alpha channel of the normal image - if this colour is transparent, no overlay will be drawn. The overlay will be drawn over the top of the image, so you can basically add a solid or semi-transparent colour to the image to brighten or darken it
overImage	the image to use when the mouse is over the button. If you want to use the same image as was set in the normalImage parameter, this value can be a null image.
imageOpacityWhenOver	the opacity to use when drawing the image when the mouse is over the button
overlayColourWhenOver	an overlay colour to use to fill the alpha channel of the image when the mouse is over - if this colour is transparent, no overlay will be drawn
downImage	an image to use when the button is pressed down. If set to a null image, the 'over' image will be drawn instead (or the normal image if there isn't an 'over' image either).
imageOpacityWhenDown	the opacity to use when drawing the image when the button is pressed
overlayColourWhenDown	an overlay colour to use to fill the alpha channel of the image when the button is pressed down - if this colour is transparent, no overlay will be drawn
hitTestAlphaThreshold	if set to zero, the mouse is considered to be over the button whenever it's inside the button's bounding rectangle. If set to values higher than 0, the mouse will only be considered to be over the image when the value of the image's alpha channel at that position is greater than this level.

Member Data Documentation

◆ alphaThreshold

uint8 juce::ImageButton::alphaThreshold

private

◆ downImage

Image juce::ImageButton::downImage

private

◆ downOpacity

float juce::ImageButton::downOpacity

private

◆ downOverlay

Colour juce::ImageButton::downOverlay

private

◆ imageBounds

Rectangle<int> juce::ImageButton::imageBounds

private

◆ normalImage

Image juce::ImageButton::normalImage

private

◆ normalOpacity

float juce::ImageButton::normalOpacity

private

◆ normalOverlay

Colour juce::ImageButton::normalOverlay

private

◆ overImage

Image juce::ImageButton::overImage

private

◆ overOpacity

float juce::ImageButton::overOpacity

private

◆ overOverlay

Colour juce::ImageButton::overOverlay

private

◆ preserveProportions

bool juce::ImageButton::preserveProportions

private

◆ scaleImageToFit

bool juce::ImageButton::scaleImageToFit

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/buttons/juce_ImageButton.h
/home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_gui_basics/buttons/juce_ImageButton.cpp

Classes

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ImageButton()

◆ ~ImageButton()

Member Function Documentation

◆ getCurrentImage()

◆ getDownImage()

◆ getNormalImage()

◆ getOverImage()

◆ hitTest()

◆ paintButton()

◆ setImages()

Member Data Documentation

◆ alphaThreshold

◆ downImage

◆ downOpacity

◆ downOverlay

◆ imageBounds

◆ normalImage

◆ normalOpacity

◆ normalOverlay

◆ overImage

◆ overOpacity

◆ overOverlay

◆ preserveProportions

◆ scaleImageToFit