#include <juce_ToolbarButton.h>

Inheritance diagram for juce::ToolbarButton:

Public Member Functions
	ToolbarButton (int itemId, const String &labelText, std::unique_ptr< Drawable > normalImage, std::unique_ptr< Drawable > toggledOnImage)
	~ToolbarButton () override
bool	getToolbarItemSizes (int toolbarDepth, bool isToolbarVertical, int &preferredSize, int &minSize, int &maxSize) override
void	paintButtonArea (Graphics &, int width, int height, bool isMouseOver, bool isMouseDown) override
void	contentAreaChanged (const Rectangle< int > &) override
void	buttonStateChanged () override
void	resized () override
void	enablementChanged () override
Public Member Functions inherited from juce::ToolbarItemComponent
	ToolbarItemComponent (int itemId, const String &labelText, bool isBeingUsedAsAButton)
	~ToolbarItemComponent () override
int	getItemId () const noexcept
Toolbar *	getToolbar () const
bool	isToolbarVertical () const
Toolbar::ToolbarItemStyle	getStyle () const noexcept
virtual void	setStyle (const Toolbar::ToolbarItemStyle &newStyle)
Rectangle< int >	getContentArea () const noexcept
void	setEditingMode (const ToolbarEditingMode newMode)
ToolbarEditingMode	getEditingMode () const noexcept
void	paintButton (Graphics &, bool isMouseOver, bool isMouseDown) override
void	resized () override
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 ()
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)
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	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

Private Member Functions
void	updateDrawable ()
Drawable *	getImageToUse () const
void	setCurrentImage (Drawable *)

Private Attributes
std::unique_ptr< Drawable >	normalImage
std::unique_ptr< Drawable >	toggledOnImage
Drawable *	currentImage = nullptr

Additional Inherited Members
Public Types inherited from juce::ToolbarItemComponent
enum	ToolbarEditingMode { normalMode = 0 , editableOnToolbar , editableOnPalette }
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
Protected Member Functions inherited from juce::Button
	Button (const String &buttonName)
virtual void	clicked ()
virtual void	clicked (const ModifierKeys &modifiers)
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
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
Static Protected Member Functions inherited from juce::Component
static std::unique_ptr< AccessibilityHandler >	createIgnoredAccessibilityHandler (Component &)

Detailed Description

A type of button designed to go on a toolbar.

This simple button can have two Drawable objects specified - one for normal use and another one (optionally) for the button's "on" state if it's a toggle button.

See also: Toolbar, ToolbarItemFactory, ToolbarItemComponent, Drawable, Button

@tags{GUI}

Constructor & Destructor Documentation

◆ ToolbarButton()

juce::ToolbarButton::ToolbarButton	(	int	itemId,
		const String &	labelText,
		std::unique_ptr< Drawable >	normalImage,
		std::unique_ptr< Drawable >	toggledOnImage )

Creates a ToolbarButton.

Parameters

itemId	the ID for this toolbar item type. This is passed through to the ToolbarItemComponent constructor
labelText	the text to display on the button (if the toolbar is using a style that shows text labels). This is passed through to the ToolbarItemComponent constructor
normalImage	a drawable object that the button should use as its icon. The object that is passed-in here will be kept by this object and will be deleted when no longer needed or when this button is deleted.
toggledOnImage	a drawable object that the button can use as its icon if the button is in a toggled-on state (see the Button::getToggleState() method). If nullptr is passed-in here, then the normal image will be used instead, regardless of the toggle state. The object that is passed-in here will be owned by this object and will be deleted when no longer needed or when this button is deleted.

◆ ~ToolbarButton()

juce::ToolbarButton::~ToolbarButton ( )

override

Destructor.

Member Function Documentation

◆ buttonStateChanged()

void juce::ToolbarButton::buttonStateChanged ( )

overridevirtual

Called when the button's up/down/over state changes.

Subclasses can override this if they need to do something special when the button goes up or down.

See also: isDown, isOver

Reimplemented from juce::Button.

◆ contentAreaChanged()

void juce::ToolbarButton::contentAreaChanged ( const Rectangle< int > & newBounds )

overridevirtual

Callback to indicate that the content area of this item has changed.

This might be because the component was resized, or because the style changed and the space needed for the text label is different.

See getContentArea() for a description of what the area is.

Implements juce::ToolbarItemComponent.

◆ enablementChanged()

void juce::ToolbarButton::enablementChanged ( )

overridevirtual

Callback to indicate that this component has been enabled or disabled.

This can be triggered by one of the component's parent components being enabled or disabled, as well as changes to the component itself.

The default implementation of this method does nothing; your class may wish to repaint itself or something when this happens.

See also: setEnabled, isEnabled

Reimplemented from juce::Button.

◆ getImageToUse()

Drawable * juce::ToolbarButton::getImageToUse ( ) const

private

◆ getToolbarItemSizes()

bool juce::ToolbarButton::getToolbarItemSizes	(	int	toolbarThickness,
		bool	isToolbarVertical,
		int &	preferredSize,
		int &	minSize,
		int &	maxSize )

overridevirtual

This method must return the size criteria for this item, based on a given toolbar size and orientation.

The preferredSize, minSize and maxSize values must all be set by your implementation method. If the toolbar is horizontal, these will be the width of the item; for a vertical toolbar, they refer to the item's height.

The preferredSize is the size that the component would like to be, and this must be between the min and max sizes. For a fixed-size item, simply set all three variables to the same value.

The toolbarThickness parameter tells you the depth of the toolbar - the same as calling Toolbar::getThickness().

The isToolbarVertical parameter tells you whether the bar is oriented horizontally or vertically.

Implements juce::ToolbarItemComponent.

◆ paintButtonArea()

void juce::ToolbarButton::paintButtonArea	(	Graphics &	g,
		int	width,
		int	height,
		bool	isMouseOver,
		bool	isMouseDown )

overridevirtual

Your subclass should use this method to draw its content area.

The graphics object that is passed-in will have been clipped and had its origin moved to fit the content area as specified get getContentArea(). The width and height parameters are the width and height of the content area.

If the component you're writing isn't a button, you can just do nothing in this method.

Implements juce::ToolbarItemComponent.

◆ resized()

void juce::ToolbarButton::resized ( )

overridevirtual

Called when this component's size has been changed.

A component can implement this method to do things such as laying out its child components when its width or height changes.

The method is called synchronously as a result of the setBounds or setSize methods, so repeatedly changing a components size will repeatedly call its resized method (unlike things like repainting, where multiple calls to repaint are coalesced together).

If the component is a top-level window on the desktop, its size could also be changed by operating-system factors beyond the application's control.

See also: moved, setSize

Reimplemented from juce::Component.

◆ setCurrentImage()

void juce::ToolbarButton::setCurrentImage ( Drawable * newImage )

private

◆ updateDrawable()

void juce::ToolbarButton::updateDrawable ( )

private

Member Data Documentation

◆ currentImage

Drawable* juce::ToolbarButton::currentImage = nullptr

private

◆ normalImage

std::unique_ptr<Drawable> juce::ToolbarButton::normalImage

private

◆ toggledOnImage

std::unique_ptr<Drawable> juce::ToolbarButton::toggledOnImage

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ToolbarButton()

◆ ~ToolbarButton()

Member Function Documentation

◆ buttonStateChanged()

◆ contentAreaChanged()

◆ enablementChanged()

◆ getImageToUse()

◆ getToolbarItemSizes()

◆ paintButtonArea()

◆ resized()

◆ setCurrentImage()

◆ updateDrawable()

Member Data Documentation

◆ currentImage

◆ normalImage

◆ toggledOnImage