Man page - wayland_server_zxdg_toplevel_decoration_v1_t(3)
Packages contas this manual
- wayland_server_zwp_text_input_v3_content_hint(3)
- wayland_subsurface_t(3)
- wayland_zwp_primary_selection_source_v1_t(3)
- wayland_zwp_linux_buffer_release_v1_t(3)
- wayland_zwp_tablet_manager_v2_t(3)
- wayland_shell_t(3)
- wayland_xdg_surface_t(3)
- wayland_server_zxdg_output_v1_t(3)
- wayland_zwp_tablet_seat_v2_t(3)
- wayland_zwp_linux_surface_synchronization_v1_t(3)
- wayland_viewporter_t(3)
- wayland_server_zwp_tablet_tool_v2_t(3)
- wayland_compositor_t(3)
- wayland_zxdg_output_manager_v1_t(3)
- wayland_server_output_mode(3)
- wayland_server_seat_t(3)
- wayland_server_shell_surface_resize(3)
- wayland-client.hpp(3)
- wayland_zwp_primary_selection_offer_v1_t(3)
- wayland_zwp_pointer_gesture_pinch_v1_t(3)
- wayland_zwp_linux_dmabuf_v1_t(3)
- wayland_server_xdg_surface_t(3)
- wayland_xdg_toplevel_resize_edge(3)
- wayland_zxdg_toplevel_v6_t(3)
- wayland_zxdg_exporter_v1_t(3)
- wayland_server_zwp_linux_surface_synchronization_v1_t(3)
- wayland_zwp_text_input_v3_t(3)
- wayland_server_data_offer_t(3)
- wayland_server_zxdg_surface_v6_t(3)
- wayland_zwp_relative_pointer_v1_t(3)
- wayland_server_data_device_manager_t(3)
- wayland_zxdg_importer_v1_t(3)
- wayland_zwp_idle_inhibit_manager_v1_t(3)
- wayland_server_data_device_manager_dnd_action(3)
- wayland_zwp_tablet_manager_v1_t(3)
- wayland_zwp_input_timestamps_v1_t(3)
- wayland_server_zwp_input_panel_v1_t(3)
- wayland_server_zwp_text_input_v1_content_hint(3)
- wayland_server_zwp_text_input_manager_v1_t(3)
- wayland_server_region_t(3)
- wayland_server_zxdg_imported_v1_t(3)
- wayland_xdg_toplevel_t(3)
- wayland_zxdg_exported_v2_t(3)
- wayland_zwp_tablet_tool_v2_t(3)
- wayland_zwp_keyboard_shortcuts_inhibit_manager_v1_t(3)
- wayland-server.hpp(3)
- wayland_server_zxdg_exporter_v1_t(3)
- wayland_server_zxdg_popup_v6_t(3)
- wayland_xdg_activation_token_v1_t(3)
- wayland_read_intent(3)
- wayland_server_zwp_idle_inhibit_manager_v1_t(3)
- wayland_server_zwp_linux_explicit_synchronization_v1_t(3)
- wayland_server_shm_pool_t(3)
- wayland_server_zxdg_shell_v6_t(3)
- wayland_server_zxdg_importer_v2_t(3)
- wayland_xdg_wm_base_t(3)
- wayland_touch_t(3)
- wayland_zxdg_positioner_v6_t(3)
- wayland_data_offer_t(3)
- wayland_server_zwp_tablet_v2_t(3)
- wayland_server_zwp_linux_buffer_release_v1_t(3)
- wayland_server_xdg_toplevel_t(3)
- wayland_xdg_popup_t(3)
- wayland_server_viewporter_t(3)
- wayland_server_zwp_tablet_manager_v1_t(3)
- wayland_zwp_text_input_v1_t(3)
- wayland_keyboard_t(3)
- wayland_server_zwp_tablet_pad_ring_v2_t(3)
- wayland_server_zwp_pointer_gestures_v1_t(3)
- wayland_xdg_activation_v1_t(3)
- wayland_server_zwp_pointer_constraints_v1_t(3)
- wayland_zwp_idle_inhibitor_v1_t(3)
- wayland_server_zxdg_positioner_v6_constraint_adjustment(3)
- wayland_server_zwp_xwayland_keyboard_grab_manager_v1_t(3)
- wayland_zwp_tablet_v1_t(3)
- wayland_zwp_input_panel_v1_t(3)
- wayland_pointer_t(3)
- wayland_zwp_tablet_seat_v1_t(3)
- wayland_egl_window_t(3)
- wayland_server_zwp_pointer_gesture_pinch_v1_t(3)
- wayland_server_buffer_t(3)
- wayland_server_viewport_t(3)
- wayland_detail_refcounted_wrapper(3)
- wayland_zwp_primary_selection_device_manager_v1_t(3)
- wayland_server_presentation_feedback_t(3)
- wayland_data_device_manager_t(3)
- wayland_zwp_input_method_v1_t(3)
- wayland_zwp_pointer_gestures_v1_t(3)
- wayland_zwp_pointer_constraints_v1_t(3)
- wayland_server_zwp_tablet_seat_v2_t(3)
- wayland_zwp_linux_buffer_params_v1_t(3)
- wayland_server_xdg_popup_t(3)
- wayland_zwp_tablet_pad_strip_v2_t(3)
- wayland_presentation_feedback_kind(3)
- wayland_server_surface_t(3)
- wayland_presentation_t(3)
- wayland_server_zxdg_toplevel_v6_t(3)
- wayland_server_zwp_input_timestamps_v1_t(3)
- wayland_zwp_keyboard_shortcuts_inhibitor_v1_t(3)
- wayland_server_shell_surface_transient(3)
- wayland_zxdg_toplevel_v6_resize_edge(3)
- wayland_server_zwp_input_method_v1_t(3)
- wayland_event_queue_t(3)
- wayland_zxdg_popup_v6_t(3)
- wayland_zwp_locked_pointer_v1_t(3)
- wayland_output_t(3)
- wayland_zwp_tablet_v2_t(3)
- wayland_zxdg_output_v1_t(3)
- wayland_xdg_positioner_constraint_adjustment(3)
- wayland_zwp_tablet_pad_ring_v2_t(3)
- wayland_data_device_manager_dnd_action(3)
- wayland_server_zwp_pointer_gesture_swipe_v1_t(3)
- wayland_server_zwp_text_input_v1_t(3)
- wayland_server_xdg_activation_token_v1_t(3)
- wayland_server_zwp_linux_dmabuf_v1_t(3)
- wayland_zxdg_shell_v6_t(3)
- wayland_server_seat_capability(3)
- wayland_server_zwp_tablet_pad_strip_v2_t(3)
- wayland_server_zxdg_exported_v1_t(3)
- wayland_server_compositor_t(3)
- wayland_server_zwp_tablet_pad_v2_t(3)
- wayland_server_zwp_primary_selection_device_manager_v1_t(3)
- wayland_data_device_t(3)
- wayland_server_zwp_keyboard_shortcuts_inhibitor_v1_t(3)
- wayland_server_subcompositor_t(3)
- wayland_server_presentation_feedback_kind(3)
- wayland_zwp_input_timestamps_manager_v1_t(3)
- wayland_server_zwp_linux_buffer_params_v1_t(3)
- wayland_server_zwp_linux_dmabuf_feedback_v1_t(3)
- wayland_zwp_fullscreen_shell_v1_t(3)
- wayland_zwp_tablet_pad_group_v2_t(3)
- wayland_server_zwp_tablet_v1_t(3)
- wayland_server_zwp_xwayland_keyboard_grab_v1_t(3)
- wayland_zxdg_exporter_v2_t(3)
- wayland_server_zwp_primary_selection_source_v1_t(3)
- wayland_server_zwp_text_input_v3_t(3)
- wayland_proxy_t(3)
- wayland_server_zwp_primary_selection_offer_v1_t(3)
- wayland_server_zwp_tablet_seat_v1_t(3)
- wayland_surface_t(3)
- wayland_detail_basic_wrapper(3)
- wayland_server_zxdg_imported_v2_t(3)
- wayland_server_zwp_input_timestamps_manager_v1_t(3)
- wayland_zwp_text_input_v3_content_hint(3)
- wayland_zxdg_toplevel_decoration_v1_t(3)
- wayland_server_zwp_idle_inhibitor_v1_t(3)
- wayland_server_data_device_t(3)
- wayland_server_zxdg_importer_v1_t(3)
- wayland_zwp_linux_dmabuf_feedback_v1_t(3)
- wayland_zwp_relative_pointer_manager_v1_t(3)
- wayland_server_xdg_positioner_t(3)
- wayland_server_zwp_input_method_context_v1_t(3)
- wayland_server_zxdg_exported_v2_t(3)
- wayland_zxdg_exported_v1_t(3)
- wayland_zxdg_importer_v2_t(3)
- wayland_zwp_linux_explicit_synchronization_v1_t(3)
- wayland_server_zwp_relative_pointer_v1_t(3)
- wayland_shell_surface_transient(3)
- wayland_server_zwp_tablet_tool_v1_t(3)
- wayland_zwp_pointer_gesture_hold_v1_t(3)
- wayland_server_shm_t(3)
- wayland_server_zwp_keyboard_shortcuts_inhibit_manager_v1_t(3)
- wayland_server_callback_t(3)
- wayland_server_registry_t(3)
- wayland_server_zxdg_positioner_v6_t(3)
- wayland_xdg_positioner_t(3)
- wayland_seat_capability(3)
- wayland_server_zxdg_exporter_v2_t(3)
- wayland_subcompositor_t(3)
- wayland_server_shell_t(3)
- wayland_seat_t(3)
- wayland_zwp_pointer_gesture_swipe_v1_t(3)
- wayland_server_zwp_locked_pointer_v1_t(3)
- wayland_server_zwp_fullscreen_shell_v1_t(3)
- wayland_zwp_text_input_v1_content_hint(3)
- wayland_server_keyboard_t(3)
- wayland_server_zwp_pointer_gesture_hold_v1_t(3)
- wayland_zwp_text_input_manager_v3_t(3)
- wayland_server_pointer_t(3)
- wayland_server_zxdg_output_manager_v1_t(3)
- wayland_server_touch_t(3)
- wayland_server_output_t(3)
- wayland_server_output_transform(3)
- wayland_buffer_t(3)
- wayland_server_presentation_t(3)
- wayland_output_mode(3)
- wayland_server_zxdg_decoration_manager_v1_t(3)
- wayland_server_subsurface_t(3)
- wayland_server_zxdg_toplevel_decoration_v1_t(3)
- wayland_zwp_confined_pointer_v1_t(3)
- wayland_server_shell_surface_t(3)
- wayland_zxdg_surface_v6_t(3)
- wayland_server_zxdg_toplevel_v6_resize_edge(3)
- wayland_registry_t(3)
- wayland_zwp_xwayland_keyboard_grab_v1_t(3)
- wayland_callback_t(3)
- wayland_zxdg_imported_v1_t(3)
- wayland_server_global_base_t(3)
- wayland_server_zwp_tablet_manager_v2_t(3)
- wayland_presentation_feedback_t(3)
- wayland_shell_surface_t(3)
- wayland_display_t(3)
- wayland_shm_pool_t(3)
- wayland_server_zwp_tablet_pad_group_v2_t(3)
- wayland_data_source_t(3)
- wayland_server_data_source_t(3)
- wayland_server_xdg_toplevel_resize_edge(3)
- wayland_server_zwp_confined_pointer_v1_t(3)
- wayland_viewport_t(3)
- wayland_region_t(3)
- wayland_output_transform(3)
- wayland_zwp_input_method_context_v1_t(3)
- wayland_zwp_tablet_tool_v1_t(3)
- wayland_server_global_t(3)
- wayland_zwp_text_input_manager_v1_t(3)
- wayland_shell_surface_resize(3)
- wayland_zxdg_imported_v2_t(3)
- wayland_server_xdg_wm_base_t(3)
- wayland_zwp_xwayland_keyboard_grab_manager_v1_t(3)
- wayland_shm_t(3)
- wayland_server_zwp_relative_pointer_manager_v1_t(3)
- wayland_zwp_tablet_pad_v2_t(3)
- wayland_server_xdg_activation_v1_t(3)
- wayland_zxdg_positioner_v6_constraint_adjustment(3)
- wayland_server_zwp_text_input_manager_v3_t(3)
- wayland_zxdg_decoration_manager_v1_t(3)
- wayland_server_xdg_positioner_constraint_adjustment(3)
apt-get install waylandpp-dev
Manual
| wayland::server::zxdg_toplevel_decoration_v1_t(3) | Wayland++ | wayland::server::zxdg_toplevel_decoration_v1_t(3) |
NAME
wayland::server::zxdg_toplevel_decoration_v1_t - decoration object for a toplevel surface
SYNOPSIS
#include <wayland-server-protocol-unstable.hpp>
Inherits wayland::server::resource_t.
Public Member Functions
std::function< void()> & on_destroy ()
destroy the decoration object std::function<
void(zxdg_toplevel_decoration_v1_mode)> & on_set_mode ()
set the decoration mode std::function< void()> &
on_unset_mode ()
unset the decoration mode void configure
(zxdg_toplevel_decoration_v1_mode const &mode, bool post=true)
suggest a surface change void post_unconfigured_buffer (std::string
const &msg)
Post error: xdg_toplevel has a buffer attached before configure. void
post_already_constructed (std::string const &msg)
Post error: xdg_toplevel already has a decoration object. void
post_orphaned (std::string const &msg)
Post error: xdg_toplevel destroyed before the decoration object. bool
proxy_has_object () const
Check whether this wrapper actually wraps an object. void
post_no_memory () const
uint32_t get_id () const
client_t get_client () const
unsigned int get_version () const
std::string get_class ()
Static Public Attributes
static constexpr std::uint32_t configure_since_version = 1
Minimum protocol version required for the configure function.
Detailed Description
decoration object for a toplevel surface
The decoration object allows the compositor to toggle server-side window decorations for a toplevel surface. The client can request to switch to another mode.
The xdg_toplevel_decoration object must be destroyed before its xdg_toplevel.
Definition at line 7811 of file wayland-server-protocol-unstable.hpp.
Member Function Documentation
void zxdg_toplevel_decoration_v1_t::configure (zxdg_toplevel_decoration_v1_mode const & mode, bool post = true)
suggest a surface change
Parameters
The configure event asks the client to change its decoration mode. The configured state should not be applied immediately. Clients must send an ack_configure in response to this event. See xdg_surface.configure and xdg_surface.ack_configure for details.
A configure event can be sent at any time. The specified mode must be obeyed by the client.
Definition at line 7626 of file wayland-server-protocol-unstable.cpp.
std::string wayland::server::resource_t::get_class () [inherited]
Retrieve the interface name (class) of a resource object.
Returns
client_t wayland::server::resource_t::get_client () const [inherited]
Get the associated client
Returns
uint32_t wayland::server::resource_t::get_id () const [inherited]
Get the internal ID of the resource
Returns
unsigned int wayland::server::resource_t::get_version () const [inherited]
Get interface version
Returns
std::function< void()> & zxdg_toplevel_decoration_v1_t::on_destroy ()
destroy the decoration object Switch back to a mode without any server-side decorations at the next commit.
Definition at line 7608 of file wayland-server-protocol-unstable.cpp.
std::function< void(zxdg_toplevel_decoration_v1_mode)> & zxdg_toplevel_decoration_v1_t::on_set_mode ()
set the decoration mode
Parameters
Set the toplevel surface decoration mode. This informs the compositor that the client prefers the provided decoration mode.
After requesting a decoration mode, the compositor will respond by emitting an xdg_surface.configure event. The client should then update its content, drawing it without decorations if the received mode is server-side decorations. The client must also acknowledge the configure when committing the new content (see xdg_surface.ack_configure).
The compositor can decide not to use the client's mode and enforce a different mode instead.
Clients whose decoration mode depend on the xdg_toplevel state may send a set_mode request in response to an xdg_surface.configure event and wait for the next xdg_surface.configure event to prevent unwanted state. Such clients are responsible for preventing configure loops and must make sure not to send multiple successive set_mode requests with the same decoration mode.
Definition at line 7614 of file wayland-server-protocol-unstable.cpp.
std::function< void()> & zxdg_toplevel_decoration_v1_t::on_unset_mode ()
unset the decoration mode Unset the toplevel surface decoration mode. This informs the compositor that the client doesn't prefer a particular decoration mode.
This request has the same semantics as set_mode.
Definition at line 7620 of file wayland-server-protocol-unstable.cpp.
void zxdg_toplevel_decoration_v1_t::post_already_constructed (std::string const & msg)
Post error: xdg_toplevel already has a decoration object.
Definition at line 7636 of file wayland-server-protocol-unstable.cpp.
void wayland::server::resource_t::post_no_memory () const [inherited]
Post 'not enough memory' error to the client
If the compositor has not enough memory to fulfill a certail request of the client, this function can be called to notify the client of this circumstance.
void zxdg_toplevel_decoration_v1_t::post_orphaned (std::string const & msg)
Post error: xdg_toplevel destroyed before the decoration object.
Definition at line 7641 of file wayland-server-protocol-unstable.cpp.
void zxdg_toplevel_decoration_v1_t::post_unconfigured_buffer (std::string const & msg)
Post error: xdg_toplevel has a buffer attached before configure.
Definition at line 7631 of file wayland-server-protocol-unstable.cpp.
bool wayland::server::resource_t::proxy_has_object () const [inherited]
Check whether this wrapper actually wraps an object.
Returns
Member Data Documentation
constexpr std::uint32_t wayland::server::zxdg_toplevel_decoration_v1_t::configure_since_version = 1 [static], [constexpr]
Minimum protocol version required for the configure function.
Definition at line 7898 of file wayland-server-protocol-unstable.hpp.
Author
Generated automatically by Doxygen for Wayland++ from the source code.
| Sat Feb 1 2025 21:28:29 | Version 1.0.0 |