Struct gdk::Seat[−][src]

pub fn grab(
    &self, 
    window: &Window, 
    capabilities: SeatCapabilities, 
    owner_events: bool, 
    cursor: Option<&Cursor>, 
    event: Option<&Event>, 
    prepare_func: Option<&mut dyn FnMut(&Seat, &Window)>
) -> GrabStatus

This is supported on crate feature v3_20 only.

Grabs the seat so that all events corresponding to the given capabilities are passed to this application until the seat is ungrabbed with ungrab(), or the window becomes hidden. This overrides any previous grab on the seat by this client.

As a rule of thumb, if a grab is desired over SeatCapabilities::POINTER, all other “pointing” capabilities (eg. SeatCapabilities::TOUCH) should be grabbed too, so the user is able to interact with all of those while the grab holds, you should thus use SeatCapabilities::ALL_POINTING most commonly.

Grabs are used for operations which need complete control over the events corresponding to the given capabilities. For example in GTK+ this is used for Drag and Drop operations, popup menus and such.

Note that if the event mask of a Window has selected both button press and button release events, or touch begin and touch end, then a press event will cause an automatic grab until the button is released, equivalent to a grab on the window with owner_events set to true. This is done because most applications expect to receive paired press and release events.

If you set up anything at the time you take the grab that needs to be cleaned up when the grab ends, you should handle the EventGrabBroken events that are emitted when the grab ends unvoluntarily.

`window`

the Window which will own the grab

`capabilities`

capabilities that will be grabbed

`owner_events`

if false then all device events are reported with respect to window and are only reported if selected by event_mask. If true then pointer events for this application are reported as normal, but pointer events outside this application are reported with respect to window and only if selected by event_mask. In either mode, unreported events are discarded.

`cursor`

the cursor to display while the grab is active. If this is None then the normal cursors are used for window and its descendants, and the cursor for window is used elsewhere.

`event`

the event that is triggering the grab, or None if none is available.

`prepare_func`

function to prepare the window to be grabbed, it can be None if window is visible before this call.

`prepare_func_data`

user data to pass to prepare_func

Returns

GrabStatus::Success if the grab was successful.

[src]

pub fn ungrab(&self)

This is supported on crate feature v3_20 only.

Releases a grab added through grab().

[src]

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

This is supported on crate feature v3_20 only.

The ::device-added signal is emitted when a new input device is related to this seat.

`device`

the newly added Device.

[src]

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

This is supported on crate feature v3_20 only.

The ::device-removed signal is emitted when an input device is removed (e.g. unplugged).

`device`

the just removed Device.

[src]

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

This is supported on crate features v3_20 and v3_22 only.

The ::tool-added signal is emitted whenever a new tool is made known to the seat. The tool may later be assigned to a device (i.e. on proximity with a tablet). The device will emit the signal::Device::tool-changed signal accordingly.

A same tool may be used by several devices.

`tool`

the new DeviceTool known to the seat

[src]

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

This is supported on crate features v3_20 and v3_22 only.

This signal is emitted whenever a tool is no longer known to this seat.

`tool`

the just removed DeviceTool

Trait Implementations

[src]

impl Clone for Seat

This is supported on crate feature v3_20 only.

[src]

fn clone(&self) -> Seat

Returns a copy of the value. Read more

1.0.0[src]

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

Performs copy-assignment from source. Read more

[src]

impl Debug for Seat

This is supported on crate feature v3_20 only.

[src]

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

Formats the value using the given formatter. Read more

[src]

impl Display for Seat

This is supported on crate feature v3_20 only.

[src]

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

Formats the value using the given formatter. Read more

[src]

impl Hash for Seat

This is supported on crate feature v3_20 only.

[src]

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

Feeds this value into the given Hasher. Read more

1.3.0[src]

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

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

[src]

impl Ord for Seat

This is supported on crate feature v3_20 only.

[src]

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

This method returns an Ordering between self and other. Read more

1.21.0[src]

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

Compares and returns the maximum of two values. Read more

1.21.0[src]

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

Compares and returns the minimum of two values. Read more

1.50.0[src]

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval. Read more

[src]

impl ParentClassIs for Seat

This is supported on crate feature v3_20 only.

type Parent = Object

[src]

impl<T: ObjectType> PartialEq<T> for Seat

This is supported on crate feature v3_20 only.

[src]

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

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0[src]

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

This method tests for !=.

[src]

impl<T: ObjectType> PartialOrd<T> for Seat

This is supported on crate feature v3_20 only.

[src]

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

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

1.0.0[src]

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[src]

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[src]

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[src]

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

[src]

impl StaticType for Seat

This is supported on crate feature v3_20 only.

[src]

fn static_type() -> Type

Returns the type identifier of Self.

[src]

impl Eq for Seat

This is supported on crate feature v3_20 only.

[src]

impl StructuralEq for Seat

This is supported on crate feature v3_20 only.

Auto Trait Implementations

impl RefUnwindSafe for Seat

impl !Send for Seat

impl !Sync for Seat

impl Unpin for Seat

impl UnwindSafe for Seat

Blanket Implementations

[src]

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

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

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

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

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

[src]

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

Mutably borrows from an owned value. Read more

[src]

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

[src]

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

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

[src]

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

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

[src]

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

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

[src]

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

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

[src]

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 downcast and upcast will do many checks at compile-time already. Read more

[src]

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

[src]

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

Casts to T unconditionally. Read more

[src]

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

Casts to &T unconditionally. Read more

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

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

[src]

pub fn into(self) -> U

Performs the conversion.

[src]

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

[src]

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

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

[src]

pub fn type_(&self) -> Type

[src]

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

[src]

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

[src]

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

[src]

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

[src]

pub fn set_properties(
    &self, 
    property_values: &[(&str, &dyn ToValue)]
) -> Result<(), BoolError>

[src]

pub fn set_properties_from_value(
    &self, 
    property_values: &[(&str, Value)]
) -> Result<(), BoolError>

[src]

pub fn set_property<'a, N, V>(
    &self, 
    property_name: N, 
    value: V
) -> Result<(), BoolError> where
    N: Into<&'a str>,
    V: ToValue,

[src]

pub fn set_property_from_value<'a, N>(
    &self, 
    property_name: N, 
    value: &Value
) -> Result<(), BoolError> where
    N: Into<&'a str>,

[src]

pub fn property<'a, N>(&self, property_name: N) -> Result<Value, BoolError> where
    N: Into<&'a str>,

[src]

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

Safety Read more

[src]

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

Safety Read more

[src]

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

Safety Read more

[src]

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

Safety Read more

[src]

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

Safety Read more

[src]

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

Safety Read more

[src]

pub fn block_signal(&self, handler_id: &SignalHandlerId)

[src]

pub fn unblock_signal(&self, handler_id: &SignalHandlerId)

[src]

pub fn stop_signal_emission(&self, signal_name: &str)

[src]

pub fn disconnect(&self, handler_id: SignalHandlerId)

[src]

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

[src]

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

[src]

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

[src]

pub fn notify<'a, N>(&self, property_name: N) where
    N: Into<&'a str>,

[src]

pub fn notify_by_pspec(&self, pspec: &ParamSpec)

[src]

pub fn has_property<'a, N>(&self, property_name: N, type_: Option<Type>) -> bool where
    N: Into<&'a str>,

[src]

pub fn property_type<'a, N>(&self, property_name: N) -> Option<Type> where
    N: Into<&'a str>,

[src]

pub fn find_property<'a, N>(&self, property_name: N) -> Option<ParamSpec> where
    N: Into<&'a str>,

[src]

pub fn list_properties(&self) -> Vec<ParamSpec, Global>

[src]

pub fn freeze_notify(&self) -> PropertyNotificationFreezeGuard

[src]

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

[src]

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

Same as connect but takes a SignalId instead of a signal name.

[src]

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

[src]

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

Same as connect_local but takes a SignalId instead of a signal name.

[src]

pub unsafe fn connect_unsafe<'a, N, F>(
    &self, 
    signal_name: N, 
    after: bool, 
    callback: F
) -> Result<SignalHandlerId, BoolError> where
    F: Fn(&[Value]) -> Option<Value>,
    N: Into<&'a str>,

[src]

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

Same as connect_unsafe but takes a SignalId instead of a signal name.

[src]

pub fn emit(
    &self, 
    signal_id: SignalId, 
    args: &[&dyn ToValue]
) -> Result<Option<Value>, BoolError>

Emit signal by signal id.

[src]

pub fn emit_with_details(
    &self, 
    signal_id: SignalId, 
    details: Quark, 
    args: &[&dyn ToValue]
) -> Result<Option<Value>, BoolError>

Emit signal with details by signal id.

[src]

pub fn emit_by_name<'a, N>(
    &self, 
    signal_name: N, 
    args: &[&dyn ToValue]
) -> Result<Option<Value>, BoolError> where
    N: Into<&'a str>,

Emit signal by it’s name.

[src]

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

[src]

pub fn bind_property<'a, O, N, M>(
    &'a self, 
    source_property: N, 
    target: &'a O, 
    target_property: M
) -> BindingBuilder<'a> where
    O: ObjectType,
    M: Into<&'a str>,
    N: Into<&'a str>,

[src]

pub fn ref_count(&self) -> u32

[src]

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

Same as emit but takes Value for the arguments.

[src]

pub fn emit_by_name_with_values<'a, N>(
    &self, 
    signal_name: N, 
    args: &[Value]
) -> Result<Option<Value>, BoolError> where
    N: Into<&'a str>,

Same as emit_by_name but takes Value for the arguments.

[src]

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

Same as emit_with_details but takes Value for the arguments.

[src]

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

type Owned = T

The resulting type after obtaining ownership.

[src]

pub fn to_owned(&self) -> T

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

[src]

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

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

[src]

impl<T> ToSendValue for T where
    T: Send + ToValue + ?Sized,

[src]

pub fn to_send_value(&self) -> SendValue

Returns a SendValue clone of self.

[src]

impl<T> ToString for T where
    T: Display + ?Sized,

[src]

pub default fn to_string(&self) -> String

Converts the given value to a String. Read more

[src]

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

type Error = Infallible

The type returned in the event of a conversion error.

[src]

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

Performs the conversion.

[src]

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.

[src]

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

Performs the conversion.

[src]

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

[src]

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