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

#include <juce_ComponentDragger.h>

Collaboration diagram for juce::ComponentDragger:

[legend]

Public Member Functions
	ComponentDragger ()
	Creates a ComponentDragger. More...

virtual	~ComponentDragger ()
	Destructor. More...

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

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

Private Attributes
Point< int >	mouseDownWithinTarget

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}

Constructor & Destructor Documentation

◆ ComponentDragger()

juce::ComponentDragger::ComponentDragger ( )

Creates a ComponentDragger.

◆ ~ComponentDragger()

virtual juce::ComponentDragger::~ComponentDragger ( )

virtual

Destructor.

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

◆ startDraggingComponent()

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

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

Parameters

componentToDrag	the component that you want to drag
e	the mouse event that is triggering the drag

See also: dragComponent

Member Data Documentation

◆ mouseDownWithinTarget

Point<int> juce::ComponentDragger::mouseDownWithinTarget

private

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

juce_ComponentDragger.h

Public Member Functions

Private Attributes