openshot-audio  0.1.6
Public Types | Public Member Functions | List of all members
DrawableButton Class Reference

#include <juce_DrawableButton.h>

Inheritance diagram for DrawableButton:
Button Component SettableTooltipClient MouseListener TooltipClient

Public Types

enum  ButtonStyle {
  ImageFitted, ImageRaw, ImageAboveTextLabel, ImageOnButtonBackground,
  ImageStretched
}
 
enum  ColourIds { textColourId = 0x1004010, textColourOnId = 0x1004013, backgroundColourId = 0x1004011, backgroundOnColourId = 0x1004012 }
 
- Public Types inherited from Button
enum  ConnectedEdgeFlags { ConnectedOnLeft = 1, ConnectedOnRight = 2, ConnectedOnTop = 4, ConnectedOnBottom = 8 }
 
enum  ButtonState { buttonNormal, buttonOver, buttonDown }
 
- Public Types inherited from Component
enum  FocusChangeType { focusChangedByMouseClick, focusChangedByTabKey, focusChangedDirectly }
 

Public Member Functions

 DrawableButton (const String &buttonName, ButtonStyle buttonStyle)
 
 ~DrawableButton ()
 
void setImages (const Drawable *normalImage, const Drawable *overImage=nullptr, const Drawable *downImage=nullptr, const Drawable *disabledImage=nullptr, const Drawable *normalImageOn=nullptr, const Drawable *overImageOn=nullptr, const Drawable *downImageOn=nullptr, const Drawable *disabledImageOn=nullptr)
 
void setButtonStyle (ButtonStyle newStyle)
 
ButtonStyle getStyle () const noexcept
 
void setEdgeIndent (int numPixelsIndent)
 
DrawablegetCurrentImage () const noexcept
 
DrawablegetNormalImage () const noexcept
 
DrawablegetOverImage () const noexcept
 
DrawablegetDownImage () const noexcept
 
virtual Rectangle< float > getImageBounds () const
 
void paintButton (Graphics &, bool isMouseOverButton, bool isButtonDown) override
 
void buttonStateChanged () override
 
void resized () override
 
void enablementChanged () override
 
void colourChanged () override
 
- Public Member Functions inherited from Button
virtual ~Button ()
 
void setButtonText (const String &newText)
 
const StringgetButtonText () const
 
bool isDown () const noexcept
 
bool isOver () const noexcept
 
void setToggleState (bool shouldBeOn, NotificationType notification)
 
bool getToggleState () const noexcept
 
ValuegetToggleStateValue () 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
 
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
 
 JUCE_DEPRECATED (void setToggleState(bool, bool))
 
- Public Member Functions inherited from Component
 Component () noexcept
 
virtual ~Component ()
 
 Component (const String &componentName) noexcept
 
const StringgetName () const noexcept
 
virtual void setName (const String &newName)
 
const StringgetComponentID () 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
 
ComponentPeergetPeer () const
 
virtual void userTriedToCloseWindow ()
 
virtual void minimisationStateChanged (bool isNowMinimised)
 
virtual float getDesktopScaleFactor () const
 
void toFront (bool shouldAlsoGainFocus)
 
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
 
const 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, const Rectangle< int > &areaRelativeToSourceComponent) const
 
Point< int > localPointToGlobal (Point< int > localPoint) const
 
Point< float > localPointToGlobal (Point< float > localPoint) const
 
Rectangle< int > localAreaToGlobal (const Rectangle< int > &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 (const Rectangle< int > &newBounds)
 
void setBounds (const RelativeRectangle &newBounds)
 
void setBounds (const String &newBoundsExpression)
 
void setBoundsRelative (float proportionalX, float proportionalY, float proportionalWidth, float proportionalHeight)
 
void setBoundsInset (const BorderSize< int > &borders)
 
void setBoundsToFit (int x, int y, int width, int height, Justification justification, bool onlyReduceInSize)
 
void setCentrePosition (int x, int y)
 
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
 
ComponentgetChildComponent (int index) const noexcept
 
int getIndexOfChildComponent (const Component *child) const noexcept
 
ComponentfindChildWithID (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)
 
ComponentremoveChildComponent (int childIndexToRemove)
 
void removeAllChildren ()
 
void deleteAllChildren ()
 
ComponentgetParentComponent () const noexcept
 
template<class TargetClass >
TargetClass * findParentComponentOfClass () const
 
ComponentgetTopLevelComponent () 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 reallyContains (Point< int > localPoint, bool returnTrueIfWithinAChild)
 
ComponentgetComponentAt (int x, int y)
 
ComponentgetComponentAt (Point< int > position)
 
void repaint ()
 
void repaint (int x, int y, int width, int height)
 
void repaint (const Rectangle< int > &area)
 
void setBufferedToImage (bool shouldBeBuffered)
 
Image createComponentSnapshot (const Rectangle< int > &areaToGrab, bool clipImageToComponentBounds=true, float scaleFactor=1.0f)
 
void paintEntireComponent (Graphics &context, bool ignoreAlphaLevel)
 
void setPaintingIsUnclipped (bool shouldPaintWithoutClipping) noexcept
 
void setComponentEffect (ImageEffectFilter *newEffect)
 
ImageEffectFiltergetComponentEffect () const noexcept
 
LookAndFeelgetLookAndFeel () 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 setWantsKeyboardFocus (bool wantsFocus) noexcept
 
bool getWantsKeyboardFocus () const noexcept
 
void setMouseClickGrabsKeyboardFocus (bool shouldGrabFocus)
 
bool getMouseClickGrabsKeyboardFocus () const noexcept
 
void grabKeyboardFocus ()
 
bool hasKeyboardFocus (bool trueIfChildIsFocused) const
 
void moveKeyboardFocusToSibling (bool moveToNext)
 
virtual KeyboardFocusTraversercreateFocusTraverser ()
 
int getExplicitFocusOrder () const
 
void setExplicitFocusOrder (int newFocusOrderIndex)
 
void setFocusContainer (bool shouldBeFocusContainer) noexcept
 
bool isFocusContainer () const noexcept
 
bool isEnabled () const noexcept
 
void setEnabled (bool shouldBeEnabled)
 
void setAlpha (float newAlpha)
 
float getAlpha () const
 
void setMouseCursor (const MouseCursor &cursorType)
 
virtual MouseCursor getMouseCursor ()
 
void updateMouseCursor () const
 
virtual void paintOverChildren (Graphics &g)
 
virtual void mouseMove (const MouseEvent &event) override
 
virtual void mouseDoubleClick (const MouseEvent &event) override
 
virtual void mouseWheelMove (const MouseEvent &event, const MouseWheelDetails &wheel) override
 
virtual void mouseMagnify (const MouseEvent &event, float scaleFactor)
 
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 keyStateChanged (bool isKeyDown)
 
virtual void modifierKeysChanged (const ModifierKeys &modifiers)
 
virtual void focusOfChildComponentChanged (FocusChangeType cause)
 
bool isMouseOver (bool includeChildren=false) const
 
bool isMouseButtonDown () const
 
bool isMouseOverOrDragging () 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 () const noexcept
 
bool isCurrentlyBlockedByAnotherModalComponent () const
 
virtual bool canModalEventBeSentToComponent (const Component *targetComponent)
 
virtual void inputAttemptWhenModal ()
 
NamedValueSetgetProperties () noexcept
 
const NamedValueSetgetProperties () 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 MarkerListgetMarkers (bool xAxis)
 
void * getWindowHandle () const
 
PositionergetPositioner () const noexcept
 
void setPositioner (Positioner *newPositioner)
 
void setCachedComponentImage (CachedComponentImage *newCachedImage)
 
CachedComponentImagegetCachedComponentImage () const noexcept
 
 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 ()
 
- Public Member Functions inherited from SettableTooltipClient
virtual ~SettableTooltipClient ()
 
virtual String getTooltip ()
 
- Public Member Functions inherited from TooltipClient
virtual ~TooltipClient ()
 

Additional Inherited Members

- Static Public Member Functions inherited from Component
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 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
 
- Protected Member Functions inherited from Component
virtual ComponentPeercreateNewPeer (int styleFlags, void *nativeWindowToAttachTo)
 
- Protected Member Functions inherited from SettableTooltipClient
 SettableTooltipClient ()
 

Detailed Description

A button that displays a Drawable.

Up to three Drawable objects can be given to this button, to represent the 'normal', 'over' and 'down' states.

See also
Button

Member Enumeration Documentation

◆ ButtonStyle

Enumerator
ImageFitted 

The button will just display the images, but will resize and centre them to fit inside it.

ImageRaw 

The button will just display the images in their normal size and position. This leaves it up to the caller to make sure the images are the correct size and position for the button.

ImageAboveTextLabel 

Draws the button as a text label across the bottom with the image resized and scaled to fit above it.

ImageOnButtonBackground 

Draws the button as a standard rounded-rectangle button with the image on top. Note that if you use this style, the colour IDs that control the button colour are TextButton::buttonColourId and TextButton::buttonOnColourId.

ImageStretched 

Fills the button with a stretched version of the image.

◆ ColourIds

A set of colour IDs to use to change the colour of various aspects of the link.

These constants can be used either via the Component::setColour(), or LookAndFeel::setColour() methods.

Note that when the ImageOnButtonBackground style is used, the colour IDs that control the button colour are TextButton::buttonColourId and TextButton::buttonOnColourId.

See also
Component::setColour, Component::findColour, LookAndFeel::setColour, LookAndFeel::findColour
Enumerator
textColourId 

The colour to use for the button's text label.

textColourOnId 

The colour to use for the button's text.when the button's toggle state is "on".

backgroundColourId 

The colour used to fill the button's background (when the button is toggled 'off'). Note that if you use the ImageOnButtonBackground style, you should use TextButton::buttonColourId to change the button's colour.

backgroundOnColourId 

The colour used to fill the button's background (when the button is toggled 'on'). Note that if you use the ImageOnButtonBackground style, you should use TextButton::buttonOnColourId to change the button's colour.

Constructor & Destructor Documentation

◆ DrawableButton()

DrawableButton::DrawableButton ( const String buttonName,
const DrawableButton::ButtonStyle  buttonStyle 
)

Creates a DrawableButton.

After creating one of these, use setImages() to specify the drawables to use.

Parameters
buttonNamethe name to give the component
buttonStylethe layout to use
See also
ButtonStyle, setButtonStyle, setImages

◆ ~DrawableButton()

DrawableButton::~DrawableButton ( )

Destructor.

Member Function Documentation

◆ buttonStateChanged()

void DrawableButton::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 Button.

◆ colourChanged()

void DrawableButton::colourChanged ( )
overridevirtual

This method is called when a colour is changed by the setColour() method.

See also
setColour, findColour

Reimplemented from Component.

◆ enablementChanged()

void DrawableButton::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 Button.

◆ getCurrentImage()

Drawable * DrawableButton::getCurrentImage ( ) const
noexcept

Returns the image that the button is currently displaying.

◆ getDownImage()

Drawable * DrawableButton::getDownImage ( ) const
noexcept

Returns the image that the button will use when the mouse is held down on it.

◆ getImageBounds()

Rectangle< float > DrawableButton::getImageBounds ( ) const
virtual

Can be overridden to specify a custom position for the image within the button.

◆ getNormalImage()

Drawable * DrawableButton::getNormalImage ( ) const
noexcept

Returns the image that the button will use for its normal state.

◆ getOverImage()

Drawable * DrawableButton::getOverImage ( ) const
noexcept

Returns the image that the button will use when the mouse is over it.

◆ getStyle()

ButtonStyle DrawableButton::getStyle ( ) const
inlinenoexcept

Returns the current style.

◆ paintButton()

void DrawableButton::paintButton ( Graphics g,
bool  isMouseOverButton,
bool  isButtonDown 
)
overridevirtual

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

Implements Button.

◆ resized()

void DrawableButton::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 Component.

◆ setButtonStyle()

void DrawableButton::setButtonStyle ( const DrawableButton::ButtonStyle  newStyle)

Changes the button's style.

See also
ButtonStyle

◆ setEdgeIndent()

void DrawableButton::setEdgeIndent ( int  numPixelsIndent)

Gives the button an optional amount of space around the edge of the drawable. By default there's a gap of about 3 pixels.

◆ setImages()

void DrawableButton::setImages ( const Drawable normalImage,
const Drawable overImage = nullptr,
const Drawable downImage = nullptr,
const Drawable disabledImage = nullptr,
const Drawable normalImageOn = nullptr,
const Drawable overImageOn = nullptr,
const Drawable downImageOn = nullptr,
const Drawable disabledImageOn = nullptr 
)

Sets up the images to draw for the various button states.

The button will keep its own internal copies of these drawables.

Parameters
normalImagethe thing to draw for the button's 'normal' state. An internal copy will be made of the object passed-in if it is non-zero.
overImagethe thing to draw for the button's 'over' state - if this is zero, the button's normal image will be used when the mouse is over it. An internal copy will be made of the object passed-in if it is non-zero.
downImagethe thing to draw for the button's 'down' state - if this is zero, the 'over' image will be used instead (or the normal image as a last resort). An internal copy will be made of the object passed-in if it is non-zero.
disabledImagean image to draw when the button is disabled. If this is zero, the normal image will be drawn with a reduced opacity instead. An internal copy will be made of the object passed-in if it is non-zero.
normalImageOnsame as the normalImage, but this is used when the button's toggle state is 'on'. If this is nullptr, the normal image is used instead
overImageOnsame as the overImage, but this is used when the button's toggle state is 'on'. If this is nullptr, the normalImageOn is drawn instead
downImageOnsame as the downImage, but this is used when the button's toggle state is 'on'. If this is nullptr, the overImageOn is drawn instead
disabledImageOnsame as the disabledImage, but this is used when the button's toggle state is 'on'. If this is nullptr, the normal image will be drawn instead with a reduced opacity

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