Struct wayland_protocols::unstable::xdg_shell::v6::client::zxdg_popup_v6::ZxdgPopupV6

pub struct ZxdgPopupV6(/* private fields */);

Implementations

impl ZxdgPopupV6

pub fn destroy(&self)

remove xdg_popup interface

This destroys the popup. Explicitly destroying the xdg_popup object will also dismiss the popup, and unmap the surface.

If this xdg_popup is not the “topmost” popup, a protocol error will be sent.

This is a destructor, you cannot send requests to this object any longer once this method is called.

pub fn grab(&self, seat: &WlSeat, serial: u32)

make the popup take an explicit grab

This request makes the created popup take an explicit grab. An explicit grab will be dismissed when the user dismisses the popup, or when the client destroys the xdg_popup. This can be done by the user clicking outside the surface, using the keyboard, or even locking the screen through closing the lid or a timeout.

If the compositor denies the grab, the popup will be immediately dismissed.

This request must be used in response to some sort of user action like a button press, key press, or touch down event. The serial number of the event should be passed as ‘serial’.

The parent of a grabbing popup must either be an xdg_toplevel surface or another xdg_popup with an explicit grab. If the parent is another xdg_popup it means that the popups are nested, with this popup now being the topmost popup.

Nested popups must be destroyed in the reverse order they were created in, e.g. the only popup you are allowed to destroy at all times is the topmost one.

When compositors choose to dismiss a popup, they may dismiss every nested grabbing popup as well. When a compositor dismisses popups, it will follow the same dismissing order as required from the client.

The parent of a grabbing popup must either be another xdg_popup with an active explicit grab, or an xdg_popup or xdg_toplevel, if there are no explicit grabs already taken.

If the topmost grabbing popup is destroyed, the grab will be returned to the parent of the popup, if that parent previously had an explicit grab.

If the parent is a grabbing popup which has already been dismissed, this popup will be immediately dismissed. If the parent is a popup that did not take an explicit grab, an error will be raised.

During a popup grab, the client owning the grab will receive pointer and touch events for all their surfaces as normal (similar to an “owner-events” grab in X11 parlance), while the top most grabbing popup will always have keyboard focus.

Trait Implementations

impl AsRef<Proxy<ZxdgPopupV6>> for ZxdgPopupV6

fn as_ref(&self) -> &Proxy<Self>

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for ZxdgPopupV6

fn clone(&self) -> ZxdgPopupV6

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ZxdgPopupV6

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

Formats the value using the given formatter.

impl From<Proxy<ZxdgPopupV6>> for ZxdgPopupV6

fn from(value: Proxy<Self>) -> Self

Converts to this type from the input type.

impl From<ZxdgPopupV6> for Proxy<ZxdgPopupV6>

fn from(value: ZxdgPopupV6) -> Self

Converts to this type from the input type.

impl Interface for ZxdgPopupV6

type Request = Request

Set of requests associated to this interface

type Event = Event

Set of events associated to this interface

const NAME: &'static str = "zxdg_popup_v6"

Name of this interface

const VERSION: u32 = 1u32

Maximum supported version of this interface

fn c_interface() -> *const wl_interface

Pointer to the C representation of this interface

impl PartialEq for ZxdgPopupV6

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

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

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.

impl Eq for ZxdgPopupV6

impl StructuralEq for ZxdgPopupV6

impl StructuralPartialEq for ZxdgPopupV6