Struct imgui::WindowFlags

#[repr(transparent)]
pub struct WindowFlags { /* fields omitted */ }

Configuration flags for windows

Methods

impl WindowFlags

pub const NO_TITLE_BAR: WindowFlags

Disable the title bar

pub const NO_RESIZE: WindowFlags

Disable resizing with the lower-right grip

pub const NO_MOVE: WindowFlags

Disable moving the window

pub const NO_SCROLLBAR: WindowFlags

Disable scrollbars (scrolling is still possible with the mouse or programmatically)

pub const NO_SCROLL_WITH_MOUSE: WindowFlags

Disable vertical scrolling with the mouse wheel.

On child window, the mouse wheel will be forwarded to the parent unless NO_SCROLLBAR is also set.

pub const NO_COLLAPSE: WindowFlags

Disable collapsing the window by double-clicking it

pub const ALWAYS_AUTO_RESIZE: WindowFlags

Resize the window to its content on every frame

pub const NO_BACKGROUND: WindowFlags

Disable drawing of background color and outside border

pub const NO_SAVED_SETTINGS: WindowFlags

Never load/save settings

pub const NO_MOUSE_INPUTS: WindowFlags

Disable catching mouse input. Hovering test will pass through

pub const MENU_BAR: WindowFlags

Show a menu bar

pub const HORIZONTAL_SCROLLBAR: WindowFlags

Allow horizontal scrollbar to appear

pub const NO_FOCUS_ON_APPEARING: WindowFlags

Disable taking focus when transitioning from hidden to visible state

pub const NO_BRING_TO_FRONT_ON_FOCUS: WindowFlags

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

pub const ALWAYS_VERTICAL_SCROLLBAR: WindowFlags

Always show vertical scrollbar

pub const ALWAYS_HORIZONTAL_SCROLLBAR: WindowFlags

Always show horizontal scrollbar

pub const ALWAYS_USE_WINDOW_PADDING: WindowFlags

Ensure child windows without border use style.window_padding

pub const NO_NAV_INPUTS: WindowFlags

Disable gamepad/keyboard navigation within the window

pub const NO_NAV_FOCUS: WindowFlags

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

pub const UNSAVED_DOCUMENT: WindowFlags

Append '*' to title without affecting the ID, as a convenience

pub const NO_NAV: WindowFlags

Disable gamepad/keyboard navigation and focusing.

Shorthand for WindowFlags::NO_NAV_INPUTS | WindowFlags::NO_NAV_FOCUS.

pub const NO_DECORATION: WindowFlags

Disable all window decorations.

Shorthand for WindowFlags::NO_TITLE_BAR | WindowFlags::NO_RESIZE | WindowFlags::NO_SCROLLBAR | WindowFlags::NO_COLLAPSE.

pub const NO_INPUTS: WindowFlags

Don't handle input.

Shorthand for WindowFlags::NO_MOUSE_INPUTS | WindowFlags::NO_NAV_INPUTS | WindowFlags::NO_NAV_FOCUS.

pub const fn empty() -> WindowFlags

Returns an empty set of flags

pub const fn all() -> WindowFlags

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

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

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

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Eq for WindowFlags

impl Extend<WindowFlags> for WindowFlags

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

Extends a collection with the contents of an iterator.

impl Clone for WindowFlags

fn clone(&self) -> WindowFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialOrd<WindowFlags> for WindowFlags

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

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

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

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

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

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

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

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

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

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

impl Ord for WindowFlags

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

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

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

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

This method tests for !=.

impl Copy for WindowFlags

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, 

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

impl Sub<WindowFlags> for WindowFlags

type Output = WindowFlags

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<WindowFlags> for WindowFlags

fn sub_assign(&mut self, other: WindowFlags)

Disables all flags enabled in the set.

impl Not for WindowFlags

type Output = WindowFlags

The resulting type after applying the ! operator.

fn not(self) -> WindowFlags

Returns the complement of this set of flags.

impl BitAnd<WindowFlags> for WindowFlags

type Output = WindowFlags

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitOr<WindowFlags> for WindowFlags

type Output = WindowFlags

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitXor<WindowFlags> for WindowFlags

type Output = WindowFlags

The resulting type after applying the ^ operator.

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

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

impl BitAndAssign<WindowFlags> for WindowFlags

fn bitand_assign(&mut self, other: WindowFlags)

Disables all flags disabled in the set.

impl BitOrAssign<WindowFlags> for WindowFlags

fn bitor_assign(&mut self, other: WindowFlags)

Adds the set of flags.

impl BitXorAssign<WindowFlags> for WindowFlags

fn bitxor_assign(&mut self, other: WindowFlags)

Toggles the set of flags.

impl Debug for WindowFlags

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

Formats the value using the given formatter.

impl FromIterator<WindowFlags> for WindowFlags

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

Creates a value from an iterator.

impl Octal for WindowFlags

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

Formats the value using the given formatter.

impl Binary for WindowFlags

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

Formats the value using the given formatter.

impl LowerHex for WindowFlags

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

Formats the value using the given formatter.

impl UpperHex for WindowFlags

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

Formats the value using the given formatter.