wl_proxy*wayland::proxy_t::c_ptr()const[inherited]
Get a pointer to the underlying C struct.
Returns
The underlying wl_proxy wrapped by this proxy_t if it exists, otherwise an exception is thrown
boolxdg_popup_t::can_reposition()const
Check whether the reposition function is available with the currently bound version of the protocol.
Definition at line 1521 of file wayland-client-protocol-extra.cpp.
std::stringwayland::proxy_t::get_class()const[inherited]
Get the interface name (class) of a proxy object.
Returns
The interface name of the object associated with the proxy
uint32_twayland::proxy_t::get_id()const[inherited]
Get the id of a proxy object.
Returns
The id the object associated with the proxy
uint32_twayland::proxy_t::get_version()const[inherited]
Get the protocol object version of a proxy object. Gets the protocol object version of a proxy object, or
0 if the proxy was created with unversioned API.
A returned value of 0 means that no version information is available, so the caller must make safe
assumptions about the object's real version.
display_t will always return version 0.
Returns
The protocol object version of the proxy or 0
wrapper_typewayland::proxy_t::get_wrapper_type()const[inline],[inherited]
Get the type of a proxy object.
Definition at line 302 of file wayland-client.hpp.
voidxdg_popup_t::grab(seat_tconst&seat,uint32_tserial)
make the popup take an explicit grab
Parametersseat the wl_seat of the user event
serial the serial of the user event
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.
Definition at line 1510 of file wayland-client-protocol-extra.cpp.
std::function<void(int32_t,int32_t,int32_t,int32_t)>&xdg_popup_t::on_configure()
configure the popup surface
Parametersx x position relative to parent surface window geometry
y y position relative to parent surface window geometry
width window geometry width
height window geometry height
This event asks the popup surface to configure itself given the configuration. The configured state
should not be applied immediately. See xdg_surface.configure for details.
The x and y arguments represent the position the popup was placed at given the xdg_positioner rule,
relative to the upper left corner of the window geometry of the parent surface.
For version 2 or older, the configure event for an xdg_popup is only ever sent once for the initial
configuration. Starting with version 3, it may be sent again if the popup is setup with an xdg_positioner
with set_reactive requested, or in response to xdg_popup.reposition requests.
Definition at line 1527 of file wayland-client-protocol-extra.cpp.
std::function<void()>&xdg_popup_t::on_popup_done()
popup interaction is done The popup_done event is sent out when a popup is dismissed by the compositor.
The client should destroy the xdg_popup object at this point.
Definition at line 1532 of file wayland-client-protocol-extra.cpp.
std::function<void(uint32_t)>&xdg_popup_t::on_repositioned()
signal the completion of a repositioned request
Parameterstoken reposition request token
The repositioned event is sent as part of a popup configuration sequence, together with
xdg_popup.configure and lastly xdg_surface.configure to notify the completion of a reposition request.
The repositioned event is to notify about the completion of a xdg_popup.reposition request. The token
argument is the token passed in the xdg_popup.reposition request.
Immediately after this event is emitted, xdg_popup.configure and xdg_surface.configure will be sent with
the updated size and position, as well as a new configure serial.
The client should optionally update the content of the popup, but must acknowledge the new popup
configuration for the new position to take effect. See xdg_surface.ack_configure for details.
Definition at line 1537 of file wayland-client-protocol-extra.cpp.
wayland::proxy_t::operatorbool()const[inherited]
Check whether this wrapper actually wraps an object.
Returns
true if there is an underlying object, false if this wrapper is empty
boolwayland::proxy_t::operator!=(constproxy_t&right)const[inherited]
Check whether two wrappers refer to different objects.
boolwayland::proxy_t::operator==(constproxy_t&right)const[inherited]
Check whether two wrappers refer to the same object.
boolwayland::proxy_t::proxy_has_object()const[inherited]
Check whether this wrapper actually wraps an object.
Returns
true if there is an underlying object, false if this wrapper is empty
voidwayland::proxy_t::proxy_release()[inherited]
Release the wrapped object (if any), making this an empty wrapper. Note that display_t instances cannot
be released this way. Attempts to do so are ignored.
Examplesforeign_display.cpp.
voidxdg_popup_t::reposition(xdg_positioner_tconst&positioner,uint32_ttoken)
recalculate the popup's location
Parameterspositionertoken reposition request token
Reposition an already-mapped popup. The popup will be placed given the details in the passed
xdg_positioner object, and a xdg_popup.repositioned followed by xdg_popup.configure and
xdg_surface.configure will be emitted in response. Any parameters set by the previous positioner will be
discarded.
The passed token will be sent in the corresponding xdg_popup.repositioned event. The new popup position
will not take effect until the corresponding configure event is acknowledged by the client. See
xdg_popup.repositioned for details. The token itself is opaque, and has no other special meaning.
If multiple reposition requests are sent, the compositor may skip all but the last one.
If the popup is repositioned in response to a configure event for its parent, the client should send an
xdg_positioner.set_parent_configure and possibly an xdg_positioner.set_parent_size request to allow the
compositor to properly constrain the popup.
If the popup is repositioned together with a parent that is being resized, but not in response to a
configure event, the client should send an xdg_positioner.set_parent_size request.
Definition at line 1516 of file wayland-client-protocol-extra.cpp.
voidwayland::proxy_t::set_queue(event_queue_tqueue)[inherited]
Assign a proxy to an event queue.
Parametersqueue The event queue that will handle this proxy
Assign proxy to event queue. Events coming from proxy will be queued in queue instead of the display's
main queue.
See also: display_t::dispatch_queue().
Examplesproxy_wrapper.cpp.
Install Now
PNG Icons
