Struct wayland_protocols::unstable::xdg_shell::v6::client::zxdg_positioner_v6::ZxdgPositionerV6
source · [−]pub struct ZxdgPositionerV6(_);
Implementations
sourceimpl ZxdgPositionerV6
impl ZxdgPositionerV6
sourcepub fn destroy(&self)
pub fn destroy(&self)
destroy the xdg_positioner object
Notify the compositor that the xdg_positioner will no longer be used.
This is a destructor, you cannot send requests to this object any longer once this method is called.
sourcepub fn set_size(&self, width: i32, height: i32)
pub fn set_size(&self, width: i32, height: i32)
set the size of the to-be positioned rectangle
Set the size of the surface that is to be positioned with the positioner object. The size is in surface-local coordinates and corresponds to the window geometry. See xdg_surface.set_window_geometry.
If a zero or negative size is set the invalid_input error is raised.
sourcepub fn set_anchor_rect(&self, x: i32, y: i32, width: i32, height: i32)
pub fn set_anchor_rect(&self, x: i32, y: i32, width: i32, height: i32)
set the anchor rectangle within the parent surface
Specify the anchor rectangle within the parent surface that the child surface will be placed relative to. The rectangle is relative to the window geometry as defined by xdg_surface.set_window_geometry of the parent surface. The rectangle must be at least 1x1 large.
When the xdg_positioner object is used to position a child surface, the anchor rectangle may not extend outside the window geometry of the positioned child’s parent surface.
If a zero or negative size is set the invalid_input error is raised.
sourcepub fn set_anchor(&self, anchor: Anchor)
pub fn set_anchor(&self, anchor: Anchor)
set anchor rectangle anchor edges
Defines a set of edges for the anchor rectangle. These are used to derive an anchor point that the child surface will be positioned relative to. If two orthogonal edges are specified (e.g. ‘top’ and ‘left’), then the anchor point will be the intersection of the edges (e.g. the top left position of the rectangle); otherwise, the derived anchor point will be centered on the specified edge, or in the center of the anchor rectangle if no edge is specified.
If two parallel anchor edges are specified (e.g. ‘left’ and ‘right’), the invalid_input error is raised.
sourcepub fn set_gravity(&self, gravity: Gravity)
pub fn set_gravity(&self, gravity: Gravity)
set child surface gravity
Defines in what direction a surface should be positioned, relative to the anchor point of the parent surface. If two orthogonal gravities are specified (e.g. ‘bottom’ and ‘right’), then the child surface will be placed in the specified direction; otherwise, the child surface will be centered over the anchor point on any axis that had no gravity specified.
If two parallel gravities are specified (e.g. ‘left’ and ‘right’), the invalid_input error is raised.
sourcepub fn set_constraint_adjustment(&self, constraint_adjustment: u32)
pub fn set_constraint_adjustment(&self, constraint_adjustment: u32)
set the adjustment to be done when constrained
Specify how the window should be positioned if the originally intended position caused the surface to be constrained, meaning at least partially outside positioning boundaries set by the compositor. The adjustment is set by constructing a bitmask describing the adjustment to be made when the surface is constrained on that axis.
If no bit for one axis is set, the compositor will assume that the child surface should not change its position on that axis when constrained.
If more than one bit for one axis is set, the order of how adjustments are applied is specified in the corresponding adjustment descriptions.
The default adjustment is none.
sourcepub fn set_offset(&self, x: i32, y: i32)
pub fn set_offset(&self, x: i32, y: i32)
set surface position offset
Specify the surface position offset relative to the position of the anchor on the anchor rectangle and the anchor on the surface. For example if the anchor of the anchor rectangle is at (x, y), the surface has the gravity bottom|right, and the offset is (ox, oy), the calculated surface position will be (x + ox, y + oy). The offset position of the surface is the one used for constraint testing. See set_constraint_adjustment.
An example use case is placing a popup menu on top of a user interface element, while aligning the user interface element of the parent surface with some user interface element placed somewhere in the popup surface.
Trait Implementations
sourceimpl AsRef<Proxy<ZxdgPositionerV6>> for ZxdgPositionerV6
impl AsRef<Proxy<ZxdgPositionerV6>> for ZxdgPositionerV6
sourceimpl Clone for ZxdgPositionerV6
impl Clone for ZxdgPositionerV6
sourcefn clone(&self) -> ZxdgPositionerV6
fn clone(&self) -> ZxdgPositionerV6
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for ZxdgPositionerV6
impl Debug for ZxdgPositionerV6
sourceimpl From<Proxy<ZxdgPositionerV6>> for ZxdgPositionerV6
impl From<Proxy<ZxdgPositionerV6>> for ZxdgPositionerV6
sourceimpl From<ZxdgPositionerV6> for Proxy<ZxdgPositionerV6>
impl From<ZxdgPositionerV6> for Proxy<ZxdgPositionerV6>
sourcefn from(value: ZxdgPositionerV6) -> Self
fn from(value: ZxdgPositionerV6) -> Self
Converts to this type from the input type.
sourceimpl Interface for ZxdgPositionerV6
impl Interface for ZxdgPositionerV6
sourcefn c_interface() -> *const wl_interface
fn c_interface() -> *const wl_interface
Pointer to the C representation of this interface
sourceimpl PartialEq<ZxdgPositionerV6> for ZxdgPositionerV6
impl PartialEq<ZxdgPositionerV6> for ZxdgPositionerV6
sourcefn eq(&self, other: &ZxdgPositionerV6) -> bool
fn eq(&self, other: &ZxdgPositionerV6) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
impl Eq for ZxdgPositionerV6
impl StructuralEq for ZxdgPositionerV6
impl StructuralPartialEq for ZxdgPositionerV6
Auto Trait Implementations
impl !RefUnwindSafe for ZxdgPositionerV6
impl Send for ZxdgPositionerV6
impl Sync for ZxdgPositionerV6
impl Unpin for ZxdgPositionerV6
impl !UnwindSafe for ZxdgPositionerV6
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
Convert 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
. Read more
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more
fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert &Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert &mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read more