Struct zng::scroll::ScrollMode

pub struct ScrollMode(/* private fields */);

What dimensions are scrollable in a widget.

If a dimension is scrollable the content can be any size in that dimension, if the size is more then available scrolling is enabled for that dimension.

Implementations

impl ScrollMode

pub const NONE: ScrollMode = _

Content size is constrained by the viewport and is not scrollable.

pub const VERTICAL: ScrollMode = _

Content can be any height and scrolls vertically if overflow height.

pub const HORIZONTAL: ScrollMode = _

Content can be any width and scrolls horizontally if overflow width.

pub const PAN: ScrollMode = _

Content can be any size and scrolls if overflow.

pub const ZOOM: ScrollMode = _

Content can be any size and scrolls if overflow (PAN) and also can be scaled up and down by zoom commands and gestures.

impl ScrollMode

pub const fn empty() -> ScrollMode

Get a flags value with all bits unset.

pub const fn all() -> ScrollMode

Get a flags value with all known bits set.

pub const fn bits(&self) -> u8

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: u8) -> Option<ScrollMode>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u8) -> ScrollMode

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u8) -> ScrollMode

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<ScrollMode>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

pub const fn intersects(&self, other: ScrollMode) -> bool

Whether any set bits in a source flags value are also set in a target flags value.

pub const fn contains(&self, other: ScrollMode) -> bool

Whether all set bits in a source flags value are also set in a target flags value.

pub fn insert(&mut self, other: ScrollMode)

The bitwise or (|) of the bits in two flags values.

pub fn remove(&mut self, other: ScrollMode)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

pub fn toggle(&mut self, other: ScrollMode)

The bitwise exclusive-or (^) of the bits in two flags values.

pub fn set(&mut self, other: ScrollMode, value: bool)

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: ScrollMode) -> ScrollMode

The bitwise and (&) of the bits in two flags values.

pub const fn union(self, other: ScrollMode) -> ScrollMode

The bitwise or (|) of the bits in two flags values.

pub const fn difference(self, other: ScrollMode) -> ScrollMode

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: ScrollMode) -> ScrollMode

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> ScrollMode

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl ScrollMode

pub const fn iter(&self) -> Iter<ScrollMode>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<ScrollMode>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

Trait Implementations

impl Binary for ScrollMode

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

Formats the value using the given formatter.

impl BitAnd for ScrollMode

fn bitand(self, other: ScrollMode) -> ScrollMode

The bitwise and (&) of the bits in two flags values.

type Output = ScrollMode

The resulting type after applying the & operator.

impl BitAndAssign for ScrollMode

fn bitand_assign(&mut self, other: ScrollMode)

The bitwise and (&) of the bits in two flags values.

impl BitOr for ScrollMode

fn bitor(self, other: ScrollMode) -> ScrollMode

The bitwise or (|) of the bits in two flags values.

type Output = ScrollMode

The resulting type after applying the | operator.

impl BitOrAssign for ScrollMode

fn bitor_assign(&mut self, other: ScrollMode)

The bitwise or (|) of the bits in two flags values.

impl BitXor for ScrollMode

fn bitxor(self, other: ScrollMode) -> ScrollMode

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = ScrollMode

The resulting type after applying the ^ operator.

impl BitXorAssign for ScrollMode

fn bitxor_assign(&mut self, other: ScrollMode)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for ScrollMode

fn clone(&self) -> ScrollMode

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ScrollMode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ScrollMode

fn deserialize<__D>( __deserializer: __D, ) -> Result<ScrollMode, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Extend<ScrollMode> for ScrollMode

fn extend<T>(&mut self, iterator: T)

where T: IntoIterator<Item = ScrollMode>,

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

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 Flags for ScrollMode

const FLAGS: &'static [Flag<ScrollMode>] = _

The set of defined flags.

type Bits = u8

The underlying bits type.

fn bits(&self) -> u8

Get the underlying bits value.

fn from_bits_retain(bits: u8) -> ScrollMode

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

fn intersects(&self, other: Self) -> bool

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

fn contains(&self, other: Self) -> bool

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

fn set(&mut self, other: Self, value: bool)

where Self: Sized,

Call [Flags::insert] when value is true or [Flags::remove] when value is false.

fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl From<bool> for ScrollMode

fn from(zoom: bool) -> ScrollMode

Returns ZOOM for true and NONE for false.

impl FromIterator<ScrollMode> for ScrollMode

fn from_iter<T>(iterator: T) -> ScrollMode

where T: IntoIterator<Item = ScrollMode>,

The bitwise or (|) of the bits in each flags value.

impl Hash for ScrollMode

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoIterator for ScrollMode

type Item = ScrollMode

The type of the elements being iterated over.

type IntoIter = Iter<ScrollMode>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <ScrollMode as IntoIterator>::IntoIter

Creates an iterator from a value.

impl IntoVar<ScrollMode> for bool

fn into_var(self) -> <bool as IntoVar<ScrollMode>>::Var

Returns ZOOM for true and NONE for false.

type Var = LocalVar<ScrollMode>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl LowerHex for ScrollMode

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

Formats the value using the given formatter.

impl Not for ScrollMode

fn not(self) -> ScrollMode

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = ScrollMode

The resulting type after applying the ! operator.

impl Octal for ScrollMode

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

Formats the value using the given formatter.

impl PartialEq for ScrollMode

fn eq(&self, other: &ScrollMode) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ScrollMode

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for ScrollMode

fn sub(self, other: ScrollMode) -> ScrollMode

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = ScrollMode

The resulting type after applying the - operator.

impl SubAssign for ScrollMode

fn sub_assign(&mut self, other: ScrollMode)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for ScrollMode

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

Formats the value using the given formatter.

impl Copy for ScrollMode

impl Eq for ScrollMode

impl IntoValue<ScrollMode> for bool

impl StructuralPartialEq for ScrollMode