MidiKeyboardComponent Class Reference
juce_audio_utils » gui

A component that displays a piano keyboard, whose notes can be clicked on. More...

Inheritance diagram for MidiKeyboardComponent:

## Public Types

enum | Orientation { horizontalKeyboard, verticalKeyboardFacingLeft, verticalKeyboardFacingRight }
| The direction of the keyboard. More...
enum | ColourIds { whiteNoteColourId = 0x1005000, blackNoteColourId = 0x1005001, keySeparatorLineColourId = 0x1005002, mouseOverKeyOverlayColourId = 0x1005003, keyDownOverlayColourId = 0x1005004, textLabelColourId = 0x1005005, upDownButtonBackgroundColourId = 0x1005006, upDownButtonArrowColourId = 0x1005007, shadowColourId = 0x1005008 }
| A set of colour IDs to use to change the colour of various aspects of the keyboard. More...
Public Types inherited from Component
enum | FocusChangeType { focusChangedByMouseClick, focusChangedByTabKey, focusChangedDirectly }
| Enumeration used by the focusGained() and focusLost() methods. More...

## Public Member Functions

| MidiKeyboardComponent (MidiKeyboardState &state, Orientation orientation)
| Creates a MidiKeyboardComponent. More...
| ~MidiKeyboardComponent () override
| Destructor. More...
void | setVelocity (float velocity, bool useMousePositionForVelocity)
| Changes the velocity used in midi note-on messages that are triggered by clicking on the component. More...
void | setMidiChannel (int midiChannelNumber)
| Changes the midi channel number that will be used for events triggered by clicking on the component. More...
int | getMidiChannel () const noexcept
| Returns the midi channel that the keyboard is using for midi messages. More...
void | setMidiChannelsToDisplay (int midiChannelMask)
| Sets a mask to indicate which incoming midi channels should be represented by key movements. More...
int | getMidiChannelsToDisplay () const noexcept
| Returns the current set of midi channels represented by the component. More...
void | setKeyWidth (float widthInPixels)
| Changes the width used to draw the white keys. More...
float | getKeyWidth () const noexcept
| Returns the width that was set by setKeyWidth(). More...
void | setScrollButtonWidth (int widthInPixels)
| Changes the width used to draw the buttons that scroll the keyboard up/down in octaves. More...
int | getScrollButtonWidth () const noexcept
| Returns the width that was set by setScrollButtonWidth(). More...
void | setOrientation (Orientation newOrientation)
| Changes the keyboard's current direction. More...
Orientation | getOrientation () const noexcept
| Returns the keyboard's current direction. More...
void | setAvailableRange (int lowestNote, int highestNote)
| Sets the range of midi notes that the keyboard will be limited to. More...
int | getRangeStart () const noexcept
| Returns the first note in the available range. More...
int | getRangeEnd () const noexcept
| Returns the last note in the available range. More...
void | setLowestVisibleKey (int noteNumber)
| If the keyboard extends beyond the size of the component, this will scroll it to show the given key at the start. More...
int | getLowestVisibleKey () const noexcept
| Returns the number of the first key shown in the component. More...
void | setBlackNoteLengthProportion (float ratio) noexcept
| Sets the length of the black notes as a proportion of the white note length. More...
float | getBlackNoteLengthProportion () const noexcept
| Returns the length of the black notes as a proportion of the white note length. More...
float | getBlackNoteLength () const noexcept
| Returns the absolute length of the black notes. More...
void | setBlackNoteWidthProportion (float ratio) noexcept
| Sets the width of the black notes as a proportion of the white note width. More...
float | getBlackNoteWidthProportion () const noexcept
| Returns the width of the black notes as a proportion of the white note width. More...
float | getBlackNoteWidth () const noexcept
| Returns the absolute width of the black notes. More...
void | setScrollButtonsVisible (bool canScroll)
| If set to true, then scroll buttons will appear at either end of the keyboard if there are too many notes to fit them all in the component at once. More...
float | getKeyStartPosition (int midiNoteNumber) const
| Returns the position within the component of the left-hand edge of a key. More...
float | getTotalKeyboardWidth () const noexcept
| Returns the total width needed to fit all the keys in the available range. More...
int | getNoteAtPosition (Point< float > position)
| Returns the key at a given coordinate. More...
void | clearKeyMappings ()
| Deletes all key-mappings. More...
void | setKeyPressForNote (const KeyPress &key, int midiNoteOffsetFromC)
| Maps a key-press to a given note. More...
void | removeKeyPressForNote (int midiNoteOffsetFromC)
| Removes any key-mappings for a given note. More...
void | setKeyPressBaseOctave (int newOctaveNumber)
| Changes the base note above which key-press-triggered notes are played. More...
void | setOctaveForMiddleC (int octaveNumForMiddleC)
| This sets the octave number which is shown as the octave number for middle C. More...
int | getOctaveForMiddleC () const noexcept
| This returns the value set by setOctaveForMiddleC(). More...
void | paint (Graphics &) override
void | resized () override
void | mouseMove (const MouseEvent &) override
void | mouseDrag (const MouseEvent &) override
void | mouseDown (const MouseEvent &) override
void | mouseUp (const MouseEvent &) override
void | mouseEnter (const MouseEvent &) override
void | mouseExit (const MouseEvent &) override
void | mouseWheelMove (const MouseEvent &, const MouseWheelDetails &) override
void | timerCallback () override
bool | keyStateChanged (bool isKeyDown) override
bool | keyPressed (const KeyPress &) override
void | focusLost (FocusChangeType) override
void | handleNoteOn (MidiKeyboardState *, int midiChannel, int midiNoteNumber, float velocity) override
void | handleNoteOff (MidiKeyboardState *, int midiChannel, int midiNoteNumber, float velocity) override
void | colourChanged () override
Public Member Functions inherited from Component
| Component () noexcept
| Creates a component. More...
| ~Component () override
| Destructor. More...
| Component (const String &componentName) noexcept
| Creates a component, setting its name at the same time. More...
const String & | getName () const noexcept
| Returns the name of this component. More...
virtual void | setName (const String &newName)
| Sets the name of this component. More...
const String & | getComponentID () const noexcept
| Returns the ID string that was set by setComponentID(). More...
void | setComponentID (const String &newID)
| Sets the component's ID string. More...
virtual void | setVisible (bool shouldBeVisible)
| Makes the component visible or invisible. More...
bool | isVisible () const noexcept
| Tests whether the component is visible or not. More...
virtual void | visibilityChanged ()
| Called when this component's visibility changes. More...
bool | isShowing () const
| Tests whether this component and all its parents are visible. More...
virtual void | addToDesktop (int windowStyleFlags, void *nativeWindowToAttachTo=nullptr)
| Makes this component appear as a window on the desktop. More...
void | removeFromDesktop ()
| If the component is currently showing on the desktop, this will hide it. More...
bool | isOnDesktop () const noexcept
| Returns true if this component is currently showing on the desktop. More...
ComponentPeer * | getPeer () const
| Returns the heavyweight window that contains this component. More...
virtual void | userTriedToCloseWindow ()
| For components on the desktop, this is called if the system wants to close the window. More...
virtual void | minimisationStateChanged (bool isNowMinimised)
| Called for a desktop component which has just been minimised or un-minimised. More...
virtual float | getDesktopScaleFactor () const
| Returns the default scale factor to use for this component when it is placed on the desktop. More...
void | toFront (bool shouldAlsoGainFocus)
| Brings the component to the front of its siblings. More...
void | toBack ()
| Changes this component's z-order to be at the back of all its siblings. More...
void | toBehind (Component *other)
| Changes this component's z-order so that it's just behind another component. More...
void | setAlwaysOnTop (bool shouldStayOnTop)
| Sets whether the component should always be kept at the front of its siblings. More...
bool | isAlwaysOnTop () const noexcept
| Returns true if this component is set to always stay in front of its siblings. More...
int | getX () const noexcept
| Returns the x coordinate of the component's left edge. More...
int | getY () const noexcept
| Returns the y coordinate of the top of this component. More...
int | getWidth () const noexcept
| Returns the component's width in pixels. More...
int | getHeight () const noexcept
| Returns the component's height in pixels. More...
int | getRight () const noexcept
| Returns the x coordinate of the component's right-hand edge. More...
Point< int > | getPosition () const noexcept
| Returns the component's top-left position as a Point. More...
int | getBottom () const noexcept
| Returns the y coordinate of the bottom edge of this component. More...
Rectangle< int > | getBounds () const noexcept
| Returns this component's bounding box. More...
Rectangle< int > | getLocalBounds () const noexcept
| Returns the component's bounds, relative to its own origin. More...
Rectangle< int > | getBoundsInParent () const noexcept
| Returns the area of this component's parent which this component covers. More...
int | getScreenX () const
| Returns this component's x coordinate relative the screen's top-left origin. More...
int | getScreenY () const
| Returns this component's y coordinate relative the screen's top-left origin. More...
Point< int > | getScreenPosition () const
| Returns the position of this component's top-left corner relative to the screen's top-left. More...
Rectangle< int > | getScreenBounds () const
| Returns the bounds of this component, relative to the screen's top-left. More...
Point< int > | getLocalPoint (const Component *sourceComponent, Point< int > pointRelativeToSourceComponent) const
| Converts a point to be relative to this component's coordinate space. More...
Point< float > | getLocalPoint (const Component *sourceComponent, Point< float > pointRelativeToSourceComponent) const
| Converts a point to be relative to this component's coordinate space. More...
Rectangle< int > | getLocalArea (const Component *sourceComponent, Rectangle< int > areaRelativeToSourceComponent) const
| Converts a rectangle to be relative to this component's coordinate space. More...
Point< int > | localPointToGlobal (Point< int > localPoint) const
| Converts a point relative to this component's top-left into a screen coordinate. More...
Point< float > | localPointToGlobal (Point< float > localPoint) const
| Converts a point relative to this component's top-left into a screen coordinate. More...
Rectangle< int > | localAreaToGlobal (Rectangle< int > localArea) const
| Converts a rectangle from this component's coordinate space to a screen coordinate. More...
void | setTopLeftPosition (int x, int y)
| Moves the component to a new position. More...
void | setTopLeftPosition (Point< int > newTopLeftPosition)
| Moves the component to a new position. More...
void | setTopRightPosition (int x, int y)
| Moves the component to a new position. More...
void | setSize (int newWidth, int newHeight)
| Changes the size of the component. More...
void | setBounds (int x, int y, int width, int height)
| Changes the component's position and size. More...
void | setBounds (Rectangle< int > newBounds)
| Changes the component's position and size. More...
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. More...
void | setBoundsRelative (Rectangle< float > proportionalArea)
| Changes the component's position and size in terms of fractions of its parent's size. More...
void | setBoundsInset (BorderSize< int > borders)
| Changes the component's position and size based on the amount of space to leave around it. More...
void | setBoundsToFit (Rectangle< int > targetArea, Justification justification, bool onlyReduceInSize)
| Positions the component within a given rectangle, keeping its proportions unchanged. More...
void | setCentrePosition (int x, int y)
| Changes the position of the component's centre. More...
void | setCentrePosition (Point< int > newCentrePosition)
| Changes the position of the component's centre. More...
void | setCentreRelative (float x, float y)
| Changes the position of the component's centre. More...
void | centreWithSize (int width, int height)
| Changes the component's size and centres it within its parent. More...
void | setTransform (const AffineTransform &transform)
| Sets a transform matrix to be applied to this component. More...
AffineTransform | getTransform () const
| Returns the transform that is currently being applied to this component. More...
bool | isTransformed () const noexcept
| Returns true if a non-identity transform is being applied to this component. More...
int | proportionOfWidth (float proportion) const noexcept
| Returns a proportion of the component's width. More...
int | proportionOfHeight (float proportion) const noexcept
| Returns a proportion of the component's height. More...
int | getParentWidth () const noexcept
| Returns the width of the component's parent. More...
int | getParentHeight () const noexcept
| Returns the height of the component's parent. More...
Rectangle< int > | getParentMonitorArea () const
| Returns the screen coordinates of the monitor that contains this component. More...
int | getNumChildComponents () const noexcept
| Returns the number of child components that this component contains. More...
Component * | getChildComponent (int index) const noexcept
| Returns one of this component's child components, by it index. More...
int | getIndexOfChildComponent (const Component *child) const noexcept
| Returns the index of this component in the list of child components. More...
const Array< Component * > & | getChildren () const noexcept
| Provides access to the underlying array of child components. More...
Component * | findChildWithID (StringRef componentID) const noexcept
| Looks for a child component with the specified ID. More...
void | addChildComponent (Component *child, int zOrder=-1)
| Adds a child component to this one. More...
void | addChildComponent (Component &child, int zOrder=-1)
| Adds a child component to this one. More...
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. More...
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. More...
void | addChildAndSetID (Component *child, const String &componentID)
| Adds a child component to this one, makes it visible, and sets its component ID. More...
void | removeChildComponent (Component *childToRemove)
| Removes one of this component's child-components. More...
Component * | removeChildComponent (int childIndexToRemove)
| Removes one of this component's child-components by index. More...
void | removeAllChildren ()
| Removes all this component's children. More...
void | deleteAllChildren ()
| Removes and deletes all of this component's children. More...
Component * | getParentComponent () const noexcept
| Returns the component which this component is inside. More...
template<class TargetClass >
TargetClass * | findParentComponentOfClass () const
| Searches the parent components for a component of a specified class. More...
Component * | getTopLevelComponent () const noexcept
| Returns the highest-level component which contains this one or its parents. More...
bool | isParentOf (const Component *possibleChild) const noexcept
| Checks whether a component is anywhere inside this component or its children. More...
virtual void | parentHierarchyChanged ()
| Called to indicate that the component's parents have changed. More...
virtual void | childrenChanged ()
| Subclasses can use this callback to be told when children are added or removed, or when their z-order changes. More...
virtual bool | hitTest (int x, int y)
| Tests whether a given point is inside the component. More...
void | setInterceptsMouseClicks (bool allowClicksOnThisComponent, bool allowClicksOnChildComponents) noexcept
| Changes the default return value for the hitTest() method. More...
void | getInterceptsMouseClicks (bool &allowsClicksOnThisComponent, bool &allowsClicksOnChildComponents) const noexcept
| Retrieves the current state of the mouse-click interception flags. More...
bool | contains (Point< int > localPoint)
| Returns true if a given point lies within this component or one of its children. More...
bool | reallyContains (Point< int > localPoint, bool returnTrueIfWithinAChild)
| Returns true if a given point lies in this component, taking any overlapping siblings into account. More...
Component * | getComponentAt (int x, int y)
| Returns the component at a certain point within this one. More...
Component * | getComponentAt (Point< int > position)
| Returns the component at a certain point within this one. More...
void | repaint ()
| Marks the whole component as needing to be redrawn. More...
void | repaint (int x, int y, int width, int height)
| Marks a subsection of this component as needing to be redrawn. More...
void | repaint (Rectangle< int > area)
| Marks a subsection of this component as needing to be redrawn. More...
void | setBufferedToImage (bool shouldBeBuffered)
| Makes the component use an internal buffer to optimise its redrawing. More...
Image | createComponentSnapshot (Rectangle< int > areaToGrab, bool clipImageToComponentBounds=true, float scaleFactor=1.0f)
| Generates a snapshot of part of this component. More...
void | paintEntireComponent (Graphics &context, bool ignoreAlphaLevel)
| Draws this component and all its subcomponents onto the specified graphics context. More...
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. More...
bool | isPaintingUnclipped () const noexcept
| Returns true if this component doesn't require its graphics context to be clipped when it is being painted. More...
void | setComponentEffect (ImageEffectFilter *newEffect)
| Adds an effect filter to alter the component's appearance. More...
ImageEffectFilter * | getComponentEffect () const noexcept
| Returns the current component effect. More...
LookAndFeel & | getLookAndFeel () const noexcept
| Finds the appropriate look-and-feel to use for this component. More...
void | setLookAndFeel (LookAndFeel *newLookAndFeel)
| Sets the look and feel to use for this component. More...
virtual void | lookAndFeelChanged ()
| Called to let the component react to a change in the look-and-feel setting. More...
void | sendLookAndFeelChange ()
| Calls the lookAndFeelChanged() method in this component and all its children. More...
void | setOpaque (bool shouldBeOpaque)
| Indicates whether any parts of the component might be transparent. More...
bool | isOpaque () const noexcept
| Returns true if no parts of this component are transparent. More...
void | setBroughtToFrontOnMouseClick (bool shouldBeBroughtToFront) noexcept
| Indicates whether the component should be brought to the front when clicked. More...
bool | isBroughtToFrontOnMouseClick () const noexcept
| Indicates whether the component should be brought to the front when clicked-on. More...
void | setWantsKeyboardFocus (bool wantsFocus) noexcept
| Sets a flag to indicate whether this component needs keyboard focus or not. More...
bool | getWantsKeyboardFocus () const noexcept
| Returns true if the component is interested in getting keyboard focus. More...
void | setMouseClickGrabsKeyboardFocus (bool shouldGrabFocus)
| Chooses whether a click on this component automatically grabs the focus. More...
bool | getMouseClickGrabsKeyboardFocus () const noexcept
| Returns the last value set with setMouseClickGrabsKeyboardFocus(). More...
void | grabKeyboardFocus ()
| Tries to give keyboard focus to this component. More...
bool | hasKeyboardFocus (bool trueIfChildIsFocused) const
| Returns true if this component currently has the keyboard focus. More...
void | moveKeyboardFocusToSibling (bool moveToNext)
| Tries to move the keyboard focus to one of this component's siblings. More...
virtual KeyboardFocusTraverser * | createFocusTraverser ()
| Creates a KeyboardFocusTraverser object to use to determine the logic by which focus should be passed from this component. More...
int | getExplicitFocusOrder () const
| Returns the focus order of this component, if one has been specified. More...
void | setExplicitFocusOrder (int newFocusOrderIndex)
| Sets the index used in determining the order in which focusable components should be traversed. More...
void | setFocusContainer (bool shouldBeFocusContainer) noexcept
| Indicates whether this component is a parent for components that can have their focus traversed. More...
bool | isFocusContainer () const noexcept
| Returns true if this component has been marked as a focus container. More...
bool | isEnabled () const noexcept
| Returns true if the component (and all its parents) are enabled. More...
void | setEnabled (bool shouldBeEnabled)
| Enables or disables this component. More...
virtual void | enablementChanged ()
| Callback to indicate that this component has been enabled or disabled. More...
float | getAlpha () const noexcept
| Returns the component's current transparency level. More...
void | setAlpha (float newAlpha)
| Changes the transparency of this component. More...
virtual void | alphaChanged ()
| Called when setAlpha() is used to change the alpha value of this component. More...
void | setMouseCursor (const MouseCursor &cursorType)
| Changes the mouse cursor shape to use when the mouse is over this component. More...
virtual MouseCursor | getMouseCursor ()
| Returns the mouse cursor shape to use when the mouse is over this component. More...
void | updateMouseCursor () const
| Forces the current mouse cursor to be updated. More...
virtual void | paintOverChildren (Graphics &g)
| Components can override this method to draw over the top of their children. More...
void | mouseMove (const MouseEvent &event) override
| Called when the mouse moves inside a component. More...
void | mouseEnter (const MouseEvent &event) override
| Called when the mouse first enters a component. More...
void | mouseExit (const MouseEvent &event) override
| Called when the mouse moves out of a component. More...
void | mouseDown (const MouseEvent &event) override
| Called when a mouse button is pressed. More...
void | mouseDrag (const MouseEvent &event) override
| Called when the mouse is moved while a button is held down. More...
void | mouseUp (const MouseEvent &event) override
| Called when a mouse button is released. More...
void | mouseDoubleClick (const MouseEvent &event) override
| Called when a mouse button has been double-clicked on a component. More...
void | mouseWheelMove (const MouseEvent &event, const MouseWheelDetails &wheel) override
| Called when the mouse-wheel is moved. More...
void | mouseMagnify (const MouseEvent &event, float scaleFactor) override
| Called when a pinch-to-zoom mouse-gesture is used. More...
void | setRepaintsOnMouseActivity (bool shouldRepaint) noexcept
| Causes automatic repaints when the mouse enters or exits this component. More...
void | addMouseListener (MouseListener *newListener, bool wantsEventsForAllNestedChildComponents)
| Registers a listener to be told when mouse events occur in this component. More...
void | removeMouseListener (MouseListener *listenerToRemove)
| Deregisters a mouse listener. More...
void | addKeyListener (KeyListener *newListener)
| Adds a listener that wants to hear about keypresses that this component receives. More...
void | removeKeyListener (KeyListener *listenerToRemove)
| Removes a previously-registered key listener. More...
virtual void | modifierKeysChanged (const ModifierKeys &modifiers)
| Called when a modifier key is pressed or released. More...
virtual void | focusGained (FocusChangeType cause)
| Called to indicate that this component has just acquired the keyboard focus. More...
virtual void | focusOfChildComponentChanged (FocusChangeType cause)
| Called to indicate a change in whether or not this component is the parent of the currently-focused component. More...
bool | isMouseOver (bool includeChildren=false) const
| Returns true if the mouse is currently over this component. More...
bool | isMouseButtonDown (bool includeChildren=false) const
| Returns true if the mouse button is currently held down in this component. More...
bool | isMouseOverOrDragging (bool includeChildren=false) const
| True if the mouse is over this component, or if it's being dragged in this component. More...
Point< int > | getMouseXYRelative () const
| Returns the mouse's current position, relative to this component. More...
virtual void | moved ()
| Called when this component's position has been changed. More...
virtual void | childBoundsChanged (Component *child)
| Called when one of this component's children is moved or resized. More...
virtual void | parentSizeChanged ()
| Called when this component's immediate parent has been resized. More...
virtual void | broughtToFront ()
| Called when this component has been moved to the front of its siblings. More...
void | addComponentListener (ComponentListener *newListener)
| Adds a listener to be told about changes to the component hierarchy or position. More...
void | removeComponentListener (ComponentListener *listenerToRemove)
| Removes a component listener. More...
void | postCommandMessage (int commandId)
| Dispatches a numbered message to this component. More...
virtual void | handleCommandMessage (int commandId)
| Called to handle a command that was sent by postCommandMessage(). More...
int | runModalLoop ()
| Runs a component modally, waiting until the loop terminates. More...
void | enterModalState (bool takeKeyboardFocus=true, ModalComponentManager::Callback *callback=nullptr, bool deleteWhenDismissed=false)
| Puts the component into a modal state. More...
void | exitModalState (int returnValue)
| Ends a component's modal state. More...
bool | isCurrentlyModal (bool onlyConsiderForemostModalComponent=true) const noexcept
| Returns true if this component is the modal one. More...
bool | isCurrentlyBlockedByAnotherModalComponent () const
| Checks whether there's a modal component somewhere that's stopping this one from receiving messages. More...
virtual bool | canModalEventBeSentToComponent (const Component *targetComponent)
| When a component is modal, this callback allows it to choose which other components can still receive events. More...
virtual void | inputAttemptWhenModal ()
| Called when the user tries to click on a component that is blocked by another modal component. More...
NamedValueSet & | getProperties () noexcept
| Returns the set of properties that belong to this component. More...
const NamedValueSet & | getProperties () const noexcept
| Returns the set of properties that belong to this component. More...
Colour | findColour (int colourID, bool inheritFromParent=false) const
| Looks for a colour that has been registered with the given colour ID number. More...
void | setColour (int colourID, Colour newColour)
| Registers a colour to be used for a particular purpose. More...
void | removeColour (int colourID)
| If a colour has been set with setColour(), this will remove it. More...
bool | isColourSpecified (int colourID) const
| Returns true if the specified colour ID has been explicitly set for this component using the setColour() method. More...
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. More...
void * | getWindowHandle () const
| Returns the underlying native window handle for this component. More...
Positioner * | getPositioner () const noexcept
| Returns the Positioner object that has been set for this component. More...
void | setPositioner (Positioner *newPositioner)
| Sets a new Positioner object for this component. More...
void | setCachedComponentImage (CachedComponentImage *newCachedImage)
| Gives the component a CachedComponentImage that should be used to buffer its painting. More...
CachedComponentImage * | getCachedComponentImage () const noexcept
| Returns the object that was set by setCachedComponentImage(). More...
void | setViewportIgnoreDragFlag (bool ignoreDrag) noexcept
| Sets a flag to indicate whether mouse drag events on this Component should be ignored when it is inside a Viewport with drag-to-scroll functionality enabled. More...
bool | getViewportIgnoreDragFlag () const noexcept
| Retrieves the current state of the Viewport drag-to-scroll functionality flag. More...
Public Member Functions inherited from MouseListener
virtual | ~MouseListener ()=default
| Destructor. More...
Public Member Functions inherited from MidiKeyboardStateListener
| MidiKeyboardStateListener ()=default
virtual | ~MidiKeyboardStateListener ()=default
Public Member Functions inherited from ChangeBroadcaster
| ChangeBroadcaster () noexcept
| Creates an ChangeBroadcaster. More...
virtual | ~ChangeBroadcaster ()
| Destructor. More...
void | addChangeListener (ChangeListener *listener)
| Registers a listener to receive change callbacks from this broadcaster. More...
void | removeChangeListener (ChangeListener *listener)
| Unregisters a listener from the list. More...
void | removeAllChangeListeners ()
| Removes all listeners from the list. More...
void | sendChangeMessage ()
| Causes an asynchronous change message to be sent to all the registered listeners. More...
void | sendSynchronousChangeMessage ()
| Sends a synchronous change message to all the registered listeners. More...
void | dispatchPendingMessages ()
| If a change message has been sent but not yet dispatched, this will call sendSynchronousChangeMessage() to make the callback immediately. More...

## Protected Member Functions

virtual void | drawWhiteNote (int midiNoteNumber, Graphics &g, Rectangle< float > area, bool isDown, bool isOver, Colour lineColour, Colour textColour)
| Draws a white note in the given rectangle. More...
virtual void | drawBlackNote (int midiNoteNumber, Graphics &g, Rectangle< float > area, bool isDown, bool isOver, Colour noteFillColour)
| Draws a black note in the given rectangle. More...
virtual String | getWhiteNoteText (int midiNoteNumber)
| Allows text to be drawn on the white notes. More...
virtual void | drawUpDownButton (Graphics &g, int w, int h, bool isMouseOver, bool isButtonPressed, bool movesOctavesUp)
| Draws the up and down buttons that scroll the keyboard up/down in octaves. More...
virtual bool | mouseDownOnKey (int midiNoteNumber, const MouseEvent &e)
| Callback when the mouse is clicked on a key. More...
virtual bool | mouseDraggedToKey (int midiNoteNumber, const MouseEvent &e)
| Callback when the mouse is dragged from one key onto another. More...
virtual void | mouseUpOnKey (int midiNoteNumber, const MouseEvent &e)
| Callback when the mouse is released from a key. More...
virtual Range< float > | getKeyPosition (int midiNoteNumber, float keyWidth) const
| Calculates the position of a given midi-note. More...
Rectangle< float > | getRectangleForKey (int midiNoteNumber) const
| Returns the rectangle for a given key if within the displayable range. More...

## Additional Inherited Members

Static Public Member Functions inherited from Component
static float JUCE_CALLTYPE | getApproximateScaleFactorForComponent (Component *targetComponent)
| Returns the approximate scale factor for a given component by traversing its parent hierarchy and applying each transform and finally scaling this by the global scale factor. More...
static Component *JUCE_CALLTYPE | getCurrentlyFocusedComponent () noexcept
| Returns the component that currently has the keyboard focus. More...
static void JUCE_CALLTYPE | unfocusAllComponents ()
| If any component has keyboard focus, this will defocus it. More...
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. More...
static bool JUCE_CALLTYPE | isMouseButtonDownAnywhere () noexcept
| Returns true if a mouse button is currently down. More...
static int JUCE_CALLTYPE | getNumCurrentlyModalComponents () noexcept
| Returns the number of components that are currently in a modal state. More...
static Component *JUCE_CALLTYPE | getCurrentlyModalComponent (int index=0) noexcept
| Returns one of the components that are currently modal. More...

## Detailed Description

A component that displays a piano keyboard, whose notes can be clicked on.

This component will mimic a physical midi keyboard, showing the current state of a MidiKeyboardState object. When the on-screen keys are clicked on, it will play these notes by calling the noteOn() and noteOff() methods of its MidiKeyboardState object.

Another feature is that the computer keyboard can also be used to play notes. By default it maps the top two rows of a standard qwerty keyboard to the notes, but these can be remapped if needed. It will only respond to keypresses when it has the keyboard focus, so to disable this feature you can call setWantsKeyboardFocus (false).

The component is also a ChangeBroadcaster, so if you want to be informed when the keyboard is scrolled, you can register a ChangeListener for callbacks.

See also
  MidiKeyboardState

## Member Enumeration Documentation

## Orientation

enum MidiKeyboardComponent::Orientation

The direction of the keyboard.

See also
  setOrientation

Enumerator
horizontalKeyboard |
verticalKeyboardFacingLeft |
verticalKeyboardFacingRight |

## ColourIds

enum MidiKeyboardComponent::ColourIds

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

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

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

Enumerator
whiteNoteColourId |
blackNoteColourId |
keySeparatorLineColourId |
mouseOverKeyOverlayColourId | This colour will be overlaid on the normal note colour.
keyDownOverlayColourId | This colour will be overlaid on the normal note colour.
textLabelColourId |
upDownButtonBackgroundColourId |
upDownButtonArrowColourId |
shadowColourId |

## Constructor & Destructor Documentation

## MidiKeyboardComponent()

MidiKeyboardComponent::MidiKeyboardComponent | ( | MidiKeyboardState & | state,
|  | Orientation | orientation
| ) |  |

Creates a MidiKeyboardComponent.

Parameters

  state | the midi keyboard model that this component will represent
  orientation | whether the keyboard is horizontal or vertical

## ~MidiKeyboardComponent()

MidiKeyboardComponent::~MidiKeyboardComponent | ( |  | ) |

override

Destructor.

## Member Function Documentation

## setVelocity()

void MidiKeyboardComponent::setVelocity | ( | float | velocity,
|  | bool | useMousePositionForVelocity
| ) |  |

Changes the velocity used in midi note-on messages that are triggered by clicking on the component.

Values are 0 to 1.0, where 1.0 is the heaviest.

See also
  setMidiChannel

## setMidiChannel()

void MidiKeyboardComponent::setMidiChannel | ( | int | midiChannelNumber | ) |

Changes the midi channel number that will be used for events triggered by clicking on the component.

The channel must be between 1 and 16 (inclusive). This is the channel that will be passed on to the MidiKeyboardState::noteOn() method when the user clicks the component.

Although this is the channel used for outgoing events, the component can display incoming events from more than one channel - see setMidiChannelsToDisplay()

See also
  setVelocity

## getMidiChannel()

int MidiKeyboardComponent::getMidiChannel | ( |  | ) | const

noexcept

Returns the midi channel that the keyboard is using for midi messages.

See also
  setMidiChannel

## setMidiChannelsToDisplay()

void MidiKeyboardComponent::setMidiChannelsToDisplay | ( | int | midiChannelMask | ) |

Sets a mask to indicate which incoming midi channels should be represented by key movements.

The mask is a set of bits, where bit 0 = midi channel 1, bit 1 = midi channel 2, etc.

If the MidiKeyboardState has a key down for any of the channels whose bits are set in this mask, the on-screen keys will also go down.

By default, this mask is set to 0xffff (all channels displayed).

See also
  setMidiChannel

## getMidiChannelsToDisplay()

int MidiKeyboardComponent::getMidiChannelsToDisplay | ( |  | ) | const

noexcept

Returns the current set of midi channels represented by the component.

This is the value that was set with setMidiChannelsToDisplay().

## setKeyWidth()

void MidiKeyboardComponent::setKeyWidth | ( | float | widthInPixels | ) |

Changes the width used to draw the white keys.

## getKeyWidth()

float MidiKeyboardComponent::getKeyWidth | ( |  | ) | const

noexcept

Returns the width that was set by setKeyWidth().

## setScrollButtonWidth()

void MidiKeyboardComponent::setScrollButtonWidth | ( | int | widthInPixels | ) |

Changes the width used to draw the buttons that scroll the keyboard up/down in octaves.

## getScrollButtonWidth()

int MidiKeyboardComponent::getScrollButtonWidth | ( |  | ) | const

noexcept

Returns the width that was set by setScrollButtonWidth().

## setOrientation()

void MidiKeyboardComponent::setOrientation | ( | Orientation | newOrientation | ) |

Changes the keyboard's current direction.

## getOrientation()

Orientation MidiKeyboardComponent::getOrientation | ( |  | ) | const

noexcept

Returns the keyboard's current direction.

## setAvailableRange()

void MidiKeyboardComponent::setAvailableRange | ( | int | lowestNote,
|  | int | highestNote
| ) |  |

Sets the range of midi notes that the keyboard will be limited to.

By default the range is 0 to 127 (inclusive), but you can limit this if you only want a restricted set of the keys to be shown.

Note that the values here are inclusive and must be between 0 and 127.

## getRangeStart()

int MidiKeyboardComponent::getRangeStart | ( |  | ) | const

noexcept

Returns the first note in the available range.

See also
  setAvailableRange

## getRangeEnd()

int MidiKeyboardComponent::getRangeEnd | ( |  | ) | const

noexcept

Returns the last note in the available range.

See also
  setAvailableRange

## setLowestVisibleKey()

void MidiKeyboardComponent::setLowestVisibleKey | ( | int | noteNumber | ) |

If the keyboard extends beyond the size of the component, this will scroll it to show the given key at the start.

Whenever the keyboard's position is changed, this will use the ChangeBroadcaster base class to send a callback to any ChangeListeners that have been registered.

## getLowestVisibleKey()

int MidiKeyboardComponent::getLowestVisibleKey | ( |  | ) | const

noexcept

Returns the number of the first key shown in the component.

See also
  setLowestVisibleKey

## setBlackNoteLengthProportion()

void MidiKeyboardComponent::setBlackNoteLengthProportion | ( | float | ratio | ) |

noexcept

Sets the length of the black notes as a proportion of the white note length.

## getBlackNoteLengthProportion()

float MidiKeyboardComponent::getBlackNoteLengthProportion | ( |  | ) | const

noexcept

Returns the length of the black notes as a proportion of the white note length.

## getBlackNoteLength()

float MidiKeyboardComponent::getBlackNoteLength | ( |  | ) | const

noexcept

Returns the absolute length of the black notes.

This will be their vertical or horizontal length, depending on the keyboard's orientation.

## setBlackNoteWidthProportion()

void MidiKeyboardComponent::setBlackNoteWidthProportion | ( | float | ratio | ) |

noexcept

Sets the width of the black notes as a proportion of the white note width.

## getBlackNoteWidthProportion()

float MidiKeyboardComponent::getBlackNoteWidthProportion | ( |  | ) | const

noexcept

Returns the width of the black notes as a proportion of the white note width.

## getBlackNoteWidth()

float MidiKeyboardComponent::getBlackNoteWidth | ( |  | ) | const

noexcept

Returns the absolute width of the black notes.

This will be their vertical or horizontal width, depending on the keyboard's orientation.

## setScrollButtonsVisible()

void MidiKeyboardComponent::setScrollButtonsVisible | ( | bool | canScroll | ) |

If set to true, then scroll buttons will appear at either end of the keyboard if there are too many notes to fit them all in the component at once.

## getKeyStartPosition()

float MidiKeyboardComponent::getKeyStartPosition | ( | int | midiNoteNumber | ) | const

Returns the position within the component of the left-hand edge of a key.

Depending on the keyboard's orientation, this may be a horizontal or vertical distance, in either direction.

## getTotalKeyboardWidth()

float MidiKeyboardComponent::getTotalKeyboardWidth | ( |  | ) | const

noexcept

Returns the total width needed to fit all the keys in the available range.

## getNoteAtPosition()

int MidiKeyboardComponent::getNoteAtPosition | ( | Point< float > | position | ) |

Returns the key at a given coordinate.

## clearKeyMappings()

void MidiKeyboardComponent::clearKeyMappings | ( |  | ) |

Deletes all key-mappings.

See also
  setKeyPressForNote

## setKeyPressForNote()

void MidiKeyboardComponent::setKeyPressForNote | ( | const KeyPress & | key,
|  | int | midiNoteOffsetFromC
| ) |  |

Maps a key-press to a given note.

Parameters

  key | the key that should trigger the note
  midiNoteOffsetFromC | how many semitones above C the triggered note should be. The actual midi note that gets played will be this value + (12 * the current base octave). To change the base octave, see setKeyPressBaseOctave()

## removeKeyPressForNote()

void MidiKeyboardComponent::removeKeyPressForNote | ( | int | midiNoteOffsetFromC | ) |

Removes any key-mappings for a given note.

For a description of what the note number means, see setKeyPressForNote().

## setKeyPressBaseOctave()

void MidiKeyboardComponent::setKeyPressBaseOctave | ( | int | newOctaveNumber | ) |

Changes the base note above which key-press-triggered notes are played.

The set of key-mappings that trigger notes can be moved up and down to cover the entire scale using this method.

The value passed in is an octave number between 0 and 10 (inclusive), and indicates which C is the base note to which the key-mapped notes are relative.

## setOctaveForMiddleC()

void MidiKeyboardComponent::setOctaveForMiddleC | ( | int | octaveNumForMiddleC | ) |

This sets the octave number which is shown as the octave number for middle C.

This affects only the default implementation of getWhiteNoteText(), which passes this octave number to MidiMessage::getMidiNoteName() in order to get the note text. See MidiMessage::getMidiNoteName() for more info about the parameter.

By default this value is set to 3.

See also
  getOctaveForMiddleC

## getOctaveForMiddleC()

int MidiKeyboardComponent::getOctaveForMiddleC | ( |  | ) | const

noexcept

This returns the value set by setOctaveForMiddleC().

See also
  setOctaveForMiddleC

## paint()

void MidiKeyboardComponent::paint | ( | Graphics & |  | ) |

override virtual

Reimplemented from Component.

## resized()

void MidiKeyboardComponent::resized | ( |  | ) |

override virtual

Reimplemented from Component.

## mouseMove()

void MidiKeyboardComponent::mouseMove | ( | const MouseEvent & |  | ) |

override virtual

Reimplemented from MouseListener.

## mouseDrag()

void MidiKeyboardComponent::mouseDrag | ( | const MouseEvent & |  | ) |

override virtual

Reimplemented from MouseListener.

## mouseDown()

void MidiKeyboardComponent::mouseDown | ( | const MouseEvent & |  | ) |

override virtual

Reimplemented from MouseListener.

## mouseUp()

void MidiKeyboardComponent::mouseUp | ( | const MouseEvent & |  | ) |

override virtual

Reimplemented from MouseListener.

## mouseEnter()

void MidiKeyboardComponent::mouseEnter | ( | const MouseEvent & |  | ) |

override virtual

Reimplemented from MouseListener.

## mouseExit()

void MidiKeyboardComponent::mouseExit | ( | const MouseEvent & |  | ) |

override virtual

Reimplemented from MouseListener.

## mouseWheelMove()

void MidiKeyboardComponent::mouseWheelMove | ( | const MouseEvent & | ,
|  | const MouseWheelDetails & |
| ) |  |

override virtual

Reimplemented from MouseListener.

## timerCallback()

void MidiKeyboardComponent::timerCallback | ( |  | ) |

override virtual

Implements Timer.

## keyStateChanged()

bool MidiKeyboardComponent::keyStateChanged | ( | bool | isKeyDown | ) |

override virtual

Reimplemented from Component.

## keyPressed()

bool MidiKeyboardComponent::keyPressed | ( | const KeyPress & |  | ) |

override virtual

Reimplemented from Component.

## focusLost()

void MidiKeyboardComponent::focusLost | ( | FocusChangeType |  | ) |

override virtual

Reimplemented from Component.

## handleNoteOn()

void MidiKeyboardComponent::handleNoteOn | ( | MidiKeyboardState * | ,
|  | int | midiChannel,
|  | int | midiNoteNumber,
|  | float | velocity
| ) |  |

override virtual

Implements MidiKeyboardStateListener.

## handleNoteOff()

void MidiKeyboardComponent::handleNoteOff | ( | MidiKeyboardState * | ,
|  | int | midiChannel,
|  | int | midiNoteNumber,
|  | float | velocity
| ) |  |

override virtual

Implements MidiKeyboardStateListener.

## colourChanged()

void MidiKeyboardComponent::colourChanged | ( |  | ) |

override virtual

Reimplemented from Component.

## drawWhiteNote()

virtual void MidiKeyboardComponent::drawWhiteNote | ( | int | midiNoteNumber,
|  | Graphics & | g,
|  | Rectangle< float > | area,
|  | bool | isDown,
|  | bool | isOver,
|  | Colour | lineColour,
|  | Colour | textColour
| ) |  |

protected virtual

Draws a white note in the given rectangle.

isOver indicates whether the mouse is over the key, isDown indicates whether the key is currently pressed down.

When doing this, be sure to note the keyboard's orientation.

## drawBlackNote()

virtual void MidiKeyboardComponent::drawBlackNote | ( | int | midiNoteNumber,
|  | Graphics & | g,
|  | Rectangle< float > | area,
|  | bool | isDown,
|  | bool | isOver,
|  | Colour | noteFillColour
| ) |  |

protected virtual

Draws a black note in the given rectangle.

isOver indicates whether the mouse is over the key, isDown indicates whether the key is currently pressed down.

When doing this, be sure to note the keyboard's orientation.

## getWhiteNoteText()

virtual String MidiKeyboardComponent::getWhiteNoteText | ( | int | midiNoteNumber | ) |

protected virtual

Allows text to be drawn on the white notes.

By default this is used to label the C in each octave, but could be used for other things.

See also
  setOctaveForMiddleC

## drawUpDownButton()

virtual void MidiKeyboardComponent::drawUpDownButton | ( | Graphics & | g,
|  | int | w,
|  | int | h,
|  | bool | isMouseOver,
|  | bool | isButtonPressed,
|  | bool | movesOctavesUp
| ) |  |

protected virtual

Draws the up and down buttons that scroll the keyboard up/down in octaves.

## mouseDownOnKey()

virtual bool MidiKeyboardComponent::mouseDownOnKey | ( | int | midiNoteNumber,
|  | const MouseEvent & | e
| ) |  |

protected virtual

Callback when the mouse is clicked on a key.

You could use this to do things like handle right-clicks on keys, etc.

Return true if you want the click to trigger the note, or false if you want to handle it yourself and not have the note played.

See also
  mouseDraggedToKey

## mouseDraggedToKey()

virtual bool MidiKeyboardComponent::mouseDraggedToKey | ( | int | midiNoteNumber,
|  | const MouseEvent & | e
| ) |  |

protected virtual

Callback when the mouse is dragged from one key onto another.

Return true if you want the drag to trigger the new note, or false if you want to handle it yourself and not have the note played.

See also
  mouseDownOnKey

## mouseUpOnKey()

virtual void MidiKeyboardComponent::mouseUpOnKey | ( | int | midiNoteNumber,
|  | const MouseEvent & | e
| ) |  |

protected virtual

Callback when the mouse is released from a key.

See also
  mouseDownOnKey

## getKeyPosition()

virtual Range<float> MidiKeyboardComponent::getKeyPosition | ( | int | midiNoteNumber,
|  | float | keyWidth
| ) |  | const

protected virtual

Calculates the position of a given midi-note.

This can be overridden to create layouts with custom key-widths.

Parameters

  midiNoteNumber | the note to find
  keyWidth | the desired width in pixels of one key - see setKeyWidth()

Returns
  the start and length of the key along the axis of the keyboard

## getRectangleForKey()

Rectangle<float> MidiKeyboardComponent::getRectangleForKey | ( | int | midiNoteNumber | ) | const

protected

Returns the rectangle for a given key if within the displayable range.

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

- juce_MidiKeyboardComponent.h