VCV Rack API v2
Loading...
Searching...
No Matches
rack::widget::Widget::DragStartEvent Struct Reference

Occurs when a Widget begins being dragged. More...

#include <Widget.hpp>

Inheritance diagram for rack::widget::Widget::DragStartEvent:
[legend]
Collaboration diagram for rack::widget::Widget::DragStartEvent:
[legend]

Additional Inherited Members

- Public Member Functions inherited from rack::widget::BaseEvent
void stopPropagating () const
 Prevents the event from being handled by more Widgets.
 
bool isPropagating () const
 
void setTarget (Widget *w) const
 Tells the event handler that a particular Widget consumed the event.
 
WidgetgetTarget () const
 
void consume (Widget *w) const
 Sets the target Widget and stops propagating.
 
void unconsume () const
 
bool isConsumed () const
 
- Public Attributes inherited from rack::widget::Widget::DragBaseEvent
int button
 The mouse button held while dragging.
 
- Public Attributes inherited from rack::widget::BaseEvent
EventContextcontext = NULL
 

Detailed Description

Occurs when a Widget begins being dragged.

Must consume the Button event (on press) to receive this event. The target sets draggedWidget, which allows DragEnd, DragMove, DragHover, DragEnter, and DragDrop to occur.


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