JUCE
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Classes | Public Types | Public Member Functions | Protected Member Functions | List of all members
Button Class Referenceabstract

A base class for buttons. More...

Inherits Component, and SettableTooltipClient.

Inherited by ArrowButton, DrawableButton, HyperlinkButton, ImageButton, ShapeButton, TabBarButton, TextButton, ToggleButton, and ToolbarItemComponent.

Classes

class  Listener
 Used to receive callbacks when a button is clicked. More...
 
struct  LookAndFeelMethods
 This abstract base class is implemented by LookAndFeel classes to provide button-drawing functionality. More...
 

Public Types

enum  ConnectedEdgeFlags { ConnectedOnLeft = 1, ConnectedOnRight = 2, ConnectedOnTop = 4, ConnectedOnBottom = 8 }
 A combination of these flags are used by setConnectedEdges(). More...
 
enum  ButtonState { buttonNormal, buttonOver, buttonDown }
 Used by setState(). More...
 
- Public Types inherited from Component
enum  FocusChangeType { focusChangedByMouseClick, focusChangedByTabKey, focusChangedDirectly }
 Enumeration used by the focusChanged() and focusLost() methods. More...
 

Public Member Functions

virtual ~Button ()
 Destructor.
 
void setButtonText (const String &newText)
 Changes the button's text.
 
const StringgetButtonText () const
 Returns the text displayed in the button.
 
bool isDown () const noexcept
 Returns true if the button is currently being held down.
 
bool isOver () const noexcept
 Returns true if the mouse is currently over the button.
 
void setToggleState (bool shouldBeOn, NotificationType notification)
 A button has an on/off state associated with it, and this changes that.
 
bool getToggleState () const noexcept
 Returns true if the button is 'on'.
 
ValuegetToggleStateValue () noexcept
 Returns the Value object that represents the botton's toggle state.
 
void setClickingTogglesState (bool shouldAutoToggleOnClick) noexcept
 This tells the button to automatically flip the toggle state when the button is clicked.
 
bool getClickingTogglesState () const noexcept
 Returns true if this button is set to be an automatic toggle-button.
 
void setRadioGroupId (int newGroupId, NotificationType notification=sendNotification)
 Enables the button to act as a member of a mutually-exclusive group of 'radio buttons'.
 
int getRadioGroupId () const noexcept
 Returns the ID of the group to which this button belongs.
 
void addListener (Listener *newListener)
 Registers a listener to receive events when this button's state changes.
 
void removeListener (Listener *listener)
 Removes a previously-registered button listener.
 
virtual void triggerClick ()
 Causes the button to act as if it's been clicked.
 
void setCommandToTrigger (ApplicationCommandManager *commandManagerToUse, CommandID commandID, bool generateTooltip)
 Sets a command ID for this button to automatically invoke when it's clicked.
 
CommandID getCommandID () const noexcept
 Returns the command ID that was set by setCommandToTrigger().
 
void addShortcut (const KeyPress &)
 Assigns a shortcut key to trigger the button.
 
void clearShortcuts ()
 Removes all key shortcuts that had been set for this button.
 
bool isRegisteredForShortcut (const KeyPress &) const
 Returns true if the given keypress is a shortcut for this button.
 
void setRepeatSpeed (int initialDelayInMillisecs, int repeatDelayInMillisecs, int minimumDelayInMillisecs=-1) noexcept
 Sets an auto-repeat speed for the button when it is held down.
 
void setTriggeredOnMouseDown (bool isTriggeredOnMouseDown) noexcept
 Sets whether the button click should happen when the mouse is pressed or released.
 
uint32 getMillisecondsSinceButtonDown () const noexcept
 Returns the number of milliseconds since the last time the button went into the 'down' state.
 
void setTooltip (const String &newTooltip) override
 Sets the tooltip for this button.
 
String getTooltip () override
 Returns the tooltip set by setTooltip(), or the description corresponding to the currently mapped command if one is enabled (see setCommandToTrigger).
 
void setConnectedEdges (int connectedEdgeFlags)
 Hints about which edges of the button might be connected to adjoining buttons.
 
int getConnectedEdgeFlags () const noexcept
 Returns the set of flags passed into setConnectedEdges().
 
bool isConnectedOnLeft () const noexcept
 Indicates whether the button adjoins another one on its left edge.
 
bool isConnectedOnRight () const noexcept
 Indicates whether the button adjoins another one on its right edge.
 
bool isConnectedOnTop () const noexcept
 Indicates whether the button adjoins another one on its top edge.
 
bool isConnectedOnBottom () const noexcept
 Indicates whether the button adjoins another one on its bottom edge.
 
void setState (ButtonState newState)
 Can be used to force the button into a particular state.
 
 JUCE_DEPRECATED (void setToggleState(bool, bool))
 
- Public Member Functions inherited from Component
 Component () noexcept
 Creates a component.
 
virtual ~Component ()
 Destructor.
 
 Component (const String &componentName) noexcept
 Creates a component, setting its name at the same time.
 
const StringgetName () const noexcept
 Returns the name of this component.
 
virtual void setName (const String &newName)
 Sets the name of this component.
 
const StringgetComponentID () const noexcept
 Returns the ID string that was set by setComponentID().
 
void setComponentID (const String &newID)
 Sets the component's ID string.
 
virtual void setVisible (bool shouldBeVisible)
 Makes the component visible or invisible.
 
bool isVisible () const noexcept
 Tests whether the component is visible or not.
 
bool isShowing () const
 Tests whether this component and all its parents are visible.
 
virtual void addToDesktop (int windowStyleFlags, void *nativeWindowToAttachTo=nullptr)
 Makes this component appear as a window on the desktop.
 
void removeFromDesktop ()
 If the component is currently showing on the desktop, this will hide it.
 
bool isOnDesktop () const noexcept
 Returns true if this component is currently showing on the desktop.
 
ComponentPeergetPeer () const
 Returns the heavyweight window that contains this component.
 
virtual void userTriedToCloseWindow ()
 For components on the desktop, this is called if the system wants to close the window.
 
virtual void minimisationStateChanged (bool isNowMinimised)
 Called for a desktop component which has just been minimised or un-minimised.
 
virtual float getDesktopScaleFactor () const
 Returns the default scale factor to use for this component when it is placed on the desktop.
 
void toFront (bool shouldAlsoGainFocus)
 Brings the component to the front of its siblings.
 
void toBack ()
 Changes this component's z-order to be at the back of all its siblings.
 
void toBehind (Component *other)
 Changes this component's z-order so that it's just behind another component.
 
void setAlwaysOnTop (bool shouldStayOnTop)
 Sets whether the component should always be kept at the front of its siblings.
 
bool isAlwaysOnTop () const noexcept
 Returns true if this component is set to always stay in front of its siblings.
 
int getX () const noexcept
 Returns the x coordinate of the component's left edge.
 
int getY () const noexcept
 Returns the y coordinate of the top of this component.
 
int getWidth () const noexcept
 Returns the component's width in pixels.
 
int getHeight () const noexcept
 Returns the component's height in pixels.
 
int getRight () const noexcept
 Returns the x coordinate of the component's right-hand edge.
 
Point< int > getPosition () const noexcept
 Returns the component's top-left position as a Point.
 
int getBottom () const noexcept
 Returns the y coordinate of the bottom edge of this component.
 
const Rectangle< int > & getBounds () const noexcept
 Returns this component's bounding box.
 
Rectangle< int > getLocalBounds () const noexcept
 Returns the component's bounds, relative to its own origin.
 
Rectangle< int > getBoundsInParent () const noexcept
 Returns the area of this component's parent which this component covers.
 
int getScreenX () const
 Returns this component's x coordinate relative the screen's top-left origin.
 
int getScreenY () const
 Returns this component's y coordinate relative the screen's top-left origin.
 
Point< int > getScreenPosition () const
 Returns the position of this component's top-left corner relative to the screen's top-left.
 
Rectangle< int > getScreenBounds () const
 Returns the bounds of this component, relative to the screen's top-left.
 
Point< int > getLocalPoint (const Component *sourceComponent, Point< int > pointRelativeToSourceComponent) const
 Converts a point to be relative to this component's coordinate space.
 
Point< float > getLocalPoint (const Component *sourceComponent, Point< float > pointRelativeToSourceComponent) const
 Converts a point to be relative to this component's coordinate space.
 
Rectangle< int > getLocalArea (const Component *sourceComponent, const Rectangle< int > &areaRelativeToSourceComponent) const
 Converts a rectangle to be relative to this component's coordinate space.
 
Point< int > localPointToGlobal (Point< int > localPoint) const
 Converts a point relative to this component's top-left into a screen coordinate.
 
Point< float > localPointToGlobal (Point< float > localPoint) const
 Converts a point relative to this component's top-left into a screen coordinate.
 
Rectangle< int > localAreaToGlobal (const Rectangle< int > &localArea) const
 Converts a rectangle from this component's coordinate space to a screen coordinate.
 
void setTopLeftPosition (int x, int y)
 Moves the component to a new position.
 
void setTopLeftPosition (Point< int > newTopLeftPosition)
 Moves the component to a new position.
 
void setTopRightPosition (int x, int y)
 Moves the component to a new position.
 
void setSize (int newWidth, int newHeight)
 Changes the size of the component.
 
void setBounds (int x, int y, int width, int height)
 Changes the component's position and size.
 
void setBounds (const Rectangle< int > &newBounds)
 Changes the component's position and size.
 
void setBounds (const RelativeRectangle &newBounds)
 Changes the component's position and size.
 
void setBounds (const String &newBoundsExpression)
 Sets the component's bounds with an expression.
 
void setBoundsRelative (float proportionalX, float proportionalY, float proportionalWidth, float proportionalHeight)
 Changes the component's position and size in terms of fractions of its parent's size.
 
void setBoundsInset (const BorderSize< int > &borders)
 Changes the component's position and size based on the amount of space to leave around it.
 
void setBoundsToFit (int x, int y, int width, int height, Justification justification, bool onlyReduceInSize)
 Positions the component within a given rectangle, keeping its proportions unchanged.
 
void setCentrePosition (int x, int y)
 Changes the position of the component's centre.
 
void setCentreRelative (float x, float y)
 Changes the position of the component's centre.
 
void centreWithSize (int width, int height)
 Changes the component's size and centres it within its parent.
 
void setTransform (const AffineTransform &transform)
 Sets a transform matrix to be applied to this component.
 
AffineTransform getTransform () const
 Returns the transform that is currently being applied to this component.
 
bool isTransformed () const noexcept
 Returns true if a non-identity transform is being applied to this component.
 
int proportionOfWidth (float proportion) const noexcept
 Returns a proportion of the component's width.
 
int proportionOfHeight (float proportion) const noexcept
 Returns a proportion of the component's height.
 
int getParentWidth () const noexcept
 Returns the width of the component's parent.
 
int getParentHeight () const noexcept
 Returns the height of the component's parent.
 
Rectangle< int > getParentMonitorArea () const
 Returns the screen coordinates of the monitor that contains this component.
 
int getNumChildComponents () const noexcept
 Returns the number of child components that this component contains.
 
ComponentgetChildComponent (int index) const noexcept
 Returns one of this component's child components, by it index.
 
int getIndexOfChildComponent (const Component *child) const noexcept
 Returns the index of this component in the list of child components.
 
ComponentfindChildWithID (StringRef componentID) const noexcept
 Looks for a child component with the specified ID.
 
void addChildComponent (Component *child, int zOrder=-1)
 Adds a child component to this one.
 
void addChildComponent (Component &child, int zOrder=-1)
 Adds a child component to this one.
 
void addAndMakeVisible (Component *child, int zOrder=-1)
 Adds a child component to this one, and also makes the child visible if it isn't already.
 
void addAndMakeVisible (Component &child, int zOrder=-1)
 Adds a child component to this one, and also makes the child visible if it isn't already.
 
void addChildAndSetID (Component *child, const String &componentID)
 Adds a child component to this one, makes it visible, and sets its component ID.
 
void removeChildComponent (Component *childToRemove)
 Removes one of this component's child-components.
 
ComponentremoveChildComponent (int childIndexToRemove)
 Removes one of this component's child-components by index.
 
void removeAllChildren ()
 Removes all this component's children.
 
void deleteAllChildren ()
 Removes all this component's children, and deletes them.
 
ComponentgetParentComponent () const noexcept
 Returns the component which this component is inside.
 
template<class TargetClass >
TargetClass * findParentComponentOfClass () const
 Searches the parent components for a component of a specified class.
 
ComponentgetTopLevelComponent () const noexcept
 Returns the highest-level component which contains this one or its parents.
 
bool isParentOf (const Component *possibleChild) const noexcept
 Checks whether a component is anywhere inside this component or its children.
 
virtual void childrenChanged ()
 Subclasses can use this callback to be told when children are added or removed, or when their z-order changes.
 
virtual bool hitTest (int x, int y)
 Tests whether a given point inside the component.
 
void setInterceptsMouseClicks (bool allowClicksOnThisComponent, bool allowClicksOnChildComponents) noexcept
 Changes the default return value for the hitTest() method.
 
void getInterceptsMouseClicks (bool &allowsClicksOnThisComponent, bool &allowsClicksOnChildComponents) const noexcept
 Retrieves the current state of the mouse-click interception flags.
 
bool contains (Point< int > localPoint)
 Returns true if a given point lies within this component or one of its children.
 
bool reallyContains (Point< int > localPoint, bool returnTrueIfWithinAChild)
 Returns true if a given point lies in this component, taking any overlapping siblings into account.
 
ComponentgetComponentAt (int x, int y)
 Returns the component at a certain point within this one.
 
ComponentgetComponentAt (Point< int > position)
 Returns the component at a certain point within this one.
 
void repaint ()
 Marks the whole component as needing to be redrawn.
 
void repaint (int x, int y, int width, int height)
 Marks a subsection of this component as needing to be redrawn.
 
void repaint (const Rectangle< int > &area)
 Marks a subsection of this component as needing to be redrawn.
 
void setBufferedToImage (bool shouldBeBuffered)
 Makes the component use an internal buffer to optimise its redrawing.
 
Image createComponentSnapshot (const Rectangle< int > &areaToGrab, bool clipImageToComponentBounds=true, float scaleFactor=1.0f)
 Generates a snapshot of part of this component.
 
void paintEntireComponent (Graphics &context, bool ignoreAlphaLevel)
 Draws this component and all its subcomponents onto the specified graphics context.
 
void setPaintingIsUnclipped (bool shouldPaintWithoutClipping) noexcept
 This allows you to indicate that this component doesn't require its graphics context to be clipped when it is being painted.
 
void setComponentEffect (ImageEffectFilter *newEffect)
 Adds an effect filter to alter the component's appearance.
 
ImageEffectFiltergetComponentEffect () const noexcept
 Returns the current component effect.
 
LookAndFeelgetLookAndFeel () const noexcept
 Finds the appropriate look-and-feel to use for this component.
 
void setLookAndFeel (LookAndFeel *newLookAndFeel)
 Sets the look and feel to use for this component.
 
virtual void lookAndFeelChanged ()
 Called to let the component react to a change in the look-and-feel setting.
 
void sendLookAndFeelChange ()
 Calls the lookAndFeelChanged() method in this component and all its children.
 
void setOpaque (bool shouldBeOpaque)
 Indicates whether any parts of the component might be transparent.
 
bool isOpaque () const noexcept
 Returns true if no parts of this component are transparent.
 
void setBroughtToFrontOnMouseClick (bool shouldBeBroughtToFront) noexcept
 Indicates whether the component should be brought to the front when clicked.
 
bool isBroughtToFrontOnMouseClick () const noexcept
 Indicates whether the component should be brought to the front when clicked-on.
 
void setWantsKeyboardFocus (bool wantsFocus) noexcept
 Sets a flag to indicate whether this component needs keyboard focus or not.
 
bool getWantsKeyboardFocus () const noexcept
 Returns true if the component is interested in getting keyboard focus.
 
void setMouseClickGrabsKeyboardFocus (bool shouldGrabFocus)
 Chooses whether a click on this component automatically grabs the focus.
 
bool getMouseClickGrabsKeyboardFocus () const noexcept
 Returns the last value set with setMouseClickGrabsKeyboardFocus().
 
void grabKeyboardFocus ()
 Tries to give keyboard focus to this component.
 
bool hasKeyboardFocus (bool trueIfChildIsFocused) const
 Returns true if this component currently has the keyboard focus.
 
void moveKeyboardFocusToSibling (bool moveToNext)
 Tries to move the keyboard focus to one of this component's siblings.
 
virtual KeyboardFocusTraversercreateFocusTraverser ()
 Creates a KeyboardFocusTraverser object to use to determine the logic by which focus should be passed from this component.
 
int getExplicitFocusOrder () const
 Returns the focus order of this component, if one has been specified.
 
void setExplicitFocusOrder (int newFocusOrderIndex)
 Sets the index used in determining the order in which focusable components should be traversed.
 
void setFocusContainer (bool shouldBeFocusContainer) noexcept
 Indicates whether this component is a parent for components that can have their focus traversed.
 
bool isFocusContainer () const noexcept
 Returns true if this component has been marked as a focus container.
 
bool isEnabled () const noexcept
 Returns true if the component (and all its parents) are enabled.
 
void setEnabled (bool shouldBeEnabled)
 Enables or disables this component.
 
void setAlpha (float newAlpha)
 Changes the transparency of this component.
 
float getAlpha () const
 Returns the component's current transparancy level.
 
void setMouseCursor (const MouseCursor &cursorType)
 Changes the mouse cursor shape to use when the mouse is over this component.
 
virtual MouseCursor getMouseCursor ()
 Returns the mouse cursor shape to use when the mouse is over this component.
 
void updateMouseCursor () const
 Forces the current mouse cursor to be updated.
 
virtual void paintOverChildren (Graphics &g)
 Components can override this method to draw over the top of their children.
 
virtual void mouseMove (const MouseEvent &event) override
 Called when the mouse moves inside a component.
 
virtual void mouseDoubleClick (const MouseEvent &event) override
 Called when a mouse button has been double-clicked on a component.
 
virtual void mouseWheelMove (const MouseEvent &event, const MouseWheelDetails &wheel) override
 Called when the mouse-wheel is moved.
 
virtual void mouseMagnify (const MouseEvent &event, float scaleFactor)
 Called when a pinch-to-zoom mouse-gesture is used.
 
void setRepaintsOnMouseActivity (bool shouldRepaint) noexcept
 Causes automatic repaints when the mouse enters or exits this component.
 
void addMouseListener (MouseListener *newListener, bool wantsEventsForAllNestedChildComponents)
 Registers a listener to be told when mouse events occur in this component.
 
void removeMouseListener (MouseListener *listenerToRemove)
 Deregisters a mouse listener.
 
void addKeyListener (KeyListener *newListener)
 Adds a listener that wants to hear about keypresses that this component receives.
 
void removeKeyListener (KeyListener *listenerToRemove)
 Removes a previously-registered key listener.
 
virtual bool keyStateChanged (bool isKeyDown)
 Called when a key is pressed or released.
 
virtual void modifierKeysChanged (const ModifierKeys &modifiers)
 Called when a modifier key is pressed or released.
 
virtual void focusOfChildComponentChanged (FocusChangeType cause)
 Called to indicate a change in whether or not this component is the parent of the currently-focused component.
 
bool isMouseOver (bool includeChildren=false) const
 Returns true if the mouse is currently over this component.
 
bool isMouseButtonDown () const
 Returns true if the mouse button is currently held down in this component.
 
bool isMouseOverOrDragging () const
 True if the mouse is over this component, or if it's being dragged in this component.
 
Point< int > getMouseXYRelative () const
 Returns the mouse's current position, relative to this component.
 
virtual void resized ()
 Called when this component's size has been changed.
 
virtual void moved ()
 Called when this component's position has been changed.
 
virtual void childBoundsChanged (Component *child)
 Called when one of this component's children is moved or resized.
 
virtual void parentSizeChanged ()
 Called when this component's immediate parent has been resized.
 
virtual void broughtToFront ()
 Called when this component has been moved to the front of its siblings.
 
void addComponentListener (ComponentListener *newListener)
 Adds a listener to be told about changes to the component hierarchy or position.
 
void removeComponentListener (ComponentListener *listenerToRemove)
 Removes a component listener.
 
void postCommandMessage (int commandId)
 Dispatches a numbered message to this component.
 
void enterModalState (bool takeKeyboardFocus=true, ModalComponentManager::Callback *callback=nullptr, bool deleteWhenDismissed=false)
 Runs a component modally, waiting until the loop terminates.
 
void exitModalState (int returnValue)
 Ends a component's modal state.
 
bool isCurrentlyModal () const noexcept
 Returns true if this component is the modal one.
 
bool isCurrentlyBlockedByAnotherModalComponent () const
 Checks whether there's a modal component somewhere that's stopping this one from receiving messages.
 
virtual bool canModalEventBeSentToComponent (const Component *targetComponent)
 When a component is modal, this callback allows it to choose which other components can still receive events.
 
virtual void inputAttemptWhenModal ()
 Called when the user tries to click on a component that is blocked by another modal component.
 
NamedValueSetgetProperties () noexcept
 Returns the set of properties that belong to this component.
 
const NamedValueSetgetProperties () const noexcept
 Returns the set of properties that belong to this component.
 
Colour findColour (int colourId, bool inheritFromParent=false) const
 Looks for a colour that has been registered with the given colour ID number.
 
void setColour (int colourId, Colour newColour)
 Registers a colour to be used for a particular purpose.
 
void removeColour (int colourId)
 If a colour has been set with setColour(), this will remove it.
 
bool isColourSpecified (int colourId) const
 Returns true if the specified colour ID has been explicitly set for this component using the setColour() method.
 
void copyAllExplicitColoursTo (Component &target) const
 This looks for any colours that have been specified for this component, and copies them to the specified target component.
 
virtual void colourChanged ()
 This method is called when a colour is changed by the setColour() method.
 
virtual MarkerListgetMarkers (bool xAxis)
 Components can implement this method to provide a MarkerList.
 
void * getWindowHandle () const
 Returns the underlying native window handle for this component.
 
PositionergetPositioner () const noexcept
 Returns the Positioner object that has been set for this component.
 
void setPositioner (Positioner *newPositioner)
 Sets a new Positioner object for this component.
 
void setCachedComponentImage (CachedComponentImage *newCachedImage)
 Gives the component a CachedComponentImage that should be used to buffer its painting.
 
CachedComponentImagegetCachedComponentImage () const noexcept
 Returns the object that was set by setCachedComponentImage().
 
 JUCE_DEPRECATED (Point< int > relativePositionToGlobal(Point< int >) const)
 
 JUCE_DEPRECATED (Point< int > globalPositionToRelative(Point< int >) const)
 
 JUCE_DEPRECATED (Point< int > relativePositionToOtherComponent(const Component *, Point< int >) const)
 
- Public Member Functions inherited from MouseListener
virtual ~MouseListener ()
 Destructor.
 
- Public Member Functions inherited from SettableTooltipClient
virtual ~SettableTooltipClient ()
 Destructor.
 
- Public Member Functions inherited from TooltipClient
virtual ~TooltipClient ()
 Destructor.
 

Protected Member Functions

 Button (const String &buttonName)
 Creates a button.
 
virtual void clicked ()
 This method is called when the button has been clicked.
 
virtual void clicked (const ModifierKeys &modifiers)
 This method is called when the button has been clicked.
 
virtual void paintButton (Graphics &g, bool isMouseOverButton, bool isButtonDown)=0
 Subclasses should override this to actually paint the button's contents.
 
virtual void buttonStateChanged ()
 Called when the button's up/down/over state changes.
 
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
 
- Protected Member Functions inherited from SettableTooltipClient
 SettableTooltipClient ()
 

Additional Inherited Members

- Static Public Member Functions inherited from Component
static Component *JUCE_CALLTYPE getCurrentlyFocusedComponent () noexcept
 Returns the component that currently has the keyboard focus.
 
static void JUCE_CALLTYPE unfocusAllComponents ()
 If any component has keyboard focus, this will defocus it.
 
static void JUCE_CALLTYPE beginDragAutoRepeat (int millisecondsBetweenCallbacks)
 Ensures that a non-stop stream of mouse-drag events will be sent during the current mouse-drag operation.
 
static bool JUCE_CALLTYPE isMouseButtonDownAnywhere () noexcept
 Returns true if a mouse button is currently down.
 
static int JUCE_CALLTYPE getNumCurrentlyModalComponents () noexcept
 Returns the number of components that are currently in a modal state.
 
static Component *JUCE_CALLTYPE getCurrentlyModalComponent (int index=0) noexcept
 Returns one of the components that are currently modal.
 

Detailed Description

A base class for buttons.

This contains all the logic for button behaviours such as enabling/disabling, responding to shortcut keystrokes, auto-repeating when held down, toggle-buttons and radio groups, etc.

See Also
TextButton, DrawableButton, ToggleButton

Member Enumeration Documentation

A combination of these flags are used by setConnectedEdges().

Enumerator:
ConnectedOnLeft 
ConnectedOnRight 
ConnectedOnTop 
ConnectedOnBottom 

Used by setState().

Enumerator:
buttonNormal 
buttonOver 
buttonDown 

Constructor & Destructor Documentation

Button::Button ( const String buttonName)
explicitprotected

Creates a button.

Parameters
buttonNamethe text to put in the button (the component's name is also initially set to this string, but these can be changed later using the setName() and setButtonText() methods)
virtual Button::~Button ( )
virtual

Destructor.

Member Function Documentation

void Button::setButtonText ( const String newText)

Changes the button's text.

See Also
getButtonText
const String& Button::getButtonText ( ) const

Returns the text displayed in the button.

See Also
setButtonText
bool Button::isDown ( ) const
noexcept

Returns true if the button is currently being held down.

See Also
isOver
bool Button::isOver ( ) const
noexcept

Returns true if the mouse is currently over the button.

This will be also be true if the button is being held down.

See Also
isDown
void Button::setToggleState ( bool  shouldBeOn,
NotificationType  notification 
)

A button has an on/off state associated with it, and this changes that.

By default buttons are 'off' and for simple buttons that you click to perform an action you won't change this. Toggle buttons, however will want to change their state when turned on or off.

Parameters
shouldBeOnwhether to set the button's toggle state to be on or off. If it's a member of a button group, this will always try to turn it on, and to turn off any other buttons in the group
notificationdetermines the behaviour if the value changes - this can invoke a synchronous call to clicked(), but sendNotificationAsync is not supported
See Also
getToggleState, setRadioGroupId
bool Button::getToggleState ( ) const
noexcept

Returns true if the button is 'on'.

By default buttons are 'off' and for simple buttons that you click to perform an action you won't change this. Toggle buttons, however will want to change their state when turned on or off.

See Also
setToggleState
Value& Button::getToggleStateValue ( )
noexcept

Returns the Value object that represents the botton's toggle state.

You can use this Value object to connect the button's state to external values or setters, either by taking a copy of the Value, or by using Value::referTo() to make it point to your own Value object.

See Also
getToggleState, Value
void Button::setClickingTogglesState ( bool  shouldAutoToggleOnClick)
noexcept

This tells the button to automatically flip the toggle state when the button is clicked.

If set to true, then before the clicked() callback occurs, the toggle-state of the button is flipped.

bool Button::getClickingTogglesState ( ) const
noexcept

Returns true if this button is set to be an automatic toggle-button.

This returns the last value that was passed to setClickingTogglesState().

void Button::setRadioGroupId ( int  newGroupId,
NotificationType  notification = sendNotification 
)

Enables the button to act as a member of a mutually-exclusive group of 'radio buttons'.

If the group ID is set to a non-zero number, then this button will act as part of a group of buttons with the same ID, only one of which can be 'on' at the same time. Note that when it's part of a group, clicking a toggle-button that's 'on' won't turn it off.

To find other buttons with the same ID, this button will search through its sibling components for ToggleButtons, so all the buttons for a particular group must be placed inside the same parent component.

Set the group ID back to zero if you want it to act as a normal toggle button again.

The notification argument lets you specify how other buttons should react to being turned on or off in response to this call.

See Also
getRadioGroupId
int Button::getRadioGroupId ( ) const
noexcept

Returns the ID of the group to which this button belongs.

(See setRadioGroupId() for an explanation of this).

void Button::addListener ( Listener newListener)

Registers a listener to receive events when this button's state changes.

If the listener is already registered, this will not register it again.

See Also
removeListener

Referenced by StandaloneFilterWindow::StandaloneFilterWindow().

void Button::removeListener ( Listener listener)

Removes a previously-registered button listener.

See Also
addListener
virtual void Button::triggerClick ( )
virtual

Causes the button to act as if it's been clicked.

This will asynchronously make the button draw itself going down and up, and will then call back the clicked() method as if mouse was clicked on it.

See Also
clicked
void Button::setCommandToTrigger ( ApplicationCommandManager commandManagerToUse,
CommandID  commandID,
bool  generateTooltip 
)

Sets a command ID for this button to automatically invoke when it's clicked.

When the button is pressed, it will use the given manager to trigger the command ID.

Obviously be careful that the ApplicationCommandManager doesn't get deleted before this button is. To disable the command triggering, call this method and pass nullptr as the command manager.

If generateTooltip is true, then the button's tooltip will be automatically generated based on the name of this command and its current shortcut key.

See Also
addShortcut, getCommandID
CommandID Button::getCommandID ( ) const
noexcept

Returns the command ID that was set by setCommandToTrigger().

void Button::addShortcut ( const KeyPress )

Assigns a shortcut key to trigger the button.

The button registers itself with its top-level parent component for keypresses.

Note that a different way of linking buttons to keypresses is by using the setCommandToTrigger() method to invoke a command.

See Also
clearShortcuts
void Button::clearShortcuts ( )

Removes all key shortcuts that had been set for this button.

See Also
addShortcut
bool Button::isRegisteredForShortcut ( const KeyPress ) const

Returns true if the given keypress is a shortcut for this button.

See Also
addShortcut
void Button::setRepeatSpeed ( int  initialDelayInMillisecs,
int  repeatDelayInMillisecs,
int  minimumDelayInMillisecs = -1 
)
noexcept

Sets an auto-repeat speed for the button when it is held down.

(Auto-repeat is disabled by default).

Parameters
initialDelayInMillisecshow long to wait after the mouse is pressed before triggering the next click. If this is zero, auto-repeat is disabled
repeatDelayInMillisecsthe frequently subsequent repeated clicks should be triggered
minimumDelayInMillisecsif this is greater than 0, the auto-repeat speed will get faster, the longer the button is held down, up to the minimum interval specified here
void Button::setTriggeredOnMouseDown ( bool  isTriggeredOnMouseDown)
noexcept

Sets whether the button click should happen when the mouse is pressed or released.

By default the button is only considered to have been clicked when the mouse is released, but setting this to true will make it call the clicked() method as soon as the button is pressed.

This is useful if the button is being used to show a pop-up menu, as it allows the click to be used as a drag onto the menu.

Referenced by StandaloneFilterWindow::StandaloneFilterWindow().

uint32 Button::getMillisecondsSinceButtonDown ( ) const
noexcept

Returns the number of milliseconds since the last time the button went into the 'down' state.

void Button::setTooltip ( const String newTooltip)
overridevirtual

Sets the tooltip for this button.

See Also
TooltipClient, TooltipWindow

Reimplemented from SettableTooltipClient.

String Button::getTooltip ( )
overridevirtual

Returns the tooltip set by setTooltip(), or the description corresponding to the currently mapped command if one is enabled (see setCommandToTrigger).

Reimplemented from SettableTooltipClient.

void Button::setConnectedEdges ( int  connectedEdgeFlags)

Hints about which edges of the button might be connected to adjoining buttons.

The value passed in is a bitwise combination of any of the values in the ConnectedEdgeFlags enum.

E.g. if you are placing two buttons adjacent to each other, you could use this to indicate which edges are touching, and the LookAndFeel might choose to drawn them without rounded corners on the edges that connect. It's only a hint, so the LookAndFeel can choose to ignore it if it's not relevent for this type of button.

int Button::getConnectedEdgeFlags ( ) const
noexcept

Returns the set of flags passed into setConnectedEdges().

bool Button::isConnectedOnLeft ( ) const
noexcept

Indicates whether the button adjoins another one on its left edge.

See Also
setConnectedEdges
bool Button::isConnectedOnRight ( ) const
noexcept

Indicates whether the button adjoins another one on its right edge.

See Also
setConnectedEdges
bool Button::isConnectedOnTop ( ) const
noexcept

Indicates whether the button adjoins another one on its top edge.

See Also
setConnectedEdges
bool Button::isConnectedOnBottom ( ) const
noexcept

Indicates whether the button adjoins another one on its bottom edge.

See Also
setConnectedEdges
void Button::setState ( ButtonState  newState)

Can be used to force the button into a particular state.

This only changes the button's appearance, it won't trigger a click, or stop any mouse-clicks from happening.

The state that you set here will only last until it is automatically changed when the mouse enters or exits the button, or the mouse-button is pressed or released.

Button::JUCE_DEPRECATED ( void   setToggleStatebool, bool)
virtual void Button::clicked ( )
protectedvirtual

This method is called when the button has been clicked.

Subclasses can override this to perform whatever they actions they need to do.

Alternatively, a ButtonListener can be added to the button, and these listeners will be called when the click occurs.

See Also
triggerClick

Reimplemented in HyperlinkButton.

virtual void Button::clicked ( const ModifierKeys modifiers)
protectedvirtual

This method is called when the button has been clicked.

By default it just calls clicked(), but you might want to override it to handle things like clicking when a modifier key is pressed, etc.

See Also
ModifierKeys

Reimplemented in TabBarButton.

virtual void Button::paintButton ( Graphics g,
bool  isMouseOverButton,
bool  isButtonDown 
)
protectedpure virtual

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
gthe graphics context to use
isMouseOverButtontrue if the button is either in the 'over' or 'down' state
isButtonDowntrue if the button should be drawn in the 'down' position

Implemented in ToolbarItemComponent, DrawableButton, ImageButton, TabBarButton, HyperlinkButton, TextButton, ShapeButton, ToggleButton, and ArrowButton.

virtual void Button::buttonStateChanged ( )
protectedvirtual

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 in DrawableButton, and ToolbarButton.

virtual void Button::internalClickCallback ( const ModifierKeys )
protectedvirtual
void Button::handleCommandMessage ( int  commandId)
overrideprotectedvirtual

Reimplemented from Component.

void Button::mouseEnter ( const MouseEvent )
overrideprotectedvirtual

Reimplemented from Component.

void Button::mouseExit ( const MouseEvent )
overrideprotectedvirtual

Reimplemented from Component.

void Button::mouseDown ( const MouseEvent )
overrideprotectedvirtual

Reimplemented from Component.

void Button::mouseDrag ( const MouseEvent )
overrideprotectedvirtual

Reimplemented from Component.

void Button::mouseUp ( const MouseEvent )
overrideprotectedvirtual

Reimplemented from Component.

bool Button::keyPressed ( const KeyPress )
overrideprotectedvirtual

Reimplemented from Component.

void Button::paint ( Graphics )
overrideprotectedvirtual

Reimplemented from Component.

void Button::parentHierarchyChanged ( )
overrideprotectedvirtual

Reimplemented from Component.

void Button::visibilityChanged ( )
overrideprotectedvirtual

Reimplemented from Component.

void Button::focusGained ( FocusChangeType  )
overrideprotectedvirtual

Reimplemented from Component.

void Button::focusLost ( FocusChangeType  )
overrideprotectedvirtual

Reimplemented from Component.

void Button::enablementChanged ( )
overrideprotectedvirtual

Reimplemented from Component.

Reimplemented in DrawableButton, and ToolbarButton.


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