Struct wayland_protocols::unstable::xdg_shell::v6::client::zxdg_positioner_v6::ConstraintAdjustment

pub struct ConstraintAdjustment { /* fields omitted */ }

[−] Expand description

constraint adjustments

The constraint adjustment value define ways the compositor will adjust the position of the surface, if the unadjusted position would result in the surface being partly constrained.

Whether a surface is considered ‘constrained’ is left to the compositor to determine. For example, the surface may be partly outside the compositor’s defined ‘work area’, thus necessitating the child surface’s position be adjusted until it is entirely inside the work area.

The adjustments can be combined, according to a defined precedence: 1) Flip, 2) Slide, 3) Resize.

Implementations

impl ConstraintAdjustment[−]

pub const None: ConstraintAdjustment[−][−]

don’t move the child surface when constrained

Don’t alter the surface position even if it is constrained on some axis, for example partially outside the edge of a monitor.

pub const SlideX: ConstraintAdjustment[−][−]

move along the x axis until unconstrained

Slide the surface along the x axis until it is no longer constrained.

First try to slide towards the direction of the gravity on the x axis until either the edge in the opposite direction of the gravity is unconstrained or the edge in the direction of the gravity is constrained.

Then try to slide towards the opposite direction of the gravity on the x axis until either the edge in the direction of the gravity is unconstrained or the edge in the opposite direction of the gravity is constrained.

pub const SlideY: ConstraintAdjustment[−][−]

move along the y axis until unconstrained

Slide the surface along the y axis until it is no longer constrained.

First try to slide towards the direction of the gravity on the y axis until either the edge in the opposite direction of the gravity is unconstrained or the edge in the direction of the gravity is constrained.

Then try to slide towards the opposite direction of the gravity on the y axis until either the edge in the direction of the gravity is unconstrained or the edge in the opposite direction of the gravity is constrained.

pub const FlipX: ConstraintAdjustment[−][−]

invert the anchor and gravity on the x axis

Invert the anchor and gravity on the x axis if the surface is constrained on the x axis. For example, if the left edge of the surface is constrained, the gravity is ‘left’ and the anchor is ‘left’, change the gravity to ‘right’ and the anchor to ‘right’.

If the adjusted position also ends up being constrained, the resulting position of the flip_x adjustment will be the one before the adjustment.

pub const FlipY: ConstraintAdjustment[−][−]

invert the anchor and gravity on the y axis

Invert the anchor and gravity on the y axis if the surface is constrained on the y axis. For example, if the bottom edge of the surface is constrained, the gravity is ‘bottom’ and the anchor is ‘bottom’, change the gravity to ‘top’ and the anchor to ‘top’.

If the adjusted position also ends up being constrained, the resulting position of the flip_y adjustment will be the one before the adjustment.

pub const ResizeX: ConstraintAdjustment[−][−]

horizontally resize the surface

Resize the surface horizontally so that it is completely unconstrained.

pub const ResizeY: ConstraintAdjustment[−][−]

vertically resize the surface

Resize the surface vertically so that it is completely unconstrained.

pub const fn empty() -> ConstraintAdjustment[−]

Returns an empty set of flags

pub const fn all() -> ConstraintAdjustment[−]

Returns the set containing all flags.

pub const fn bits(&self) -> u32[−]

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u32) -> Option<ConstraintAdjustment>[−]

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u32) -> ConstraintAdjustment[−]

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u32) -> ConstraintAdjustment[−]

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool[−]

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool[−]

Returns true if all flags are currently set.

pub const fn intersects(&self, other: ConstraintAdjustment) -> bool[−]

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: ConstraintAdjustment) -> bool[−]

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: ConstraintAdjustment)[−]

Inserts the specified flags in-place.

pub fn remove(&mut self, other: ConstraintAdjustment)[−]

Removes the specified flags in-place.

pub fn toggle(&mut self, other: ConstraintAdjustment)[−]

Toggles the specified flags in-place.

pub fn set(&mut self, other: ConstraintAdjustment, value: bool)[−]

Inserts or removes the specified flags depending on the passed value.

impl ConstraintAdjustment[−]

pub fn from_raw(n: u32) -> Option<ConstraintAdjustment>

pub fn to_raw(&self) -> u32

Trait Implementations

impl Binary for ConstraintAdjustment[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter<'_>) -> Result[−]

Formats the value using the given formatter.

impl BitAnd<ConstraintAdjustment> for ConstraintAdjustment[+]

type Output = ConstraintAdjustment

The resulting type after applying the & operator.

fn bitand(self, other: ConstraintAdjustment) -> ConstraintAdjustment[−]

Returns the intersection between the two sets of flags.

impl BitAndAssign<ConstraintAdjustment> for ConstraintAdjustment[+]

fn bitand_assign(&mut self, other: ConstraintAdjustment)[−]

Disables all flags disabled in the set.

impl BitOr<ConstraintAdjustment> for ConstraintAdjustment[+]

type Output = ConstraintAdjustment

The resulting type after applying the | operator.

fn bitor(self, other: ConstraintAdjustment) -> ConstraintAdjustment[−]

Returns the union of the two sets of flags.

impl BitOrAssign<ConstraintAdjustment> for ConstraintAdjustment[+]

fn bitor_assign(&mut self, other: ConstraintAdjustment)[−]

Adds the set of flags.

impl BitXor<ConstraintAdjustment> for ConstraintAdjustment[+]

type Output = ConstraintAdjustment

The resulting type after applying the ^ operator.

fn bitxor(self, other: ConstraintAdjustment) -> ConstraintAdjustment[−]

Returns the left flags, but with all the right flags toggled.

impl BitXorAssign<ConstraintAdjustment> for ConstraintAdjustment[+]

fn bitxor_assign(&mut self, other: ConstraintAdjustment)[−]

Toggles the set of flags.

impl Clone for ConstraintAdjustment[+]

[+] Show hidden undocumented items

fn clone(&self) -> ConstraintAdjustment[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Copy for ConstraintAdjustment

impl Debug for ConstraintAdjustment[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter<'_>) -> Result[−]

Formats the value using the given formatter.

impl Eq for ConstraintAdjustment

impl Extend<ConstraintAdjustment> for ConstraintAdjustment[+]

[+] Show hidden undocumented items

fn extend<T: IntoIterator<Item = ConstraintAdjustment>>(&mut self, iterator: T)[−]

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)[−]

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

pub fn extend_reserve(&mut self, additional: usize)[−]

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<ConstraintAdjustment> for ConstraintAdjustment[+]

[+] Show hidden undocumented items

fn from_iter<T: IntoIterator<Item = ConstraintAdjustment>>(
    iterator: T
) -> ConstraintAdjustment[−]

Creates a value from an iterator.

impl Hash for ConstraintAdjustment[+]

[+] Show hidden undocumented items

fn hash<__H: Hasher>(&self, state: &mut __H)[−]

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, [−]

Feeds a slice of this type into the given Hasher.

impl LowerHex for ConstraintAdjustment[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter<'_>) -> Result[−]

Formats the value using the given formatter.

impl Not for ConstraintAdjustment[+]

type Output = ConstraintAdjustment

The resulting type after applying the ! operator.

fn not(self) -> ConstraintAdjustment[−]

Returns the complement of this set of flags.

impl Octal for ConstraintAdjustment[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter<'_>) -> Result[−]

Formats the value using the given formatter.

impl Ord for ConstraintAdjustment[+]

[+] Show hidden undocumented items

fn cmp(&self, other: &ConstraintAdjustment) -> Ordering[−]

This method returns an Ordering between self and other.

#[must_use]

pub fn max(self, other: Self) -> Self[−]

Compares and returns the maximum of two values.

#[must_use]

pub fn min(self, other: Self) -> Self[−]

Compares and returns the minimum of two values.

#[must_use]

pub fn clamp(self, min: Self, max: Self) -> Self[−]

Restrict a value to a certain interval.

impl PartialEq<ConstraintAdjustment> for ConstraintAdjustment[+]

[+] Show hidden undocumented items

fn eq(&self, other: &ConstraintAdjustment) -> bool[−]

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ConstraintAdjustment) -> bool[−]

This method tests for !=.

impl PartialOrd<ConstraintAdjustment> for ConstraintAdjustment[+]

[+] Show hidden undocumented items

fn partial_cmp(&self, other: &ConstraintAdjustment) -> Option<Ordering>[−]

This method returns an ordering between self and other values if one exists.

#[must_use]

pub fn lt(&self, other: &Rhs) -> bool[−]

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

pub fn le(&self, other: &Rhs) -> bool[−]

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

pub fn gt(&self, other: &Rhs) -> bool[−]

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

pub fn ge(&self, other: &Rhs) -> bool[−]

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for ConstraintAdjustment

impl StructuralPartialEq for ConstraintAdjustment

impl Sub<ConstraintAdjustment> for ConstraintAdjustment[+]

type Output = ConstraintAdjustment

The resulting type after applying the - operator.

fn sub(self, other: ConstraintAdjustment) -> ConstraintAdjustment[−]

Returns the set difference of the two sets of flags.

impl SubAssign<ConstraintAdjustment> for ConstraintAdjustment[+]

fn sub_assign(&mut self, other: ConstraintAdjustment)[−]

Disables all flags enabled in the set.

impl UpperHex for ConstraintAdjustment[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter<'_>) -> Result[−]

Formats the value using the given formatter.