Struct WindowFlags 

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

Configuration flags for windows

Implementations

impl WindowFlags

pub const NO_TITLE_BAR: Self

Disable title-bar

pub const NO_RESIZE: Self

Disable user resizing with the lower-right grip

pub const NO_MOVE: Self

Disable user moving the window

pub const NO_SCROLLBAR: Self

Disable scrollbars (window can still scroll with mouse or programmatically)

pub const NO_SCROLL_WITH_MOUSE: Self

Disable user vertically scrolling with mouse wheel

pub const NO_COLLAPSE: Self

Disable user collapsing window by double-clicking on it

pub const ALWAYS_AUTO_RESIZE: Self

Resize every window to its content every frame

pub const NO_BACKGROUND: Self

Disable drawing background color (WindowBg, etc.) and outside border

pub const NO_SAVED_SETTINGS: Self

Never load/save settings in .ini file

pub const NO_MOUSE_INPUTS: Self

Disable catching mouse, hovering test with pass through

pub const MENU_BAR: Self

Has a menu-bar

pub const HORIZONTAL_SCROLLBAR: Self

Allow horizontal scrollbar to appear (off by default)

pub const NO_FOCUS_ON_APPEARING: Self

Disable taking focus when transitioning from hidden to visible state

pub const NO_BRING_TO_FRONT_ON_FOCUS: Self

Disable bringing window to front when taking focus (e.g. clicking on it or programmatically giving it focus)

pub const ALWAYS_VERTICAL_SCROLLBAR: Self

Always show vertical scrollbar (even if ContentSize.y < Size.y)

pub const ALWAYS_HORIZONTAL_SCROLLBAR: Self

Always show horizontal scrollbar (even if ContentSize.x < Size.x)

pub const NO_NAV_INPUTS: Self

No gamepad/keyboard navigation within the window

pub const NO_NAV_FOCUS: Self

No focusing toward this window with gamepad/keyboard navigation (e.g. skipped by CTRL+TAB)

pub const UNSAVED_DOCUMENT: Self

Display a dot next to the title. When used in a tab/docking context, tab is selected when clicking the X + closure is not assumed (will wait for user to stop submitting the tab). Otherwise closure is assumed when pressing the X, so if you keep submitting the tab may reappear at end of tab bar.

pub const NO_DOCKING: Self

Disable docking for this window (the window will not be able to dock into another and others won’t be able to dock into it)

pub const DOCK_NODE_HOST: Self

Indicate this window is a dock node host. Generally set by imgui internally when hosting a DockSpace.

pub const NO_NAV: Self

Disable gamepad/keyboard navigation and focusing

pub const NO_DECORATION: Self

Disable all window decorations

pub const NO_INPUTS: Self

Disable all user interactions

impl WindowFlags

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) -> i32

Get the underlying bits value.

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

pub const fn from_bits(bits: i32) -> 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: i32) -> Self

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: i32) -> 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 WindowFlags

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

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

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 WindowFlags

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

Formats the value using the given formatter.

impl BitAnd for WindowFlags

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

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

type Output = WindowFlags

The resulting type after applying the & operator.

impl BitAndAssign for WindowFlags

fn bitand_assign(&mut self, other: Self)

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

impl BitOr for WindowFlags

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

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

type Output = WindowFlags

The resulting type after applying the | operator.

impl BitOrAssign for WindowFlags

fn bitor_assign(&mut self, other: Self)

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

impl BitXor for WindowFlags

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

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

type Output = WindowFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for WindowFlags

fn bitxor_assign(&mut self, other: Self)

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

impl Clone for WindowFlags

fn clone(&self) -> WindowFlags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WindowFlags

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

Formats the value using the given formatter.

impl Extend<WindowFlags> for WindowFlags

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 WindowFlags

const FLAGS: &'static [Flag<WindowFlags>]

The set of defined flags.

type Bits = i32

The underlying bits type.

fn bits(&self) -> i32

Get the underlying bits value.

fn from_bits_retain(bits: i32) -> WindowFlags

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 contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are 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 iter_defined_names() -> IterDefinedNames<Self>

Yield a set of all named flags defined by Self::FLAGS.

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 truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

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 clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

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<WindowFlags> for WindowFlags

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

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

impl Hash for WindowFlags

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

Feeds a slice of this type into the given Hasher.

impl IntoIterator for WindowFlags

type Item = WindowFlags

The type of the elements being iterated over.

type IntoIter = Iter<WindowFlags>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for WindowFlags

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

Formats the value using the given formatter.

impl Not for WindowFlags

fn not(self) -> Self

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

type Output = WindowFlags

The resulting type after applying the ! operator.

impl Octal for WindowFlags

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

Formats the value using the given formatter.

impl PartialEq for WindowFlags

fn eq(&self, other: &WindowFlags) -> 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 PublicFlags for WindowFlags

type Primitive = i32

The type of the underlying storage.

type Internal = InternalBitFlags

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

impl Sub for WindowFlags

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

The resulting type after applying the - operator.

impl SubAssign for WindowFlags

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 WindowFlags

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

Formats the value using the given formatter.

impl Copy for WindowFlags

impl Eq for WindowFlags

impl StructuralPartialEq for WindowFlags