Struct DragSource 

pub struct DragSource {
    pub payload: MimePayload,
    pub effects: DropEffectSet,
}

Marker / data component for an entity that can be the source of a drag-and-drop. Authored by the markup layer (<draggable mime=...> follow-up) or imperatively by the app.

The payload is built eagerly - for lazy construction (GTK DragSource::prepare), wrap a closure inside a Custom blob and resolve at drag-start time. v1 ships eager.

Fields

payload: MimePayload

The payload exported when a drag begins on this entity.

effects: DropEffectSet

Allowed effects. v1 only carries the data - backends choose the cursor.

Implementations

impl DragSource

pub fn new(payload: impl Into<MimePayload>) -> Self

Construct a drag source from any value convertible into a MimePayload.

pub fn with_effects(self, effects: DropEffectSet) -> Self

Builder: limit the effects this source advertises.

Trait Implementations

impl Clone for DragSource

fn clone(&self) -> DragSource

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Component for DragSource

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have [Component<Mutability = Mutable>], while immutable components will instead have [Component<Mutability = Immutable>].

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn relationship_accessor() -> Option<ComponentRelationshipAccessor<Self>>

Returns [ComponentRelationshipAccessor] required for working with relationships in dynamic contexts.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add [ComponentHook] for this [Component] if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert [ComponentHook] for this [Component] if one is defined.

fn on_discard() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_discard [ComponentHook] for this [Component] if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove [ComponentHook] for this [Component] if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn [ComponentHook] for this [Component] if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given [EntityMapper]. This is used to remap entities in contexts like scenes and entity cloning. When deriving [Component], this is populated by annotating fields containing entities with #[entities]

impl Debug for DragSource

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.