Struct ms_oforms::controls::ole_site_concrete::SiteFlags

pub struct SiteFlags { /* fields omitted */ }

Specifies Boolean properties of an embedded control on a form.

Unless otherwise specified, each bit applies to all control types. All bits that do not apply to a particular type of control MUST be set to zero for that control.

Methods

impl SiteFlags

pub const TAB_STOP: SiteFlags

Specifies whether the control can receive focus while the user is navigating controls using the TAB key.

pub const VISIBLE: SiteFlags

Specifies whether the control is displayed.

pub const DEFAULT: SiteFlags

Specifies whether the control is the default option on the form.

pub const CANCEL: SiteFlags

Specifies whether the control is the cancel option on the form.

pub const STREAMED: SiteFlags

Specifies whether the control is stored in the Object stream of the form. A value of zero specifies that the control has its own storage.

pub const AUTO_SIZE: SiteFlags

Specifies whether the control automatically resizes to display its entire contents.

pub const PRESERVE_HEIGHT: SiteFlags

Specifies whether to preserve the height of a control when resizing. Applies to ListBox.

pub const FIT_TO_PARENT: SiteFlags

Specifies whether to adjust the size of a control when the size of its parent changes.

pub const SELECT_CHILD: SiteFlags

Specifies whether to select the first child of a container control when the container control is the next control to which the user is navigating.

pub const PROMOTE_CONTROLS: SiteFlags

Specifies whether child controls are identified as child objects of the control or as child objects of the parent of the control. MUST be set to 1 for the following controls: Frame, MultiPage and Page. MUST be set to zero for all other controls.

pub fn empty() -> SiteFlags

Returns an empty set of flags.

pub fn all() -> SiteFlags

Returns the set containing all flags.

pub fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

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

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

pub fn from_bits_truncate(bits: u32) -> SiteFlags

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

pub fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub fn is_all(&self) -> bool

Returns true if all flags are currently set.

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Clone for SiteFlags

fn clone(&self) -> SiteFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Extend<SiteFlags> for SiteFlags

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

Extends a collection with the contents of an iterator.

impl PartialEq<SiteFlags> for SiteFlags

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

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

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

This method tests for !=.

impl PartialOrd<SiteFlags> for SiteFlags

fn partial_cmp(&self, other: &SiteFlags) -> Option<Ordering>

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

fn lt(&self, other: &SiteFlags) -> bool

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

fn le(&self, other: &SiteFlags) -> bool

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

fn gt(&self, other: &SiteFlags) -> bool

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

fn ge(&self, other: &SiteFlags) -> bool

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

impl Eq for SiteFlags

impl Ord for SiteFlags

fn cmp(&self, other: &SiteFlags) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl Copy for SiteFlags

impl Debug for SiteFlags

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

Formats the value using the given formatter.

impl Sub<SiteFlags> for SiteFlags

type Output = SiteFlags

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<SiteFlags> for SiteFlags

fn sub_assign(&mut self, other: SiteFlags)

Disables all flags enabled in the set.

impl Not for SiteFlags

type Output = SiteFlags

The resulting type after applying the ! operator.

fn not(self) -> SiteFlags

Returns the complement of this set of flags.

impl BitAnd<SiteFlags> for SiteFlags

type Output = SiteFlags

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitOr<SiteFlags> for SiteFlags

type Output = SiteFlags

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitXor<SiteFlags> for SiteFlags

type Output = SiteFlags

The resulting type after applying the ^ operator.

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

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

impl BitAndAssign<SiteFlags> for SiteFlags

fn bitand_assign(&mut self, other: SiteFlags)

Disables all flags disabled in the set.

impl BitOrAssign<SiteFlags> for SiteFlags

fn bitor_assign(&mut self, other: SiteFlags)

Adds the set of flags.

impl BitXorAssign<SiteFlags> for SiteFlags

fn bitxor_assign(&mut self, other: SiteFlags)

Toggles the set of flags.

impl Hash for SiteFlags

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl FromIterator<SiteFlags> for SiteFlags

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

Creates a value from an iterator.

impl Octal for SiteFlags

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

Formats the value using the given formatter.

impl Binary for SiteFlags

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

Formats the value using the given formatter.

impl LowerHex for SiteFlags

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

Formats the value using the given formatter.

impl UpperHex for SiteFlags

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

Formats the value using the given formatter.