Struct ms_oforms::controls::user_form::stream::FormPropMask

pub struct FormPropMask(_);

Specifies the properties of the control that are not set to the file format default.

For each bit, a value of zero specifies that the corresponding property is the file format default and is not stored in the file.

Implementations

impl FormPropMask

pub const BACK_COLOR: Self = _

Specifies whether the BackColor property is stored in the DataBlock.BackColor of the FormControl that contains this FormPropMask.

pub const FORE_COLOR: Self = _

Specifies whether the ForeColor property is stored in the DataBlock.ForeColor of the FormControl that contains this FormPropMask.

pub const NEXT_AVAILABLE_ID: Self = _

Specifies whether the NextAvailableID property is stored in the DataBlock.NextAvailableID of the FormControl that contains this FormPropMask.

pub const BOOLEAN_PROPERTIES: Self = _

Specifies whether the BooleanProperties property is stored in the DataBlock.BooleanProperties of the FormControl that contains this FormPropMask.

pub const BORDER_STYLE: Self = _

Specifies whether the BorderStyle property is stored in the DataBlock.BorderStyle of the FormControl that contains this FormPropMask.

pub const MOUSE_POINTER: Self = _

Specifies whether the MousePointer property is stored in the DataBlock.MousePointer of the FormControl that contains this FormPropMask.

pub const SCROLL_BARS: Self = _

Specifies whether the ScrollBars property is stored in the DataBlock.ScrollBars of the FormControl that contains this FormPropMask.

pub const DISPLAYED_SIZE: Self = _

Specifies whether the DisplayedSize property is stored in the ExtraDataBlock.DisplayedSize of the FormControl that contains this FormPropMask.

pub const LOGICAL_SIZE: Self = _

Specifies whether the LogicalSize property is stored in the ExtraDataBlock.LogicalSize of the FormControl that contains this FormPropMask.

pub const SCROLL_POSITION: Self = _

Specifies whether the ScrollPosition property is stored in the ExtraDataBlock.ScrollPosition of the FormControl that contains this FormPropMask.

pub const GROUP_CNT: Self = _

Specifies whether the GroupCount property is stored in the DataBlock.GroupCnt of the FormControl that contains this FormPropMask.

pub const MOUSE_ICON: Self = _

Specifies whether the MouseIcon property is stored in the StreamData.MouseIcon of the FormControl that contains this FormPropMask. When this bit is set to 1, a value of 0xFFFF MUST be stored in the DataBlock.MouseIcon of the FormControl.

pub const CYCLE: Self = _

Specifies whether the Cycle property is stored in the DataBlock.Cycle of the FormControl that contains this FormPropMask.

pub const SPECIAL_EFFECT: Self = _

Specifies whether the SpecialEffect property is stored in the DataBlock.SpecialEffect of the FormControl that contains this FormPropMask.

pub const BORDER_COLOR: Self = _

Specifies whether the BorderColor property is stored in the DataBlock.BorderColor of the FormControl that contains this FormPropMask.

pub const CAPTION: Self = _

Specifies whether the size and compression flag of the Caption property are stored in the DataBlock.LengthAndCompression of the FormControl that contains this FormPropMask and the Caption string is stored in the ExtraDataBlock.Caption of the FormControl.

pub const FONT: Self = _

Specifies whether the Font property is stored in the StreamData.GuidAndFont of the FormControl that contains this FormPropMask.

pub const PICTURE: Self = _

Specifies whether the Picture property is stored in the StreamData.Picture of the FormControl that contains this FormPropMask.

pub const ZOOM: Self = _

Specifies whether the Zoom property is stored in the DataBlock.Zoom of the FormControl that contains this FormPropMask.

pub const PICTURE_ALIGNMENT: Self = _

Specifies whether the PictureAlignment property is stored in the DataBlock.PictureAlignment of the FormControl that contains this FormPropMask.

pub const PICTURE_TILING: Self = _

Specifies whether the value of the PictureTiling property is not the file format default.

pub const PICTURE_SIZE_MODE: Self = _

Specifies whether the PictureSizeMode property is stored in the DataBlock.PictureSizeMode of the FormControl that contains this FormPropMask.

pub const SHAPE_COOKIE: Self = _

Specifies whether the ShapeCookie property is stored in the DataBlock.ShapeCookie of the FormControl that contains this FormPropMask.

pub const DRAW_BUFFER: Self = _

Specifies whether the DrawBuffer property is stored in the DataBlock.DrawBuffer of the FormControl that contains this FormPropMask. MUST be set to 1.

impl FormPropMask

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> u32

Get the underlying bits value.

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

pub const fn from_bits(bits: u32) -> Option<Self>

Convert from a bits value.

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

pub const fn from_bits_truncate(bits: u32) -> Self

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u32) -> Self

Convert from a bits value exactly.

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

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: Self) -> bool

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

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

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

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

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

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

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: Self)

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

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

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

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

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

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

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

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

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: Self) -> Self

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

pub const fn complement(self) -> Self

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

impl FormPropMask

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

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<FormPropMask>

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 FormPropMask

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

Formats the value using the given formatter.

impl BitAnd<FormPropMask> for FormPropMask

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

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

type Output = FormPropMask

The resulting type after applying the & operator.

impl BitAndAssign<FormPropMask> for FormPropMask

fn bitand_assign(&mut self, other: Self)

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

impl BitOr<FormPropMask> for FormPropMask

fn bitor(self, other: FormPropMask) -> Self

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

type Output = FormPropMask

The resulting type after applying the | operator.

impl BitOrAssign<FormPropMask> for FormPropMask

fn bitor_assign(&mut self, other: Self)

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

impl BitXor<FormPropMask> for FormPropMask

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

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

type Output = FormPropMask

The resulting type after applying the ^ operator.

impl BitXorAssign<FormPropMask> for FormPropMask

fn bitxor_assign(&mut self, other: Self)

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

impl Extend<FormPropMask> for FormPropMask

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

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 FormPropMask

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

The set of defined flags.

type Bits = u32

The underlying bits type.

fn bits(&self) -> u32

Get the underlying bits value.

fn from_bits_retain(bits: u32) -> FormPropMask

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) -> boolwhere Self: Sized,

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

fn contains(&self, other: Self) -> boolwhere 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 FromIterator<FormPropMask> for FormPropMask

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

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

impl IntoIterator for FormPropMask

type Item = FormPropMask

The type of the elements being iterated over.

type IntoIter = Iter<FormPropMask>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for FormPropMask

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

Formats the value using the given formatter.

impl Not for FormPropMask

fn not(self) -> Self

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

type Output = FormPropMask

The resulting type after applying the ! operator.

impl Octal for FormPropMask

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

Formats the value using the given formatter.

impl PublicFlags for FormPropMask

type Primitive = u32

The type of the underlying storage.

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.

impl Sub<FormPropMask> for FormPropMask

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

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 = FormPropMask

The resulting type after applying the - operator.

impl SubAssign<FormPropMask> for FormPropMask

fn sub_assign(&mut self, other: Self)

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 FormPropMask

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

Formats the value using the given formatter.