GI.Clutter.Objects.DropAction

The DropAction structure contains only private data and should be accessed using the provided API.

Since: 1.8

Exported types

newtype DropAction

Memory-managed wrapper type.

Constructors

DropAction (ManagedPtr DropAction)

Instances

Eq DropAction

Defined in GI.Clutter.Objects.DropAction

Methods

(==) :: DropAction -> DropAction -> Bool

(/=) :: DropAction -> DropAction -> Bool

GObject DropAction

Defined in GI.Clutter.Objects.DropAction

ManagedPtrNewtype DropAction

Defined in GI.Clutter.Objects.DropAction

Methods

toManagedPtr :: DropAction -> ManagedPtr DropAction

TypedObject DropAction

Defined in GI.Clutter.Objects.DropAction

Methods

glibType :: IO GType

HasParentTypes DropAction

Defined in GI.Clutter.Objects.DropAction

IsGValue (Maybe DropAction)

Convert DropAction to and from GValue. See toGValue and fromGValue.

Defined in GI.Clutter.Objects.DropAction

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe DropAction -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe DropAction)

type ParentTypes DropAction

Defined in GI.Clutter.Objects.DropAction

type ParentTypes DropAction = '[Action, ActorMeta, Object]

class (GObject o, IsDescendantOf DropAction o) => IsDropAction o

Type class for types which can be safely cast to DropAction, for instance with toDropAction.

Instances

(GObject o, IsDescendantOf DropAction o) => IsDropAction o

Defined in GI.Clutter.Objects.DropAction

toDropAction :: (MonadIO m, IsDropAction o) => o -> m DropAction

Cast to DropAction, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getActor, getData, getEnabled, getName, getProperty, getQdata.

Setters

setData, setDataFull, setEnabled, setName, setProperty.

new

dropActionNew

Arguments

:: (HasCallStack, MonadIO m)

=> m DropAction

Returns: the newly created DropAction

Creates a new DropAction.

Use actorAddAction to add the action to a Actor.

Since: 1.8

Signals

canDrop

type DropActionCanDropCallback

Arguments

 = Actor

actor: the Actor attached to the action

-> Float

eventX: the X coordinate (in stage space) of the drop event

-> Float

eventY: the Y coordinate (in stage space) of the drop event

-> IO Bool

Returns: True if the drop is accepted, and False otherwise

The canDrop signal is emitted when the dragged actor is dropped on actor. The return value of the canDrop signal will determine whether or not the DropAction::drop signal is going to be emitted on action.

The default implementation of DropAction returns True for this signal.

Since: 1.8

afterDropActionCanDrop :: (IsDropAction a, MonadIO m) => a -> ((?self :: a) => DropActionCanDropCallback) -> m SignalHandlerId

Connect a signal handler for the canDrop signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after dropAction #canDrop callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onDropActionCanDrop :: (IsDropAction a, MonadIO m) => a -> ((?self :: a) => DropActionCanDropCallback) -> m SignalHandlerId

Connect a signal handler for the canDrop signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on dropAction #canDrop callback

drop

type DropActionDropCallback

Arguments

 = Actor

actor: the Actor attached to the action

-> Float

eventX: the X coordinate (in stage space) of the drop event

-> Float

eventY: the Y coordinate (in stage space) of the drop event

-> IO ()

The drop signal is emitted when the dragged actor is dropped on actor. This signal is only emitted if at least an handler of DropAction::canDrop returns True.

Since: 1.8

afterDropActionDrop :: (IsDropAction a, MonadIO m) => a -> ((?self :: a) => DropActionDropCallback) -> m SignalHandlerId

Connect a signal handler for the drop signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after dropAction #drop callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onDropActionDrop :: (IsDropAction a, MonadIO m) => a -> ((?self :: a) => DropActionDropCallback) -> m SignalHandlerId

Connect a signal handler for the drop signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on dropAction #drop callback

dropCancel

type DropActionDropCancelCallback

Arguments

 = Actor

actor: the Actor attached to the action

-> Float

eventX: the X coordinate (in stage space) of the drop event

-> Float

eventY: the Y coordinate (in stage space) of the drop event

-> IO ()

The dropCancel signal is emitted when the drop is refused by an emission of the DropAction::canDrop signal.

After the dropCancel signal is fired the active drag is terminated.

Since: 1.12

afterDropActionDropCancel :: (IsDropAction a, MonadIO m) => a -> ((?self :: a) => DropActionDropCancelCallback) -> m SignalHandlerId

Connect a signal handler for the dropCancel signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after dropAction #dropCancel callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onDropActionDropCancel :: (IsDropAction a, MonadIO m) => a -> ((?self :: a) => DropActionDropCancelCallback) -> m SignalHandlerId

Connect a signal handler for the dropCancel signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on dropAction #dropCancel callback

overIn

type DropActionOverInCallback

Arguments

 = Actor

actor: the Actor attached to the action

-> IO ()

The overIn signal is emitted when the dragged actor crosses into actor.

Since: 1.8

afterDropActionOverIn :: (IsDropAction a, MonadIO m) => a -> ((?self :: a) => DropActionOverInCallback) -> m SignalHandlerId

Connect a signal handler for the overIn signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after dropAction #overIn callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onDropActionOverIn :: (IsDropAction a, MonadIO m) => a -> ((?self :: a) => DropActionOverInCallback) -> m SignalHandlerId

Connect a signal handler for the overIn signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on dropAction #overIn callback

overOut

type DropActionOverOutCallback

Arguments

 = Actor

actor: the Actor attached to the action

-> IO ()

The overOut signal is emitted when the dragged actor crosses outside actor.

Since: 1.8

afterDropActionOverOut :: (IsDropAction a, MonadIO m) => a -> ((?self :: a) => DropActionOverOutCallback) -> m SignalHandlerId

Connect a signal handler for the overOut signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after dropAction #overOut callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onDropActionOverOut :: (IsDropAction a, MonadIO m) => a -> ((?self :: a) => DropActionOverOutCallback) -> m SignalHandlerId

Connect a signal handler for the overOut signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on dropAction #overOut callback