Struct gtk4::DragSource

source ·
pub struct DragSource { /* private fields */ }
Expand description

DragSource is an event controller to initiate Drag-And-Drop operations.

DragSource can be set up with the necessary ingredients for a DND operation ahead of time. This includes the source for the data that is being transferred, in the form of a gdk::ContentProvider, the desired action, and the icon to use during the drag operation. After setting it up, the drag source must be added to a widget as an event controller, using WidgetExt::add_controller().

⚠️ The following code is in c ⚠️

static void
my_widget_init (MyWidget *self)
{
  GtkDragSource *drag_source = gtk_drag_source_new ();

  g_signal_connect (drag_source, "prepare", G_CALLBACK (on_drag_prepare), self);
  g_signal_connect (drag_source, "drag-begin", G_CALLBACK (on_drag_begin), self);

  gtk_widget_add_controller (GTK_WIDGET (self), GTK_EVENT_CONTROLLER (drag_source));
}

Setting up the content provider and icon ahead of time only makes sense when the data does not change. More commonly, you will want to set them up just in time. To do so, DragSource has prepare and drag-begin signals.

The ::prepare signal is emitted before a drag is started, and can be used to set the content provider and actions that the drag should be started with.

⚠️ The following code is in c ⚠️

static GdkContentProvider *
on_drag_prepare (GtkDragSource *source,
                 double         x,
                 double         y,
                 MyWidget      *self)
{
  // This widget supports two types of content: GFile objects
  // and GdkPixbuf objects; GTK will handle the serialization
  // of these types automatically
  GFile *file = my_widget_get_file (self);
  GdkPixbuf *pixbuf = my_widget_get_pixbuf (self);

  return gdk_content_provider_new_union ((GdkContentProvider *[2]) {
      gdk_content_provider_new_typed (G_TYPE_FILE, file),
      gdk_content_provider_new_typed (GDK_TYPE_PIXBUF, pixbuf),
    }, 2);
}

The ::drag-begin signal is emitted after the gdk::Drag object has been created, and can be used to set up the drag icon.

⚠️ The following code is in c ⚠️

static void
on_drag_begin (GtkDragSource *source,
               GdkDrag       *drag,
               MyWidget      *self)
{
  // Set the widget as the drag icon
  GdkPaintable *paintable = gtk_widget_paintable_new (GTK_WIDGET (self));
  gtk_drag_source_set_icon (source, paintable, 0, 0);
  g_object_unref (paintable);
}

During the DND operation, DragSource emits signals that can be used to obtain updates about the status of the operation, but it is not normally necessary to connect to any signals, except for one case: when the supported actions include gdk::DragAction::MOVE, you need to listen for the drag-end signal and delete the data after it has been transferred.

§Properties

§actions

The actions that are supported by drag operations from the source.

Note that you must handle the drag-end signal if the actions include gdk::DragAction::MOVE.

Readable | Writeable

§content

The data that is offered by drag operations from this source.

Readable | Writeable

GestureSingle

§button

Mouse button number to listen to, or 0 to listen for any button.

Readable | Writeable

§exclusive

Whether the gesture is exclusive.

Exclusive gestures only listen to pointer and pointer emulated events.

Readable | Writeable

§touch-only

Whether the gesture handles only touch events.

Readable | Writeable

Gesture

§n-points

The number of touch points that trigger recognition on this gesture.

Readable | Writeable | Construct Only

EventController

§name

The name for this controller, typically used for debugging purposes.

Readable | Writeable

§propagation-limit

The limit for which events this controller will handle.

Readable | Writeable

§propagation-phase

The propagation phase at which this controller will handle events.

Readable | Writeable

§widget

The widget receiving the GdkEvents that the controller will handle.

Readable

§Signals

§drag-begin

Emitted on the drag source when a drag is started.

It can be used to e.g. set a custom drag icon with DragSource::set_icon().

§drag-cancel

Emitted on the drag source when a drag has failed.

The signal handler may handle a failed drag operation based on the type of error. It should return true if the failure has been handled and the default “drag operation failed” animation should not be shown.

§drag-end

Emitted on the drag source when a drag is finished.

A typical reason to connect to this signal is to undo things done in prepare or drag-begin handlers.

§prepare

Emitted when a drag is about to be initiated.

It returns the gdk::ContentProvider to use for the drag that is about to start. The default handler for this signal returns the value of the content property, so if you set up that property ahead of time, you don’t need to connect to this signal.

Gesture

§begin

Emitted when the gesture is recognized.

This means the number of touch sequences matches n-points.

Note: These conditions may also happen when an extra touch (eg. a third touch on a 2-touches gesture) is lifted, in that situation @sequence won’t pertain to the current set of active touches, so don’t rely on this being true.

§cancel

Emitted whenever a sequence is cancelled.

This usually happens on active touches when EventControllerExt::reset() is called on @gesture (manually, due to grabs…), or the individual @sequence was claimed by parent widgets’ controllers (see GestureExt::set_sequence_state()).

@gesture must forget everything about @sequence as in response to this signal.

§end

Emitted when @gesture either stopped recognizing the event sequences as something to be handled, or the number of touch sequences became higher or lower than n-points.

Note: @sequence might not pertain to the group of sequences that were previously triggering recognition on @gesture (ie. a just pressed touch sequence that exceeds n-points). This situation may be detected by checking through GestureExt::handles_sequence().

§sequence-state-changed

Emitted whenever a sequence state changes.

See GestureExt::set_sequence_state() to know more about the expectable sequence lifetimes.

§update

Emitted whenever an event is handled while the gesture is recognized.

@sequence is guaranteed to pertain to the set of active touches.

§Implements

GestureSingleExt, GestureExt, EventControllerExt, [trait@glib::ObjectExt]

Implementations§

source§

impl DragSource

source

pub fn new() -> DragSource

Creates a new DragSource object.

§Returns

the new DragSource

source

pub fn builder() -> DragSourceBuilder

Creates a new builder-pattern struct instance to construct DragSource objects.

This method returns an instance of DragSourceBuilder which can be used to create DragSource objects.

source

pub fn drag_cancel(&self)

Cancels a currently ongoing drag operation.

source

pub fn actions(&self) -> DragAction

Gets the actions that are currently set on the DragSource.

§Returns

the actions set on @self

source

pub fn content(&self) -> Option<ContentProvider>

Gets the current content provider of a DragSource.

§Returns

the gdk::ContentProvider of @self

source

pub fn drag(&self) -> Option<Drag>

Returns the underlying gdk::Drag object for an ongoing drag.

§Returns

the gdk::Drag of the current drag operation

source

pub fn set_actions(&self, actions: DragAction)

Sets the actions on the DragSource.

During a DND operation, the actions are offered to potential drop targets. If @actions include gdk::DragAction::MOVE, you need to listen to the drag-end signal and handle @delete_data being true.

This function can be called before a drag is started, or in a handler for the prepare signal.

§actions

the actions to offer

source

pub fn set_content(&self, content: Option<&impl IsA<ContentProvider>>)

Sets a content provider on a DragSource.

When the data is requested in the cause of a DND operation, it will be obtained from the content provider.

This function can be called before a drag is started, or in a handler for the prepare signal.

You may consider setting the content provider back to None in a drag-end signal handler.

§content

a gdk::ContentProvider

source

pub fn set_icon( &self, paintable: Option<&impl IsA<Paintable>>, hot_x: i32, hot_y: i32 )

Sets a paintable to use as icon during DND operations.

The hotspot coordinates determine the point on the icon that gets aligned with the hotspot of the cursor.

If @paintable is None, a default icon is used.

This function can be called before a drag is started, or in a prepare or drag-begin signal handler.

§paintable

the gdk::Paintable to use as icon

§hot_x

the hotspot X coordinate on the icon

§hot_y

the hotspot Y coordinate on the icon

source

pub fn connect_drag_begin<F: Fn(&Self, &Drag) + 'static>( &self, f: F ) -> SignalHandlerId

Emitted on the drag source when a drag is started.

It can be used to e.g. set a custom drag icon with set_icon().

§drag

the gdk::Drag object

source

pub fn connect_drag_cancel<F: Fn(&Self, &Drag, DragCancelReason) -> bool + 'static>( &self, f: F ) -> SignalHandlerId

Emitted on the drag source when a drag has failed.

The signal handler may handle a failed drag operation based on the type of error. It should return true if the failure has been handled and the default “drag operation failed” animation should not be shown.

§drag

the gdk::Drag object

§reason

information on why the drag failed

§Returns

true if the failed drag operation has been already handled

source

pub fn connect_drag_end<F: Fn(&Self, &Drag, bool) + 'static>( &self, f: F ) -> SignalHandlerId

Emitted on the drag source when a drag is finished.

A typical reason to connect to this signal is to undo things done in prepare or drag-begin handlers.

§drag

the gdk::Drag object

§delete_data

true if the drag was performing gdk::DragAction::MOVE, and the data should be deleted

source

pub fn connect_prepare<F: Fn(&Self, f64, f64) -> Option<ContentProvider> + 'static>( &self, f: F ) -> SignalHandlerId

Emitted when a drag is about to be initiated.

It returns the gdk::ContentProvider to use for the drag that is about to start. The default handler for this signal returns the value of the content property, so if you set up that property ahead of time, you don’t need to connect to this signal.

§x

the X coordinate of the drag starting point

§y

the Y coordinate of the drag starting point

§Returns

a gdk::ContentProvider

source

pub fn connect_actions_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source

pub fn connect_content_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Trait Implementations§

source§

impl Clone for DragSource

source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for DragSource

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for DragSource

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl HasParamSpec for DragSource

§

type ParamSpec = ParamSpecObject

§

type SetValue = DragSource

Preferred value to be used as setter for the associated ParamSpec.
§

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, DragSource>

source§

fn param_spec_builder() -> Self::BuilderFn

source§

impl Hash for DragSource

source§

fn hash<H>(&self, state: &mut H)
where H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl Ord for DragSource

source§

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl ParentClassIs for DragSource

source§

impl<OT: ObjectType> PartialEq<OT> for DragSource

source§

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<OT: ObjectType> PartialOrd<OT> for DragSource

source§

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl StaticType for DragSource

source§

fn static_type() -> Type

Returns the type identifier of Self.
source§

impl Eq for DragSource

source§

impl IsA<EventController> for DragSource

source§

impl IsA<Gesture> for DragSource

source§

impl IsA<GestureSingle> for DragSource

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> Cast for T
where T: ObjectType,

source§

fn upcast<T>(self) -> T
where T: ObjectType, Self: IsA<T>,

Upcasts an object to a superclass or interface T. Read more
source§

fn upcast_ref<T>(&self) -> &T
where T: ObjectType, Self: IsA<T>,

Upcasts an object to a reference of its superclass or interface T. Read more
source§

fn downcast<T>(self) -> Result<T, Self>
where T: ObjectType, Self: MayDowncastTo<T>,

Tries to downcast to a subclass or interface implementor T. Read more
source§

fn downcast_ref<T>(&self) -> Option<&T>
where T: ObjectType, Self: MayDowncastTo<T>,

Tries to downcast to a reference of its subclass or interface implementor T. Read more
source§

fn dynamic_cast<T>(self) -> Result<T, Self>
where T: ObjectType,

Tries to cast to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while upcast will do many checks at compile-time already. downcast will perform the same checks at runtime as dynamic_cast, but will also ensure some amount of compile-time safety. Read more
source§

fn dynamic_cast_ref<T>(&self) -> Option<&T>
where T: ObjectType,

Tries to cast to reference to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while downcast and upcast will do many checks at compile-time already. Read more
source§

unsafe fn unsafe_cast<T>(self) -> T
where T: ObjectType,

Casts to T unconditionally. Read more
source§

unsafe fn unsafe_cast_ref<T>(&self) -> &T
where T: ObjectType,

Casts to &T unconditionally. Read more
source§

impl<O> EventControllerExt for O
where O: IsA<EventController>,

source§

fn current_event(&self) -> Option<Event>

Returns the event that is currently being handled by the controller. Read more
source§

fn current_event_device(&self) -> Option<Device>

Returns the device of the event that is currently being handled by the controller. Read more
source§

fn current_event_state(&self) -> ModifierType

Returns the modifier state of the event that is currently being handled by the controller. Read more
source§

fn current_event_time(&self) -> u32

Returns the timestamp of the event that is currently being handled by the controller. Read more
source§

fn name(&self) -> Option<GString>

Gets the name of @self. Read more
source§

fn propagation_limit(&self) -> PropagationLimit

Gets the propagation limit of the event controller. Read more
source§

fn propagation_phase(&self) -> PropagationPhase

Gets the propagation phase at which @self handles events. Read more
source§

fn widget(&self) -> Widget

Returns the Widget this controller relates to. Read more
source§

fn reset(&self)

Resets the @self to a clean state.
source§

fn set_name(&self, name: Option<&str>)

Sets a name on the controller that can be used for debugging. Read more
source§

fn set_propagation_limit(&self, limit: PropagationLimit)

Sets the event propagation limit on the event controller. Read more
source§

fn set_propagation_phase(&self, phase: PropagationPhase)

Sets the propagation phase at which a controller handles events. Read more
source§

fn set_static_name(&self, name: Option<&str>)

Available on crate feature v4_8 only.
Sets a name on the controller that can be used for debugging. Read more
source§

fn connect_name_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId

source§

fn connect_propagation_limit_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source§

fn connect_propagation_phase_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source§

fn connect_widget_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId

source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *const GList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec(_: *const GList, _: usize) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(_: *const GList, _: usize) -> Vec<T>

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *const GPtrArray, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec( _: *const GPtrArray, _: usize ) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(_: *const GPtrArray, _: usize) -> Vec<T>

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *const GSList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec(_: *const GSList, _: usize) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(_: *const GSList, _: usize) -> Vec<T>

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *mut GList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec(ptr: *mut GList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(ptr: *mut GList, num: usize) -> Vec<T>

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *mut GPtrArray, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec( ptr: *mut GPtrArray, num: usize ) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(ptr: *mut GPtrArray, num: usize) -> Vec<T>

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *mut GSList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec(ptr: *mut GSList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(ptr: *mut GSList, num: usize) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *const GList) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(_: *const GList) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(_: *const GList) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *const GPtrArray) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(_: *const GPtrArray) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(_: *const GPtrArray) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *const GSList) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(_: *const GSList) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(_: *const GSList) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *mut GList) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(ptr: *mut GList) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(ptr: *mut GList) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *mut GPtrArray) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(ptr: *mut GPtrArray) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(ptr: *mut GPtrArray) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *mut GSList) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(ptr: *mut GSList) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(ptr: *mut GSList) -> Vec<T>

source§

impl<O> GObjectPropertyExpressionExt for O
where O: IsA<Object>,

source§

fn property_expression(&self, property_name: &str) -> PropertyExpression

Create an expression looking up an object’s property.
source§

fn property_expression_weak(&self, property_name: &str) -> PropertyExpression

Create an expression looking up an object’s property with a weak reference.
source§

fn this_expression(property_name: &str) -> PropertyExpression

Create an expression looking up a property in the bound this object.
source§

impl<O> GestureExt for O
where O: IsA<Gesture>,

source§

fn bounding_box(&self) -> Option<Rectangle>

If there are touch sequences being currently handled by @self, returns true and fills in @rect with the bounding box containing all active touches. Read more
source§

fn bounding_box_center(&self) -> Option<(f64, f64)>

If there are touch sequences being currently handled by @self, returns true and fills in @x and @y with the center of the bounding box containing all active touches. Read more
source§

fn device(&self) -> Option<Device>

Returns the logical gdk::Device that is currently operating on @self. Read more
source§

fn group(&self) -> Vec<Gesture>

Returns all gestures in the group of @self Read more
source§

fn last_event(&self, sequence: Option<&EventSequence>) -> Option<Event>

Returns the last event that was processed for @sequence. Read more
source§

fn last_updated_sequence(&self) -> Option<EventSequence>

Returns the gdk::EventSequence that was last updated on @self. Read more
source§

fn point(&self, sequence: Option<&EventSequence>) -> Option<(f64, f64)>

If @sequence is currently being interpreted by @self, returns true and fills in @x and @y with the last coordinates stored for that event sequence. Read more
source§

fn sequence_state(&self, sequence: &EventSequence) -> EventSequenceState

Returns the @sequence state, as seen by @self. Read more
source§

fn sequences(&self) -> Vec<EventSequence>

Returns the list of GdkEventSequences currently being interpreted by @self. Read more
source§

fn group_with(&self, gesture: &impl IsA<Gesture>)

Adds @gesture to the same group than @self. Read more
source§

fn handles_sequence(&self, sequence: Option<&EventSequence>) -> bool

Returns true if @self is currently handling events corresponding to @sequence. Read more
source§

fn is_active(&self) -> bool

Returns true if the gesture is currently active. Read more
source§

fn is_grouped_with(&self, other: &impl IsA<Gesture>) -> bool

Returns true if both gestures pertain to the same group. Read more
source§

fn is_recognized(&self) -> bool

Returns true if the gesture is currently recognized. Read more
source§

fn set_sequence_state( &self, sequence: &EventSequence, state: EventSequenceState ) -> bool

👎Deprecated: Since 4.10
Sets the state of @sequence in @self. Read more
source§

fn set_state(&self, state: EventSequenceState) -> bool

Sets the state of all sequences that @self is currently interacting with. Read more
source§

fn ungroup(&self)

Separates @self into an isolated group.
source§

fn n_points(&self) -> u32

The number of touch points that trigger recognition on this gesture.
source§

fn connect_begin<F: Fn(&Self, Option<&EventSequence>) + 'static>( &self, f: F ) -> SignalHandlerId

Emitted when the gesture is recognized. Read more
source§

fn connect_cancel<F: Fn(&Self, Option<&EventSequence>) + 'static>( &self, f: F ) -> SignalHandlerId

Emitted whenever a sequence is cancelled. Read more
source§

fn connect_end<F: Fn(&Self, Option<&EventSequence>) + 'static>( &self, f: F ) -> SignalHandlerId

Emitted when @gesture either stopped recognizing the event sequences as something to be handled, or the number of touch sequences became higher or lower than n-points. Read more
source§

fn connect_sequence_state_changed<F: Fn(&Self, Option<&EventSequence>, EventSequenceState) + 'static>( &self, f: F ) -> SignalHandlerId

Emitted whenever a sequence state changes. Read more
source§

fn connect_update<F: Fn(&Self, Option<&EventSequence>) + 'static>( &self, f: F ) -> SignalHandlerId

Emitted whenever an event is handled while the gesture is recognized. Read more
source§

impl<O> GestureSingleExt for O
where O: IsA<GestureSingle>,

source§

fn button(&self) -> u32

Returns the button number @self listens for. Read more
source§

fn current_button(&self) -> u32

Returns the button number currently interacting with @self, or 0 if there is none. Read more
source§

fn current_sequence(&self) -> Option<EventSequence>

Returns the event sequence currently interacting with @self. Read more
source§

fn is_exclusive(&self) -> bool

Gets whether a gesture is exclusive. Read more
source§

fn is_touch_only(&self) -> bool

Returns true if the gesture is only triggered by touch events. Read more
source§

fn set_button(&self, button: u32)

Sets the button number @self listens to. Read more
source§

fn set_exclusive(&self, exclusive: bool)

Sets whether @self is exclusive. Read more
source§

fn set_touch_only(&self, touch_only: bool)

Sets whether to handle only touch events. Read more
source§

fn connect_button_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId

source§

fn connect_exclusive_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source§

fn connect_touch_only_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoClosureReturnValue for T
where T: Into<Value>,

source§

impl<U> IsSubclassableExt for U

source§

impl<T> ObjectExt for T
where T: ObjectType,

source§

fn is<U>(&self) -> bool
where U: StaticType,

Returns true if the object is an instance of (can be cast to) T.
source§

fn type_(&self) -> Type

Returns the type of the object.
source§

fn object_class(&self) -> &Class<Object>

Returns the ObjectClass of the object. Read more
source§

fn class(&self) -> &Class<T>
where T: IsClass,

Returns the class of the object.
source§

fn class_of<U>(&self) -> Option<&Class<U>>
where U: IsClass,

Returns the class of the object in the given type T. Read more
source§

fn interface<U>(&self) -> Option<InterfaceRef<'_, U>>
where U: IsInterface,

Returns the interface T of the object. Read more
source§

fn set_property(&self, property_name: &str, value: impl Into<Value>)

Sets the property property_name of the object to value value. Read more
source§

fn set_property_from_value(&self, property_name: &str, value: &Value)

Sets the property property_name of the object to value value. Read more
source§

fn set_properties(&self, property_values: &[(&str, &dyn ToValue)])

Sets multiple properties of the object at once. Read more
source§

fn set_properties_from_value(&self, property_values: &[(&str, Value)])

Sets multiple properties of the object at once. Read more
source§

fn property<V>(&self, property_name: &str) -> V
where V: for<'b> FromValue<'b> + 'static,

Gets the property property_name of the object and cast it to the type V. Read more
source§

fn property_value(&self, property_name: &str) -> Value

Gets the property property_name of the object. Read more
source§

fn has_property(&self, property_name: &str, type_: Option<Type>) -> bool

Check if the object has a property property_name of the given type_. Read more
source§

fn property_type(&self, property_name: &str) -> Option<Type>

Get the type of the property property_name of this object. Read more
source§

fn find_property(&self, property_name: &str) -> Option<ParamSpec>

Get the ParamSpec of the property property_name of this object.
source§

fn list_properties(&self) -> PtrSlice<ParamSpec>

Return all ParamSpec of the properties of this object.
source§

fn freeze_notify(&self) -> PropertyNotificationFreezeGuard

Freeze all property notifications until the return guard object is dropped. Read more
source§

unsafe fn set_qdata<QD>(&self, key: Quark, value: QD)
where QD: 'static,

Set arbitrary data on this object with the given key. Read more
source§

unsafe fn qdata<QD>(&self, key: Quark) -> Option<NonNull<QD>>
where QD: 'static,

Return previously set arbitrary data of this object with the given key. Read more
source§

unsafe fn steal_qdata<QD>(&self, key: Quark) -> Option<QD>
where QD: 'static,

Retrieve previously set arbitrary data of this object with the given key. Read more
source§

unsafe fn set_data<QD>(&self, key: &str, value: QD)
where QD: 'static,

Set arbitrary data on this object with the given key. Read more
source§

unsafe fn data<QD>(&self, key: &str) -> Option<NonNull<QD>>
where QD: 'static,

Return previously set arbitrary data of this object with the given key. Read more
source§

unsafe fn steal_data<QD>(&self, key: &str) -> Option<QD>
where QD: 'static,

Retrieve previously set arbitrary data of this object with the given key. Read more
source§

fn block_signal(&self, handler_id: &SignalHandlerId)

Block a given signal handler. Read more
source§

fn unblock_signal(&self, handler_id: &SignalHandlerId)

Unblock a given signal handler.
source§

fn stop_signal_emission(&self, signal_id: SignalId, detail: Option<Quark>)

Stop emission of the currently emitted signal.
source§

fn stop_signal_emission_by_name(&self, signal_name: &str)

Stop emission of the currently emitted signal by the (possibly detailed) signal name.
source§

fn connect<F>( &self, signal_name: &str, after: bool, callback: F ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,

Connect to the signal signal_name on this object. Read more
source§

fn connect_id<F>( &self, signal_id: SignalId, details: Option<Quark>, after: bool, callback: F ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,

Connect to the signal signal_id on this object. Read more
source§

fn connect_local<F>( &self, signal_name: &str, after: bool, callback: F ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value> + 'static,

Connect to the signal signal_name on this object. Read more
source§

fn connect_local_id<F>( &self, signal_id: SignalId, details: Option<Quark>, after: bool, callback: F ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value> + 'static,

Connect to the signal signal_id on this object. Read more
source§

unsafe fn connect_unsafe<F>( &self, signal_name: &str, after: bool, callback: F ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value>,

Connect to the signal signal_name on this object. Read more
source§

unsafe fn connect_unsafe_id<F>( &self, signal_id: SignalId, details: Option<Quark>, after: bool, callback: F ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value>,

Connect to the signal signal_id on this object. Read more
source§

fn connect_closure( &self, signal_name: &str, after: bool, closure: RustClosure ) -> SignalHandlerId

Connect a closure to the signal signal_name on this object. Read more
source§

fn connect_closure_id( &self, signal_id: SignalId, details: Option<Quark>, after: bool, closure: RustClosure ) -> SignalHandlerId

Connect a closure to the signal signal_id on this object. Read more
source§

fn watch_closure(&self, closure: &impl AsRef<Closure>)

Limits the lifetime of closure to the lifetime of the object. When the object’s reference count drops to zero, the closure will be invalidated. An invalidated closure will ignore any calls to invoke_with_values, or invoke when using Rust closures.
source§

fn emit<R>(&self, signal_id: SignalId, args: &[&dyn ToValue]) -> R

Emit signal by signal id. Read more
source§

fn emit_with_values(&self, signal_id: SignalId, args: &[Value]) -> Option<Value>

Same as Self::emit but takes Value for the arguments.
source§

fn emit_by_name<R>(&self, signal_name: &str, args: &[&dyn ToValue]) -> R

Emit signal by its name. Read more
source§

fn emit_by_name_with_values( &self, signal_name: &str, args: &[Value] ) -> Option<Value>

Emit signal by its name. Read more
source§

fn emit_by_name_with_details<R>( &self, signal_name: &str, details: Quark, args: &[&dyn ToValue] ) -> R

Emit signal by its name with details. Read more
source§

fn emit_by_name_with_details_and_values( &self, signal_name: &str, details: Quark, args: &[Value] ) -> Option<Value>

Emit signal by its name with details. Read more
source§

fn emit_with_details<R>( &self, signal_id: SignalId, details: Quark, args: &[&dyn ToValue] ) -> R

Emit signal by signal id with details. Read more
source§

fn emit_with_details_and_values( &self, signal_id: SignalId, details: Quark, args: &[Value] ) -> Option<Value>

Emit signal by signal id with details. Read more
source§

fn disconnect(&self, handler_id: SignalHandlerId)

Disconnect a previously connected signal handler.
source§

fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId
where F: Fn(&T, &ParamSpec) + Send + Sync + 'static,

Connect to the notify signal of the object. Read more
source§

fn connect_notify_local<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId
where F: Fn(&T, &ParamSpec) + 'static,

Connect to the notify signal of the object. Read more
source§

unsafe fn connect_notify_unsafe<F>( &self, name: Option<&str>, f: F ) -> SignalHandlerId
where F: Fn(&T, &ParamSpec),

Connect to the notify signal of the object. Read more
source§

fn notify(&self, property_name: &str)

Notify that the given property has changed its value. Read more
source§

fn notify_by_pspec(&self, pspec: &ParamSpec)

Notify that the given property has changed its value. Read more
source§

fn downgrade(&self) -> WeakRef<T>

Downgrade this object to a weak reference.
source§

fn add_weak_ref_notify<F>(&self, f: F) -> WeakRefNotify<T>
where F: FnOnce() + Send + 'static,

Add a callback to be notified when the Object is disposed.
source§

fn add_weak_ref_notify_local<F>(&self, f: F) -> WeakRefNotify<T>
where F: FnOnce() + 'static,

Add a callback to be notified when the Object is disposed. Read more
source§

fn bind_property<'a, 'f, 't, O>( &'a self, source_property: &'a str, target: &'a O, target_property: &'a str ) -> BindingBuilder<'a, 'f, 't>
where O: ObjectType,

Bind property source_property on this object to the target_property on the target object. Read more
source§

fn ref_count(&self) -> u32

Returns the strong reference count of this object.
source§

unsafe fn run_dispose(&self)

Runs the dispose mechanism of the object. Read more
source§

impl<T> Property for T
where T: HasParamSpec,

§

type Value = T

source§

impl<T> PropertyGet for T
where T: HasParamSpec,

§

type Value = T

source§

fn get<R, F>(&self, f: F) -> R
where F: Fn(&<T as PropertyGet>::Value) -> R,

source§

impl<T> StaticTypeExt for T
where T: StaticType,

source§

fn ensure_type()

Ensures that the type has been registered with the type system.
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> TransparentType for T

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T> TryFromClosureReturnValue for T
where T: for<'a> FromValue<'a> + StaticType + 'static,

source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<'a, T, C, E> FromValueOptional<'a> for T
where T: FromValue<'a, Checker = C>, C: ValueTypeChecker<Error = ValueTypeMismatchOrNoneError<E>>, E: Error + Send + 'static,

source§

impl<Super, Sub> MayDowncastTo<Sub> for Super
where Super: IsA<Super>, Sub: IsA<Super>,