GI.Gtk.Declarative.EventSource

Event handling for declarative widgets.

Documentation

class EventSource widget where

An EventSource can be subscribed to, with a callback, returning a Subscription.

Methods

subscribe

Arguments

:: widget event

Declarative widget with event handlers.

-> SomeState

State of rendered widget tree.

-> (event -> IO ())

Event callback, invoked on each emitted event until the Subscription is cancelled, or widget is otherwise destroyed.

-> IO Subscription

A Subscription is returned, which can be cancelled.

Instances

EventSource Widget

Defined in GI.Gtk.Declarative.Widget

Methods

subscribe :: Widget event -> SomeState -> (event -> IO ()) -> IO Subscription

EventSource BoxChild

Defined in GI.Gtk.Declarative.Container.Box

Methods

subscribe :: BoxChild event -> SomeState -> (event -> IO ()) -> IO Subscription

EventSource Pane

Defined in GI.Gtk.Declarative.Container.Paned

Methods

subscribe :: Pane event -> SomeState -> (event -> IO ()) -> IO Subscription

EventSource MenuItem

Defined in GI.Gtk.Declarative.Container.MenuItem

Methods

subscribe :: MenuItem event -> SomeState -> (event -> IO ()) -> IO Subscription

EventSource (SingleWidget widget)

Defined in GI.Gtk.Declarative.SingleWidget

Methods

subscribe :: SingleWidget widget event -> SomeState -> (event -> IO ()) -> IO Subscription

IsBin parent => EventSource (Bin parent)

Defined in GI.Gtk.Declarative.Bin

Methods

subscribe :: Bin parent event -> SomeState -> (event -> IO ()) -> IO Subscription

(Typeable child, EventSource child) => EventSource (Container widget (Children child))

Defined in GI.Gtk.Declarative.Container

Methods

subscribe :: Container widget (Children child) event -> SomeState -> (event -> IO ()) -> IO Subscription

(Typeable internalState, GObject widget) => EventSource (CustomWidget widget params internalState)

Defined in GI.Gtk.Declarative.CustomWidget

Methods

subscribe :: CustomWidget widget params internalState event -> SomeState -> (event -> IO ()) -> IO Subscription

data Subscription

A Subscription contains zero or more cancellation actions for connected handlers (to a tree of widgets.) When subscribing to a container widget, all child widgets are also subscribed to, and the Subscriptions are combined using the Semigroup instance.

Instances

Semigroup Subscription

Defined in GI.Gtk.Declarative.EventSource

Methods

(<>) :: Subscription -> Subscription -> Subscription

sconcat :: NonEmpty Subscription -> Subscription

stimes :: Integral b => b -> Subscription -> Subscription

Monoid Subscription

Defined in GI.Gtk.Declarative.EventSource

Methods

mempty :: Subscription

mappend :: Subscription -> Subscription -> Subscription

mconcat :: [Subscription] -> Subscription

fromCancellation :: IO () -> Subscription

Create a subscription from a cancellation IO action.

cancel :: Subscription -> IO ()

Cancel a Subscription, meaning that the callback will not be invoked on any subsequent signal emissions.