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
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.
voidshell_surface_t::move(seat_tconst&seat,uint32_tserial)
start an interactive move
Parametersseat seat whose pointer is used
serial serial number of the implicit grab on the pointer
Start a pointer-driven move of the surface.
This request must be used in response to a button press event. The server may ignore move requests
depending on the state of the surface (e.g. fullscreen or maximized).
Examplesegl.cpp, and shm.cpp.
Definition at line 2542 of file wayland-client-protocol.cpp.
std::function<void(shell_surface_resize,int32_t,int32_t)>&shell_surface_t::on_configure()
suggest resize
Parametersedges how the surface was resized
width new width of the surface
height new height of the surface
The configure event asks the client to resize its surface.
The size is a hint, in the sense that the client is free to ignore it if it doesn't resize, pick a
smaller size (to satisfy aspect ratio or resize in steps of NxM pixels).
The edges parameter provides a hint about how the surface was resized. The client may use this
information to decide how to adjust its content to the new size (e.g. a scrolling area might adjust its
content position to leave the viewable content unmoved).
The client is free to dismiss all but the last configure event it received.
The width and height arguments specify the size of the window in surface-local coordinates.
Definition at line 2601 of file wayland-client-protocol.cpp.
std::function<void(uint32_t)>&shell_surface_t::on_ping()
ping client
Parametersserial serial number of the ping
Ping a client to check if it is receiving events and sending requests. A client is expected to reply with
a pong request.
Examplesegl.cpp, and shm.cpp.
Definition at line 2596 of file wayland-client-protocol.cpp.
std::function<void()>&shell_surface_t::on_popup_done()
popup interaction is done The popup_done event is sent out when a popup grab is broken, that is, when the
user clicks a surface that doesn't belong to the client owning the popup surface.
Definition at line 2606 of file wayland-client-protocol.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.
voidshell_surface_t::pong(uint32_tserial)
respond to a ping event
Parametersserial serial number of the ping event
A client must respond to a ping event with a pong request or the client may be deemed unresponsive.
Examplesegl.cpp, and shm.cpp.
Definition at line 2536 of file wayland-client-protocol.cpp.
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.
voidshell_surface_t::resize(seat_tconst&seat,uint32_tserial,shell_surface_resizeconst&edges)
start an interactive resize
Parametersseat seat whose pointer is used
serial serial number of the implicit grab on the pointer
edges which edge or corner is being dragged
Start a pointer-driven resizing of the surface.
This request must be used in response to a button press event. The server may ignore resize requests
depending on the state of the surface (e.g. fullscreen or maximized).
Definition at line 2548 of file wayland-client-protocol.cpp.
voidshell_surface_t::set_class(std::stringconst&class_)
set surface class
Parametersclass_ surface class
Set a class for the surface.
The surface class identifies the general class of applications to which the surface belongs. A common
convention is to use the file name (or the full path if it is a non-standard location) of the
application's .desktop file as the class.
Definition at line 2590 of file wayland-client-protocol.cpp.
voidshell_surface_t::set_fullscreen(shell_surface_fullscreen_methodconst&method,uint32_tframerate,output_tconst&output)
make the surface a fullscreen surface
Parametersmethod method for resolving size conflict
framerate framerate in mHz
output output on which the surface is to be fullscreen
Map the surface as a fullscreen surface.
If an output parameter is given then the surface will be made fullscreen on that output. If the client
does not specify the output then the compositor will apply its policy - usually choosing the output on
which the surface has the biggest surface area.
The client may specify a method to resolve a size conflict between the output size and the surface size -
this is provided through the method parameter.
The framerate parameter is used only when the method is set to 'driver', to indicate the preferred
framerate. A value of 0 indicates that the client does not care about framerate. The framerate is
specified in mHz, that is framerate of 60000 is 60Hz.
A method of 'scale' or 'driver' implies a scaling operation of the surface, either via a direct scaling
operation or a change of the output mode. This will override any kind of output scaling, so that mapping
a surface with a buffer size equal to the mode can fill the screen independent of buffer_scale.
A method of 'fill' means we don't scale up the buffer, however any output scale is applied. This means
that you may run into an edge case where the application maps a buffer with the same size of the output
mode but buffer_scale 1 (thus making a surface larger than the output). In this case it is allowed to
downscale the results to fit the screen.
The compositor must reply to this request with a configure event with the dimensions for the output on
which the surface will be made fullscreen.
Definition at line 2566 of file wayland-client-protocol.cpp.
voidshell_surface_t::set_maximized(output_tconst&output)
make the surface a maximized surface
Parametersoutput output on which the surface is to be maximized
Map the surface as a maximized surface.
If an output parameter is given then the surface will be maximized on that output. If the client does not
specify the output then the compositor will apply its policy - usually choosing the output on which the
surface has the biggest surface area.
The compositor will reply with a configure event telling the expected new surface size. The operation is
completed on the next buffer attach to this surface.
A maximized surface typically fills the entire output it is bound to, except for desktop elements such as
panels. This is the main difference between a maximized shell surface and a fullscreen shell surface.
The details depend on the compositor implementation.
Definition at line 2578 of file wayland-client-protocol.cpp.
voidshell_surface_t::set_popup(seat_tconst&seat,uint32_tserial,surface_tconst&parent,int32_tx,int32_ty,shell_surface_transientconst&flags)
make the surface a popup surface
Parametersseat seat whose pointer is used
serial serial number of the implicit grab on the pointer
parent parent surface
x surface-local x coordinate
y surface-local y coordinate
flags transient surface behavior
Map the surface as a popup.
A popup surface is a transient surface with an added pointer grab.
An existing implicit grab will be changed to owner-events mode, and the popup grab will continue after
the implicit grab ends (i.e. releasing the mouse button does not cause the popup to be unmapped).
The popup grab continues until the window is destroyed or a mouse button is pressed in any other client's
window. A click in any of the client's surfaces is reported as normal, however, clicks in other clients'
surfaces will be discarded and trigger the callback.
The x and y arguments specify the location of the upper left corner of the surface relative to the upper
left corner of the parent surface, in surface-local coordinates.
Definition at line 2572 of file wayland-client-protocol.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.
voidshell_surface_t::set_title(std::stringconst&title)
set surface title
Parameterstitle surface title
Set a short title for the surface.
This string may be used to identify the surface in a task bar, window list, or other user interface
elements provided by the compositor.
The string must be encoded in UTF-8.
Examplesegl.cpp, and shm.cpp.
Definition at line 2584 of file wayland-client-protocol.cpp.
voidshell_surface_t::set_toplevel()
make the surface a toplevel surface Map the surface as a toplevel surface.
A toplevel surface is not fullscreen, maximized or transient.
Examplesegl.cpp, and shm.cpp.
Definition at line 2554 of file wayland-client-protocol.cpp.
voidshell_surface_t::set_transient(surface_tconst&parent,int32_tx,int32_ty,shell_surface_transientconst&flags)
make the surface a transient surface
Parametersparent parent surface
x surface-local x coordinate
y surface-local y coordinate
flags transient surface behavior
Map the surface relative to an existing surface.
The x and y arguments specify the location of the upper left corner of the surface relative to the upper
left corner of the parent surface, in surface-local coordinates.
The flags argument controls details of the transient behaviour.
Definition at line 2560 of file wayland-client-protocol.cpp.
Install Now
PNG Icons
