ComponentDragger Class Reference

An object to take care of the logic for dragging components around with the mouse. More...

Public Member Functions

 ComponentDragger ()
 Creates a ComponentDragger. More...
 
virtual ~ComponentDragger ()
 Destructor. More...
 
void startDraggingComponent (Component *componentToDrag, const MouseEvent &e)
 Call this from your component's mouseDown() method, to prepare for dragging. More...
 
void dragComponent (Component *componentToDrag, const MouseEvent &e, ComponentBoundsConstrainer *constrainer)
 Call this from your mouseDrag() callback to move the component. More...
 

Detailed Description

An object to take care of the logic for dragging components around with the mouse.

Very easy to use - in your mouseDown() callback, call startDraggingComponent(), then in your mouseDrag() callback, call dragComponent().

When starting a drag, you can give it a ComponentBoundsConstrainer to use to limit the component's position and keep it on-screen.

e.g.

class MyDraggableComp
{
ComponentDragger myDragger;
void mouseDown (const MouseEvent& e)
{
myDragger.startDraggingComponent (this, e);
}
void mouseDrag (const MouseEvent& e)
{
myDragger.dragComponent (this, e, nullptr);
}
};

Constructor & Destructor Documentation

◆ ComponentDragger()

ComponentDragger::ComponentDragger ( )

Creates a ComponentDragger.

◆ ~ComponentDragger()

virtual ComponentDragger::~ComponentDragger ( )
virtual

Destructor.

Member Function Documentation

◆ startDraggingComponent()

void ComponentDragger::startDraggingComponent ( Component componentToDrag,
const MouseEvent e 
)

Call this from your component's mouseDown() method, to prepare for dragging.

Parameters
componentToDragthe component that you want to drag
ethe mouse event that is triggering the drag
See also
dragComponent

◆ dragComponent()

void ComponentDragger::dragComponent ( Component componentToDrag,
const MouseEvent e,
ComponentBoundsConstrainer constrainer 
)

Call this from your mouseDrag() callback to move the component.

This will move the component, using the given constrainer object to check the new position.

Parameters
componentToDragthe component that you want to drag
ethe current mouse-drag event
constraineran optional constrainer object that should be used to apply limits to the component's position. Pass null if you don't want to contrain the movement.
See also
startDraggingComponent

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