Struct gdkx11::X11Display[−][src]

pub struct X11Display(_);

Expand description

Implements

[trait@gdk::prelude::DisplayExt]

Implementations

[src]

impl X11Display

[src]

pub fn error_trap_pop(&self) -> i32

Pops the error trap pushed by error_trap_push(). Will XSync() if necessary and will always block until the error is known to have occurred or not occurred, so the error code can be returned.

If you don’t need to use the return value, error_trap_pop_ignored() would be more efficient.

See gdk_error_trap_pop() for the all-displays-at-once equivalent.

Returns

X error code or 0 on success

[src]

pub fn error_trap_pop_ignored(&self)

Pops the error trap pushed by error_trap_push(). Does not block to see if an error occurred; merely records the range of requests to ignore errors for, and ignores those errors if they arrive asynchronously.

See gdk_error_trap_pop_ignored() for the all-displays-at-once equivalent.

[src]

pub fn error_trap_push(&self)

Begins a range of X requests on self for which X error events will be ignored. Unignored errors (when no trap is pushed) will abort the application. Use error_trap_pop() or error_trap_pop_ignored()to lift a trap pushed with this function.

See also gdk_error_trap_push() to push a trap on all displays.

[src]

pub fn startup_notification_id(&self) -> Option<GString>

Gets the startup notification ID for a display.

Returns

the startup notification ID for self

[src]

pub fn user_time(&self) -> u32

Returns the timestamp of the last user interaction on self. The timestamp is taken from events caused by user interaction such as key presses or pointer movements. See X11Window::set_user_time().

Returns

the timestamp of the last user interaction

[src]

pub fn grab(&self)

Call XGrabServer() on self. To ungrab the display again, use ungrab().

grab()/ungrab() calls can be nested.

[src]

pub fn set_cursor_theme(&self, theme: Option<&str>, size: i32)

Sets the cursor theme from which the images for cursor should be taken.

If the windowing system supports it, existing cursors created with gdk_cursor_new(), gdk::Cursor::for_display() and gdk::Cursor::from_name() are updated to reflect the theme change. Custom cursors constructed with gdk::Cursor::from_pixbuf() will have to be handled by the application (GTK+ applications can learn about cursor theme changes by listening for change notification for the corresponding GtkSetting).

`theme`

the name of the cursor theme to use, or None to unset a previously set value

`size`

the cursor size to use, or 0 to keep the previous size

[src]

pub fn set_startup_notification_id(&self, startup_id: &str)

Sets the startup notification ID for a display.

This is usually taken from the value of the DESKTOP_STARTUP_ID environment variable, but in some cases (such as the application not being launched using exec()) it can come from other sources.

If the ID contains the string “_TIME” then the portion following that string is taken to be the X11 timestamp of the event that triggered the application to be launched and the GDK current event time is set accordingly.

The startup ID is also what is used to signal that the startup is complete (for example, when opening a window or when calling gdk_notify_startup_complete()).

`startup_id`

the startup notification ID (must be valid utf8)

[src]

pub fn set_window_scale(&self, scale: i32)

Forces a specific window scale for all windows on this display, instead of using the default or user configured scale. This is can be used to disable scaling support by setting scale to 1, or to programmatically set the window scale.

Once the scale is set by this call it will not change in response to later user configuration changes.

`scale`

The new scale value

[src]

pub fn string_to_compound_text(&self, str: &str) -> (i32, Atom, i32, Vec<u8>)

Convert a string from the encoding of the current locale into a form suitable for storing in a window property.

`str`

a nul-terminated string

Returns

0 upon success, non-zero upon failure

`encoding`

location to store the encoding atom (to be used as the type for the property)

`format`

location to store the format of the property

`ctext`

location to store newly allocated data for the property

[src]

pub fn ungrab(&self)

Ungrab self after it has been grabbed with grab().

[src]

pub fn utf8_to_compound_text(&self, str: &str) -> Option<(Atom, i32, Vec<u8>)>

Converts from UTF-8 to compound text.

`str`

a UTF-8 string

Returns

true if the conversion succeeded, otherwise false

`encoding`

location to store resulting encoding

`format`

location to store format of the result

`ctext`

location to store the data of the result

[src]

pub fn glx_version<P: IsA<Display>>(display: &P) -> Option<(i32, i32)>

Retrieves the version of the GLX implementation.

`display`

a gdk::Display

Returns

true if GLX is available

`major`

return location for the GLX major version

`minor`

return location for the GLX minor version

Trait Implementations

[src]

impl Clone for X11Display

[src]

fn clone(&self) -> X11Display

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 X11Display

[src]

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

Formats the value using the given formatter. Read more

[src]

impl Display for X11Display

[src]

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

Formats the value using the given formatter. Read more

[src]

impl Hash for X11Display

[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 X11Display

[src]

fn cmp(&self, other: &X11Display) -> 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 X11Display

type Parent = Display

[src]

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

[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 X11Display

[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 X11Display

[src]

fn static_type() -> Type

Returns the type identifier of Self.

[src]

impl Eq for X11Display

[src]

impl IsA<Display> for X11Display

[src]

impl StructuralEq for X11Display

Auto Trait Implementations

impl RefUnwindSafe for X11Display

impl !Send for X11Display

impl !Sync for X11Display

impl Unpin for X11Display

impl UnwindSafe for X11Display

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
    V: ToValue,
    N: Into<&'a str>,

[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,
    N: Into<&'a str>,
    M: 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>,