Interface

Shell-18 ▶ Shell ▶ EdgeDragGesture ▶ SignalSignatures

interface SignalSignatures {
    cancel: () => void;
    end: () => void;
    "may-recognize": () => boolean | void;
    notify: (arg0: GObject.ParamSpec) => void;
    "notify::actor": (pspec: GObject.ParamSpec) => void;
    "notify::enabled": (pspec: GObject.ParamSpec) => void;
    "notify::name": (pspec: GObject.ParamSpec) => void;
    "notify::side": (pspec: GObject.ParamSpec) => void;
    "notify::state": (pspec: GObject.ParamSpec) => void;
    progress: (arg0: number) => void;
    recognize: () => void;
    "should-handle-sequence": (arg0: Clutter.Event) => boolean | void;
    [key: `notify::${string}`]: (pspec: GObject.ParamSpec) => void;
}

Hierarchy (View Summary)

Indexable

Index

Properties

notify::actor notify::enabled notify::name notify::side notify::state progress

Properties - Inherited from Clutter

cancel end may-recognize notify recognize should-handle-sequence

Properties

"notify::actor": (pspec: GObject.ParamSpec) => void
"notify::enabled": (pspec: GObject.ParamSpec) => void
"notify::name": (pspec: GObject.ParamSpec) => void
"notify::side": (pspec: GObject.ParamSpec) => void
"notify::state": (pspec: GObject.ParamSpec) => void
progress: (arg0: number) => void

The ::progress signal is emitted when the edge drag has moved

Properties - Inherited from Clutter

cancel: () => void

The ::cancel signal is emitted when a continuous gesture got cancelled.

end: () => void

The ::end signal is emitted when a continuous gesture ends.

"may-recognize": () => boolean | void

The ::may-recognize signal is emitted if the gesture might become active and move to RECOGNIZING. Its purpose is to allow the implementation or a user of a gesture to prohibit the gesture from starting when needed.

notify: (arg0: GObject.ParamSpec) => void

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with GObject.ParamFlags.EXPLICIT_NOTIFY, then any call to g_object_set_property() results in ::notify being emitted, even if the new value is the same as the old. If they did pass GObject.ParamFlags.EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

g_signal_connect (text_view->buffer, "notify::paste-target-list",
                  G_CALLBACK (gtk_text_view_target_list_notify),
                  text_view)

It is important to note that you must use [canonical parameter names][class@GObject.ParamSpec#parameter-names] as detail strings for the notify signal.

recognize: () => void

The ::recognize signal is emitted when the gesture recognizes.

This is the signal gesture users are supposed to use for implementing actions on gesture recognize.

"should-handle-sequence": (arg0: Clutter.Event) => boolean | void

The ::should-handle-sequence signal is emitted when a sequence gets added to the gesture. Return false to make the gesture ignore the sequence of events.