A MouseListener can be registered with a component to receive callbacks about mouse events that happen to that component. More...

Inheritance diagram for MouseListener:

Public Member Functions

virtual ~MouseListener ()
 Destructor. More...
 
virtual void mouseMove (const MouseEvent &event)
 Called when the mouse moves inside a component. More...
 
virtual void mouseEnter (const MouseEvent &event)
 Called when the mouse first enters a component. More...
 
virtual void mouseExit (const MouseEvent &event)
 Called when the mouse moves out of a component. More...
 
virtual void mouseDown (const MouseEvent &event)
 Called when a mouse button is pressed. More...
 
virtual void mouseDrag (const MouseEvent &event)
 Called when the mouse is moved while a button is held down. More...
 
virtual void mouseUp (const MouseEvent &event)
 Called when a mouse button is released. More...
 
virtual void mouseDoubleClick (const MouseEvent &event)
 Called when a mouse button has been double-clicked on a component. More...
 
virtual void mouseWheelMove (const MouseEvent &event, const MouseWheelDetails &wheel)
 Called when the mouse-wheel is moved. More...
 

Detailed Description

A MouseListener can be registered with a component to receive callbacks about mouse events that happen to that component.

See also
Component::addMouseListener, Component::removeMouseListener

Constructor & Destructor Documentation

◆ ~MouseListener()

virtual MouseListener::~MouseListener ( )
virtual

Destructor.

Member Function Documentation

◆ mouseMove()

virtual void MouseListener::mouseMove ( const MouseEvent event)
virtual

Called when the mouse moves inside a component.

If the mouse button isn't pressed and the mouse moves over a component, this will be called to let the component react to this.

A component will always get a mouseEnter callback before a mouseMove.

Parameters
eventdetails about the position and status of the mouse event, including the source component in which it occurred
See also
mouseEnter, mouseExit, mouseDrag, contains

Reimplemented in Component, Slider, TableHeaderComponent, MidiKeyboardComponent, ResizableBorderComponent, and MenuBarComponent.

Referenced by Component::getComponentEffect().

◆ mouseEnter()

virtual void MouseListener::mouseEnter ( const MouseEvent event)
virtual

Called when the mouse first enters a component.

If the mouse button isn't pressed and the mouse moves into a component, this will be called to let the component react to this.

When the mouse button is pressed and held down while being moved in or out of a component, no mouseEnter or mouseExit callbacks are made - only mouseDrag messages are sent to the component that the mouse was originally clicked on, until the button is released.

Parameters
eventdetails about the position and status of the mouse event, including the source component in which it occurred
See also
mouseExit, mouseDrag, mouseMove, contains

Reimplemented in Component, Slider, Button, TableHeaderComponent, MidiKeyboardComponent, ResizableBorderComponent, and MenuBarComponent.

Referenced by Component::getComponentEffect().

◆ mouseExit()

virtual void MouseListener::mouseExit ( const MouseEvent event)
virtual

Called when the mouse moves out of a component.

This will be called when the mouse moves off the edge of this component.

If the mouse button was pressed, and it was then dragged off the edge of the component and released, then this callback will happen when the button is released, after the mouseUp callback.

Parameters
eventdetails about the position and status of the mouse event, including the source component in which it occurred
See also
mouseEnter, mouseDrag, mouseMove, contains

Reimplemented in Component, Slider, Button, TableHeaderComponent, MidiKeyboardComponent, and MenuBarComponent.

Referenced by Component::getComponentEffect().

◆ mouseDown()

virtual void MouseListener::mouseDown ( const MouseEvent event)
virtual

Called when a mouse button is pressed.

The MouseEvent object passed in contains lots of methods for finding out which button was pressed, as well as which modifier keys (e.g. shift, ctrl) were held down at the time.

Once a button is held down, the mouseDrag method will be called when the mouse moves, until the button is released.

Parameters
eventdetails about the position and status of the mouse event, including the source component in which it occurred
See also
mouseUp, mouseDrag, mouseDoubleClick, contains

Reimplemented in Component, Slider, TextEditor, AlertWindow, Button, TableHeaderComponent, ComboBox, ScrollBar, ResizableWindow, CodeEditorComponent, Toolbar, MidiKeyboardComponent, ResizableBorderComponent, StretchableLayoutResizerBar, ResizableEdgeComponent, MenuBarComponent, and ResizableCornerComponent.

Referenced by Component::getComponentEffect().

◆ mouseDrag()

virtual void MouseListener::mouseDrag ( const MouseEvent event)
virtual

Called when the mouse is moved while a button is held down.

When a mouse button is pressed inside a component, that component receives mouseDrag callbacks each time the mouse moves, even if the mouse strays outside the component's bounds.

Parameters
eventdetails about the position and status of the mouse event, including the source component in which it occurred
See also
mouseDown, mouseUp, mouseMove, contains, setDragRepeatInterval

Reimplemented in Component, Slider, TextEditor, AlertWindow, Button, TableHeaderComponent, ComboBox, ScrollBar, ResizableWindow, CodeEditorComponent, MidiKeyboardComponent, ResizableBorderComponent, StretchableLayoutResizerBar, ResizableEdgeComponent, MenuBarComponent, and ResizableCornerComponent.

Referenced by Component::getComponentEffect().

◆ mouseUp()

virtual void MouseListener::mouseUp ( const MouseEvent event)
virtual

Called when a mouse button is released.

A mouseUp callback is sent to the component in which a button was pressed even if the mouse is actually over a different component when the button is released.

The MouseEvent object passed in contains lots of methods for finding out which buttons were down just before they were released.

Parameters
eventdetails about the position and status of the mouse event, including the source component in which it occurred
See also
mouseDown, mouseDrag, mouseDoubleClick, contains

Reimplemented in Component, Slider, TextEditor, ListBox, Button, TableHeaderComponent, ComboBox, ScrollBar, ResizableWindow, CodeEditorComponent, Label, MidiKeyboardComponent, ResizableBorderComponent, ResizableEdgeComponent, MenuBarComponent, and ResizableCornerComponent.

Referenced by Component::getComponentEffect().

◆ mouseDoubleClick()

virtual void MouseListener::mouseDoubleClick ( const MouseEvent event)
virtual

Called when a mouse button has been double-clicked on a component.

The MouseEvent object passed in contains lots of methods for finding out which button was pressed, as well as which modifier keys (e.g. shift, ctrl) were held down at the time.

Parameters
eventdetails about the position and status of the mouse event, including the source component in which it occurred
See also
mouseDown, mouseUp

Reimplemented in Component, Slider, TextEditor, CodeEditorComponent, and Label.

Referenced by Component::getComponentEffect().

◆ mouseWheelMove()

virtual void MouseListener::mouseWheelMove ( const MouseEvent event,
const MouseWheelDetails wheel 
)
virtual

Called when the mouse-wheel is moved.

This callback is sent to the component that the mouse is over when the wheel is moved.

If not overridden, a component will forward this message to its parent, so that parent components can collect mouse-wheel messages that happen to child components which aren't interested in them.

Parameters
eventdetails about the mouse event
wheeldetails about the wheel movement

Reimplemented in Component, Slider, TextEditor, ListBox, ComboBox, ScrollBar, CodeEditorComponent, MidiKeyboardComponent, and Viewport.

Referenced by Component::getComponentEffect().


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