#[repr(transparent)]
pub struct X11Display { /* private fields */ }
Expand description

Implementations

Pops the error trap pushed by gdk_x11_display_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, gdk_x11_display_error_trap_pop_ignored() would be more efficient.

Returns

X error code or 0 on success

Pops the error trap pushed by gdk_x11_display_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.

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 gdk_x11_display_error_trap_pop() or gdk_x11_display_error_trap_pop_ignored()to lift a trap pushed with this function.

Returns the default group leader surface for all toplevel surfaces on @self. This surface is implicitly created by GDK. See gdk_x11_surface_set_group().

Returns

The default group leader surface for @self

This is supported on crate feature v4_4 only.

Retrieves the version of the EGL implementation.

Returns

true if EGL is available

major

return location for the EGL major version

minor

return location for the EGL minor version

Retrieves the version of the GLX implementation.

Returns

true if GLX is available

major

return location for the GLX major version

minor

return location for the GLX minor version

Gets the primary monitor for the display.

The primary monitor is considered the monitor where the “main desktop” lives. While normal application surfaces typically allow the window manager to place the surfaces, specialized desktop applications such as panels should place themselves on the primary monitor.

If no monitor is the designated primary monitor, any monitor (usually the first) may be returned.

Returns

the primary monitor, or any monitor if no primary monitor is configured by the user

Retrieves the X11Screen of the @self.

Returns

the X11Screen

Gets the startup notification ID for a display.

Returns

the startup notification ID for @self

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 gdk_x11_surface_set_user_time().

Returns

the timestamp of the last user interaction

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

gdk_x11_display_grab()/gdk_x11_display_ungrab() calls can be nested.

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::from_name() are updated to reflect the theme change. Custom cursors constructed with gdk::Cursor::from_texture() 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

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_display_notify_startup_complete()).

startup_id

the startup notification ID (must be valid utf8)

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

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 (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

Ungrab @self after it has been grabbed with gdk_x11_display_grab().

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

Tries to open a new display to the X server given by @display_name. If opening the display fails, None is returned.

display_name

name of the X display. See the XOpenDisplay() for details.

Returns

The new display

Sets the program class.

The X11 backend uses the program class to set the class name part of the WM_CLASS property on toplevel windows; see the ICCCM.

display

a gdk::Display

program_class

a string

This is supported on crate features v4_4 and egl only.

Retrieves the EGL display connection object for the given GDK display.

This function returns NULL if GDK is using GLX.

Returns

the EGL display object

Returns the X cursor belonging to a gdk::Cursor, potentially creating the cursor.

Be aware that the returned cursor may not be unique to @cursor. It may for example be shared with its fallback cursor. On old X servers that don’t support the XCursor extension, all cursors may even fall back to a few default cursors.

cursor

a gdk::Cursor

Returns

an Xlib Cursor.

Returns the root X window used by gdk::Display.

Returns

an X Window

This is supported on crate feature xlib only.

Returns the X display of a gdk::Display.

Returns

an X display

This is supported on crate feature xlib only.

Returns the X Screen used by gdk::Display.

Returns

an X Screen

This is supported on crate feature xlib only.

The ::xevent signal is a low level signal that is emitted whenever an XEvent has been received.

When handlers to this signal return true, no other handlers will be invoked. In particular, the default handler for this function is GDK’s own event handling mechanism, so by returning true for an event that GDK expects to translate, you may break GDK and/or GTK+ in interesting ways. You have been warned.

If you want this signal handler to queue a gdk::Event, you can use gdk_display_put_event().

If you are interested in X GenericEvents, bear in mind that XGetEventData() has been already called on the event, and XFreeEventData() will be called afterwards.

xevent

a pointer to the XEvent to process

Returns

true to stop other handlers from being invoked for the event. false to propagate the event further.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Formats the value using the given formatter. Read more

Feeds this value into the given Hasher. Read more

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

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

Compares and returns the maximum of two values. Read more

Compares and returns the minimum of two values. Read more

Restrict a value to a certain interval. Read more

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

This method tests for !=.

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

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

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

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

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

Returns the type identifier of Self.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

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

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

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

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

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

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

Casts to T unconditionally. Read more

Casts to &T unconditionally. Read more

Emits a short beep on @self

Closes the connection to the windowing system for the given display. Read more

This is supported on crate feature v4_6 only.

Creates a new GLContext for the Display. Read more

Returns true if there is an ongoing grab on @device for @self. Read more

Flushes any requests queued for the windowing system. Read more

Returns a AppLaunchContext suitable for launching applications on the given display. Read more

Gets the clipboard used for copy/paste operations. Read more

Returns the default Seat for this display. Read more

Gets the monitor in which the largest area of @surface resides. Read more

Gets the list of monitors associated with this display. Read more

Gets the name of the display. Read more

Gets the clipboard used for the primary selection. Read more

Gets the startup notification ID for a Wayland display, or None if no ID has been defined. Read more

Finds out if the display has been closed. Read more

Returns whether surfaces can reasonably be expected to have their alpha channel drawn correctly on the screen. Read more

Returns whether surfaces on this @self are created with an alpha channel. Read more

Returns the list of seats known to @self. Read more

Indicates to the GUI environment that the application has finished loading, using a given identifier. Read more

This is supported on crate feature v4_4 only.

Checks that OpenGL is available for @self and ensures that it is properly initialized. When this fails, an @error will be set describing the error and this function returns false. Read more

Appends the given event onto the front of the event queue for @self. Read more

Translates the contents of a GdkEventKey into a keyval, effective group, and level. Read more

Retrieves a desktop-wide setting such as double-click time for the @self. Read more

Obtains a list of keycode/group/level combinations that will generate @keyval. Read more

Returns the keyvals bound to @keycode. Read more

Get the currently used display backend

Returns the argument unchanged.

Calls U::from(self).

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

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

Returns the type of the object.

Returns the ObjectClass of the object. Read more

Returns the class of the object.

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

Returns the interface T of the object. Read more

Similar to Self::set_property but fails instead of panicking.

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

Similar to Self::set_property but fails instead of panicking.

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

Similar to Self::set_properties but fails instead of panicking.

Sets multiple properties of the object at once. Read more

Similar to Self::set_properties_from_value but fails instead of panicking.

Sets multiple properties of the object at once. Read more

Similar to Self::property but fails instead of panicking.

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

Similar to Self::property_value but fails instead of panicking.

Gets the property property_name of the object. Read more

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

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

Get the ParamSpec of the property property_name of this object.

Return all ParamSpec of the properties of this object.

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

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

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

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

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

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

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

Block a given signal handler. Read more

Unblock a given signal handler.

Stop emission of the currently emitted signal.

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

Similar to Self::connect but fails instead of panicking.

Connect to the signal signal_name on this object. Read more

Similar to Self::connect_id but fails instead of panicking.

Connect to the signal signal_id on this object. Read more

Similar to Self::connect_local but fails instead of panicking.

Connect to the signal signal_name on this object. Read more

Similar to Self::connect_local_id but fails instead of panicking.

Connect to the signal signal_id on this object. Read more

Similar to Self::connect_unsafe but fails instead of panicking.

Connect to the signal signal_name on this object. Read more

Similar to Self::connect_unsafe_id but fails instead of panicking.

Similar to Self::connect_closure but fails instead of panicking.

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

Similar to Self::connect_closure_id but fails instead of panicking.

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

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 Closure::invoke. Read more

Connect to the signal signal_id on this object. Read more

Similar to Self::emit but fails instead of panicking.

Emit signal by signal id. Read more

Similar to Self::emit_with_values but fails instead of panicking.

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

Similar to Self::emit_by_name but fails instead of panicking.

Emit signal by its name. Read more

Similar to Self::emit_by_name_with_values but fails instead of panicking.

Emit signal by its name. Read more

Similar to Self::emit_with_details but fails instead of panicking.

Emit signal by signal id with details. Read more

Similar to Self::emit_with_details_and_values but fails instead of panicking.

Emit signal by signal id with details. Read more

Disconnect a previously connected signal handler.

Connect to the notify signal of the object. Read more

Connect to the notify signal of the object. Read more

Connect to the notify signal of the object. Read more

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

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

Downgrade this object to a weak reference.

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

Returns the strong reference count of this object.

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

The resulting type after obtaining ownership.

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

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

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

Returns a SendValue clone of self.

Converts the given value to a String. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.