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

Inherits Component, MidiKeyboardStateListener, ChangeBroadcaster, and Timer.

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 }
	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 focusChanged() and focusLost() methods. More...

Public Member Functions
	MidiKeyboardComponent (MidiKeyboardState &state, Orientation orientation)
	Creates a MidiKeyboardComponent.

	~MidiKeyboardComponent ()
	Destructor.

void	setVelocity (float velocity, bool useMousePositionForVelocity)
	Changes the velocity used in midi note-on messages that are triggered by clicking on the component.

void	setMidiChannel (int midiChannelNumber)
	Changes the midi channel number that will be used for events triggered by clicking on the component.

int	getMidiChannel () const noexcept
	Returns the midi channel that the keyboard is using for midi messages.

void	setMidiChannelsToDisplay (int midiChannelMask)
	Sets a mask to indicate which incoming midi channels should be represented by key movements.

int	getMidiChannelsToDisplay () const noexcept
	Returns the current set of midi channels represented by the component.

void	setKeyWidth (float widthInPixels)
	Changes the width used to draw the white keys.

float	getKeyWidth () const noexcept
	Returns the width that was set by setKeyWidth().

void	setOrientation (Orientation newOrientation)
	Changes the keyboard's current direction.

Orientation	getOrientation () const noexcept
	Returns the keyboard's current direction.

void	setAvailableRange (int lowestNote, int highestNote)
	Sets the range of midi notes that the keyboard will be limited to.

int	getRangeStart () const noexcept
	Returns the first note in the available range.

int	getRangeEnd () const noexcept
	Returns the last note in the available range.

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.

int	getLowestVisibleKey () const noexcept
	Returns the number of the first key shown in the component.

int	getBlackNoteLength () const noexcept
	Returns the length of the black notes.

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.

int	getKeyStartPosition (const int midiNoteNumber) const
	Returns the position within the component of the left-hand edge of a key.

void	clearKeyMappings ()
	Deletes all key-mappings.

void	setKeyPressForNote (const KeyPress &key, int midiNoteOffsetFromC)
	Maps a key-press to a given note.

void	removeKeyPressForNote (int midiNoteOffsetFromC)
	Removes any key-mappings for a given note.

void	setKeyPressBaseOctave (int newOctaveNumber)
	Changes the base note above which key-press-triggered notes are played.

void	setOctaveForMiddleC (int octaveNumForMiddleC)
	This sets the octave number which is shown as the octave number for middle C.

int	getOctaveForMiddleC () const noexcept
	This returns the value set by setOctaveForMiddleC().

void	paint (Graphics &)

void	resized ()

void	mouseMove (const MouseEvent &)

void	mouseDrag (const MouseEvent &)

void	mouseDown (const MouseEvent &)

void	mouseUp (const MouseEvent &)

void	mouseEnter (const MouseEvent &)

void	mouseExit (const MouseEvent &)

void	mouseWheelMove (const MouseEvent &, const MouseWheelDetails &)

void	timerCallback ()

bool	keyStateChanged (bool isKeyDown)

void	focusLost (FocusChangeType)

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

void	handleNoteOff (MidiKeyboardState *, int midiChannel, int midiNoteNumber)

void	colourChanged ()

Public Member Functions inherited from Component
	Component ()
	Creates a component.

virtual	~Component ()
	Destructor.

	Component (const String &componentName)
	Creates a component, setting its name at the same time.

const String &	getName () const noexcept
	Returns the name of this component.

virtual void	setName (const String &newName)
	Sets the name of this component.

const String &	getComponentID () 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.

virtual void	visibilityChanged ()
	Called when this component's visiblility changes.

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.

ComponentPeer *	getPeer () 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.

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.

const 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.

void	getVisibleArea (RectangleList &result, bool includeSiblings) const
	Returns the region of this component that's not obscured by other, opaque components.

int	getScreenX () const
	Returns this component's x coordinate relative the the screen's top-left origin.

int	getScreenY () const
	Returns this component's y coordinate relative the 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, const Point< int > &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 (const Point< int > &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 (const 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, const 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.

Component *	getChildComponent (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.

Component *	findChildWithID (const String &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	addAndMakeVisible (Component *child, int zOrder=-1)
	Adds a child component to this one, and also makes the child visible if it isn't.

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.

Component *	removeChildComponent (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.

Component *	getParentComponent () 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.

Component *	getTopLevelComponent () 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	parentHierarchyChanged ()
	Called to indicate that the component's parents have changed.

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 (const Point< int > &localPoint)
	Returns true if a given point lies within this component or one of its children.

bool	reallyContains (const Point< int > &localPoint, bool returnTrueIfWithinAChild)
	Returns true if a given point lies in this component, taking any overlapping siblings into account.

Component *	getComponentAt (int x, int y)
	Returns the component at a certain point within this one.

Component *	getComponentAt (const 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)
	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.

ImageEffectFilter *	getComponentEffect () const noexcept
	Returns the current component effect.

LookAndFeel &	getLookAndFeel () 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 KeyboardFocusTraverser *	createFocusTraverser ()
	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.

virtual void	enablementChanged ()
	Callback to indicate that this component has been enabled or disabled.

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	mouseDoubleClick (const MouseEvent &event)
	Called when a mouse button has been double-clicked on a component.

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	keyPressed (const KeyPress &key)
	Called when a key is pressed.

virtual void	modifierKeysChanged (const ModifierKeys &modifiers)
	Called when a modifier key is pressed or released.

virtual void	focusGained (FocusChangeType cause)
	Called to indicate that this component has just acquired the keyboard focus.

virtual void	focusOfChildComponentChanged (FocusChangeType cause)
	Called to indicate that one of this component's children has been focused or unfocused.

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	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.

virtual void	handleCommandMessage (int commandId)
	Called to handle a command that was sent by postCommandMessage().

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.

NamedValueSet &	getProperties () noexcept
	Returns the set of properties that belong to this component.

const NamedValueSet &	getProperties () 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, const Colour &colour)
	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 MarkerList *	getMarkers (bool xAxis)
	Components can implement this method to provide a MarkerList.

void *	getWindowHandle () const
	Returns the underlying native window handle for this component.

Positioner *	getPositioner () 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.

CachedComponentImage *	getCachedComponentImage () const noexcept
	Returns the object that was set by setCachedComponentImage().

Public Member Functions inherited from MouseListener
virtual	~MouseListener ()
	Destructor.

Public Member Functions inherited from MidiKeyboardStateListener
	MidiKeyboardStateListener () noexcept

virtual	~MidiKeyboardStateListener ()

Public Member Functions inherited from ChangeBroadcaster
	ChangeBroadcaster () noexcept
	Creates an ChangeBroadcaster.

virtual	~ChangeBroadcaster ()
	Destructor.

void	addChangeListener (ChangeListener *listener)
	Registers a listener to receive change callbacks from this broadcaster.

void	removeChangeListener (ChangeListener *listener)
	Unregisters a listener from the list.

void	removeAllChangeListeners ()
	Removes all listeners from the list.

void	sendChangeMessage ()
	Causes an asynchronous change message to be sent to all the registered listeners.

void	sendSynchronousChangeMessage ()
	Sends a synchronous change message to all the registered listeners.

void	dispatchPendingMessages ()
	If a change message has been sent but not yet dispatched, this will call sendSynchronousChangeMessage() to make the callback immediately.

Protected Member Functions
virtual void	drawWhiteNote (int midiNoteNumber, Graphics &g, int x, int y, int w, int h, bool isDown, bool isOver, const Colour &lineColour, const Colour &textColour)
	Draws a white note in the given rectangle.

virtual void	drawBlackNote (int midiNoteNumber, Graphics &g, int x, int y, int w, int h, bool isDown, bool isOver, const Colour &noteFillColour)
	Draws a black note in the given rectangle.

virtual String	getWhiteNoteText (const int midiNoteNumber)
	Allows text to be drawn on the white notes.

virtual void	drawUpDownButton (Graphics &g, int w, int h, const bool isMouseOver, const bool isButtonPressed, const bool movesOctavesUp)
	Draws the up and down buttons that change the base note.

virtual bool	mouseDownOnKey (int midiNoteNumber, const MouseEvent &e)
	Callback when the mouse is clicked on a key.

virtual void	mouseDraggedToKey (int midiNoteNumber, const MouseEvent &e)
	Callback when the mouse is dragged from one key onto another.

virtual void	getKeyPosition (int midiNoteNumber, float keyWidth, int &x, int &w) const
	Calculates the positon of a given midi-note.

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	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.

Private Member Functions inherited from Timer
virtual	~Timer ()
	Destructor.

void	startTimer (int intervalInMilliseconds) noexcept
	Starts the timer and sets the length of interval required.

void	stopTimer () noexcept
	Stops the timer.

bool	isTimerRunning () const noexcept
	Checks if the timer has been started.

int	getTimerInterval () const noexcept
	Returns the timer's interval.

	Timer () noexcept
	Creates a Timer.

	Timer (const Timer &other) noexcept
	Creates a copy of another timer.

Static Private Member Functions inherited from Timer
static void JUCE_CALLTYPE	callPendingTimersSynchronously ()
	For internal use only: invokes any timers that need callbacks.

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 querty 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

enum MidiKeyboardComponent::Orientation

The direction of the keyboard.

See Also: setOrientation

Enumerator:

horizontalKeyboard
verticalKeyboardFacingLeft
verticalKeyboardFacingRight

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

Constructor & Destructor Documentation

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 horizonal or vertical

MidiKeyboardComponent::~MidiKeyboardComponent ( )

Destructor.

Member Function Documentation

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

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

int MidiKeyboardComponent::getMidiChannel ( ) const

noexcept

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

See Also: setMidiChannel

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

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().

void MidiKeyboardComponent::setKeyWidth ( float widthInPixels )

Changes the width used to draw the white keys.

float MidiKeyboardComponent::getKeyWidth ( ) const

noexcept

Returns the width that was set by setKeyWidth().

void MidiKeyboardComponent::setOrientation ( Orientation newOrientation )

Changes the keyboard's current direction.

Orientation MidiKeyboardComponent::getOrientation ( ) const

noexcept

Returns the keyboard's current direction.

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.

int MidiKeyboardComponent::getRangeStart ( ) const

noexcept

Returns the first note in the available range.

See Also: setAvailableRange

int MidiKeyboardComponent::getRangeEnd ( ) const

noexcept

Returns the last note in the available range.

See Also: setAvailableRange

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.

int MidiKeyboardComponent::getLowestVisibleKey ( ) const

noexcept

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

See Also: setLowestVisibleKey

int MidiKeyboardComponent::getBlackNoteLength ( ) const

noexcept

Returns the length of the black notes.

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

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.

int MidiKeyboardComponent::getKeyStartPosition ( const 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.

void MidiKeyboardComponent::clearKeyMappings ( )

Deletes all key-mappings.

See Also: 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()

void MidiKeyboardComponent::removeKeyPressForNote ( int midiNoteOffsetFromC )

Removes any key-mappings for a given note.

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

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.

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

int MidiKeyboardComponent::getOctaveForMiddleC ( ) const

noexcept

This returns the value set by setOctaveForMiddleC().

See Also: setOctaveForMiddleC

void MidiKeyboardComponent::paint ( Graphics & )

virtual

Reimplemented from Component.

void MidiKeyboardComponent::resized ( )

virtual

Reimplemented from Component.

void MidiKeyboardComponent::mouseMove ( const MouseEvent & )

virtual

Reimplemented from Component.

void MidiKeyboardComponent::mouseDrag ( const MouseEvent & )

virtual

Reimplemented from Component.

void MidiKeyboardComponent::mouseDown ( const MouseEvent & )

virtual

Reimplemented from Component.

void MidiKeyboardComponent::mouseUp ( const MouseEvent & )

virtual

Reimplemented from Component.

void MidiKeyboardComponent::mouseEnter ( const MouseEvent & )

virtual

Reimplemented from Component.

void MidiKeyboardComponent::mouseExit ( const MouseEvent & )

virtual

Reimplemented from Component.

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

virtual

Reimplemented from Component.

void MidiKeyboardComponent::timerCallback ( )

virtual

Implements Timer.

bool MidiKeyboardComponent::keyStateChanged ( bool isKeyDown )

virtual

Reimplemented from Component.

void MidiKeyboardComponent::focusLost ( FocusChangeType )

virtual

Reimplemented from Component.

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

virtual

Implements MidiKeyboardStateListener.

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

virtual

Implements MidiKeyboardStateListener.

void MidiKeyboardComponent::colourChanged ( )

virtual

Reimplemented from Component.

virtual void MidiKeyboardComponent::drawWhiteNote	(	int	midiNoteNumber,
		Graphics &	g,
		int	x,
		int	y,
		int	w,
		int	h,
		bool	isDown,
		bool	isOver,
		const Colour &	lineColour,
		const Colour &	textColour
	)

protectedvirtual

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.

virtual void MidiKeyboardComponent::drawBlackNote	(	int	midiNoteNumber,
		Graphics &	g,
		int	x,
		int	y,
		int	w,
		int	h,
		bool	isDown,
		bool	isOver,
		const Colour &	noteFillColour
	)

protectedvirtual

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.

virtual String MidiKeyboardComponent::getWhiteNoteText ( const int midiNoteNumber )

protectedvirtual

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

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

protectedvirtual

Draws the up and down buttons that change the base note.

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

protectedvirtual

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

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

protectedvirtual

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

See Also: mouseDownOnKey

virtual void MidiKeyboardComponent::getKeyPosition	(	int	midiNoteNumber,
		float	keyWidth,
		int &	x,
		int &	w
	)		const

protectedvirtual

Calculates the positon 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()
x	the x position of the left-hand edge of the key (this method always works in terms of a horizontal keyboard)
w	the width of the key

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

juce_MidiKeyboardComponent.h

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation