Struct wayland_client::protocol::wl_shell_surface::WlShellSurface
source · pub struct WlShellSurface { /* private fields */ }
Expand description
desktop-style metadata interface
An interface that may be implemented by a wl_surface, for implementations that provide a desktop-style user interface.
It provides requests to treat surfaces like toplevel, fullscreen or popup windows, move, resize or maximize them, associate metadata like title and class, etc.
On the server side the object is automatically destroyed when the related wl_surface is destroyed. On the client side, wl_shell_surface_destroy() must be called before destroying the wl_surface object.
See also the Event enum for this interface.
Implementations§
source§impl WlShellSurface
impl WlShellSurface
sourcepub fn pong(&self, serial: u32)
pub fn pong(&self, serial: u32)
respond to a ping event
A client must respond to a ping event with a pong request or the client may be deemed unresponsive.
sourcepub fn _move(&self, seat: &WlSeat, serial: u32)
pub fn _move(&self, seat: &WlSeat, serial: u32)
start an interactive move
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).
sourcepub fn resize(&self, seat: &WlSeat, serial: u32, edges: Resize)
pub fn resize(&self, seat: &WlSeat, serial: u32, edges: Resize)
start an interactive resize
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).
sourcepub fn set_toplevel(&self)
pub fn set_toplevel(&self)
make the surface a toplevel surface
Map the surface as a toplevel surface.
A toplevel surface is not fullscreen, maximized or transient.
sourcepub fn set_transient(
&self,
parent: &WlSurface,
x: i32,
y: i32,
flags: Transient,
)
pub fn set_transient( &self, parent: &WlSurface, x: i32, y: i32, flags: Transient, )
make the surface a transient surface
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.
sourcepub fn set_fullscreen(
&self,
method: FullscreenMethod,
framerate: u32,
output: Option<&WlOutput>,
)
pub fn set_fullscreen( &self, method: FullscreenMethod, framerate: u32, output: Option<&WlOutput>, )
make the surface a fullscreen surface
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.
sourcepub fn set_popup(
&self,
seat: &WlSeat,
serial: u32,
parent: &WlSurface,
x: i32,
y: i32,
flags: Transient,
)
pub fn set_popup( &self, seat: &WlSeat, serial: u32, parent: &WlSurface, x: i32, y: i32, flags: Transient, )
make the surface a popup surface
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.
sourcepub fn set_maximized(&self, output: Option<&WlOutput>)
pub fn set_maximized(&self, output: Option<&WlOutput>)
make the surface a maximized surface
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.
sourcepub fn set_title(&self, title: String)
pub fn set_title(&self, title: String)
set 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.
sourcepub fn set_class(&self, class_: String)
pub fn set_class(&self, class_: String)
set 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.
Trait Implementations§
source§impl Borrow<ObjectId> for WlShellSurface
impl Borrow<ObjectId> for WlShellSurface
source§impl Clone for WlShellSurface
impl Clone for WlShellSurface
source§fn clone(&self) -> WlShellSurface
fn clone(&self) -> WlShellSurface
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for WlShellSurface
impl Debug for WlShellSurface
source§impl Hash for WlShellSurface
impl Hash for WlShellSurface
source§impl PartialEq<Weak<WlShellSurface>> for WlShellSurface
impl PartialEq<Weak<WlShellSurface>> for WlShellSurface
source§impl PartialEq for WlShellSurface
impl PartialEq for WlShellSurface
source§fn eq(&self, other: &WlShellSurface) -> bool
fn eq(&self, other: &WlShellSurface) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl Proxy for WlShellSurface
impl Proxy for WlShellSurface
source§fn data<U: Send + Sync + 'static>(&self) -> Option<&U>
fn data<U: Send + Sync + 'static>(&self) -> Option<&U>
source§fn object_data(&self) -> Option<&Arc<dyn ObjectData>>
fn object_data(&self) -> Option<&Arc<dyn ObjectData>>
source§fn backend(&self) -> &WeakBackend
fn backend(&self) -> &WeakBackend
source§fn send_request(&self, req: Self::Request<'_>) -> Result<(), InvalidId>
fn send_request(&self, req: Self::Request<'_>) -> Result<(), InvalidId>
source§fn send_constructor<I: Proxy>(
&self,
req: Self::Request<'_>,
data: Arc<dyn ObjectData>,
) -> Result<I, InvalidId>
fn send_constructor<I: Proxy>( &self, req: Self::Request<'_>, data: Arc<dyn ObjectData>, ) -> Result<I, InvalidId>
source§fn from_id(conn: &Connection, id: ObjectId) -> Result<Self, InvalidId>
fn from_id(conn: &Connection, id: ObjectId) -> Result<Self, InvalidId>
source§fn inert(backend: WeakBackend) -> Self
fn inert(backend: WeakBackend) -> Self
source§fn parse_event(
conn: &Connection,
msg: Message<ObjectId, OwnedFd>,
) -> Result<(Self, Self::Event), DispatchError>
fn parse_event( conn: &Connection, msg: Message<ObjectId, OwnedFd>, ) -> Result<(Self, Self::Event), DispatchError>
source§fn write_request<'a>(
&self,
conn: &Connection,
msg: Self::Request<'a>,
) -> Result<(Message<ObjectId, BorrowedFd<'a>>, Option<(&'static Interface, u32)>), InvalidId>
fn write_request<'a>( &self, conn: &Connection, msg: Self::Request<'a>, ) -> Result<(Message<ObjectId, BorrowedFd<'a>>, Option<(&'static Interface, u32)>), InvalidId>
impl Eq for WlShellSurface
Auto Trait Implementations§
impl Freeze for WlShellSurface
impl !RefUnwindSafe for WlShellSurface
impl Send for WlShellSurface
impl Sync for WlShellSurface
impl Unpin for WlShellSurface
impl !UnwindSafe for WlShellSurface
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.