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

#include "juce_ComponentDragger.h"

Public Member Functions
	ComponentDragger ()
	Creates a ComponentDragger.

virtual	~ComponentDragger ()
	Destructor.

void	startDraggingComponent (Component *componentToDrag, const MouseEvent &e)
	Call this from your component's mouseDown() method, to prepare for dragging.

void	dragComponent (Component componentToDrag, const MouseEvent &e, ComponentBoundsConstrainer constrainer)
	Call this from your mouseDrag() callback to move the component.

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);
    }
};

@tags{GUI}

Definition at line 58 of file juce_ComponentDragger.h.

Constructor & Destructor Documentation

◆ ComponentDragger()

juce::ComponentDragger::ComponentDragger ( )

Creates a ComponentDragger.

Definition at line 29 of file juce_ComponentDragger.cpp.

◆ ~ComponentDragger()

juce::ComponentDragger::~ComponentDragger ( )

virtual

Destructor.

Definition at line 30 of file juce_ComponentDragger.cpp.

Member Function Documentation

◆ dragComponent()

void juce::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

componentToDrag	the component that you want to drag
e	the current mouse-drag event
constrainer	an optional constrainer object that should be used to apply limits to the component's position. Pass null if you don't want to constrain the movement.

See also: startDraggingComponent

Definition at line 42 of file juce_ComponentDragger.cpp.

◆ startDraggingComponent()

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

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