Struct TreeNodeFlags

pub struct TreeNodeFlags { /* private fields */ }

Flags for tree nodes

Implementations

impl TreeNodeFlags

pub const SELECTED: TreeNodeFlags

Draw as selected

pub const FRAMED: TreeNodeFlags

Full colored frame (e.g. for CollapsingHeader)

pub const ALLOW_ITEM_OVERLAP: TreeNodeFlags

Hit testing to allow subsequent widgets to overlap this one

pub const NO_TREE_PUSH_ON_OPEN: TreeNodeFlags

Don’t push a tree node when open (e.g. for CollapsingHeader) = no extra indent nor pushing on ID stack

pub const NO_AUTO_OPEN_ON_LOG: TreeNodeFlags

Don’t automatically and temporarily open node when Logging is active (by default logging will automatically open tree nodes)

pub const DEFAULT_OPEN: TreeNodeFlags

Default node to be open

pub const OPEN_ON_DOUBLE_CLICK: TreeNodeFlags

Need double-click to open node

pub const OPEN_ON_ARROW: TreeNodeFlags

Only open when clicking on the arrow part.

If TreeNodeFlags::OPEN_ON_DOUBLE_CLICK is also set, single-click arrow or double-click all box to open.

pub const LEAF: TreeNodeFlags

No collapsing, no arrow (use as a convenience for leaf nodes)

pub const BULLET: TreeNodeFlags

Display a bullet instead of arrow

pub const FRAME_PADDING: TreeNodeFlags

Use Style::frame_padding (even for an unframed text node) to vertically align text baseline to regular widget height.

Equivalent to calling Ui::align_text_to_frame_padding.

pub const SPAN_AVAIL_WIDTH: TreeNodeFlags

Extend hit box to the right-most edge, even if not framed.

This is not the default in order to allow adding other items on the same line. In the future we may refactor the hit system to be front-to-back, allowing natural overlaps and then this can become the default.

pub const SPAN_FULL_WIDTH: TreeNodeFlags

Extend hit box to the left-most and right-most edges (bypass the indented area)

pub const NAV_LEFT_JUMPS_BACK_HERE: TreeNodeFlags

(WIP) Nav: left direction may move to this tree node from any of its child

pub const fn empty() -> TreeNodeFlags

Returns an empty set of flags.

pub const fn all() -> TreeNodeFlags

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

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

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

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

pub const unsafe fn from_bits_unchecked(bits: u32) -> TreeNodeFlags

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

Safety

The caller of the bitflags! macro can chose to allow or disallow extra bits for their bitflags type.

The caller of from_bits_unchecked() has to ensure that all bits correspond to a defined flag or that extra bits are valid for this bitflags type.

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

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

Returns the intersection between the flags in self and other.

Specifically, the returned set contains only the flags which are present in both self and other.

This is equivalent to using the & operator (e.g. ops::BitAnd), as in flags & other.

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

Returns the union of between the flags in self and other.

Specifically, the returned set contains all flags which are present in either self or other, including any which are present in both (see Self::symmetric_difference if that is undesirable).

This is equivalent to using the | operator (e.g. ops::BitOr), as in flags | other.

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

Returns the difference between the flags in self and other.

Specifically, the returned set contains all flags present in self, except for the ones present in other.

It is also conceptually equivalent to the “bit-clear” operation: flags & !other (and this syntax is also supported).

This is equivalent to using the - operator (e.g. ops::Sub), as in flags - other.

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

Returns the symmetric difference between the flags in self and other.

Specifically, the returned set contains the flags present which are present in self or other, but that are not present in both. Equivalently, it contains the flags present in exactly one of the sets self and other.

This is equivalent to using the ^ operator (e.g. ops::BitXor), as in flags ^ other.

pub const fn complement(self) -> TreeNodeFlags

Returns the complement of this set of flags.

Specifically, the returned set contains all the flags which are not set in self, but which are allowed for this type.

Alternatively, it can be thought of as the set difference between Self::all() and self (e.g. Self::all() - self)

This is equivalent to using the ! operator (e.g. ops::Not), as in !flags.

Trait Implementations

impl Binary for TreeNodeFlags

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

Formats the value using the given formatter.

impl BitAnd for TreeNodeFlags

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

Returns the intersection between the two sets of flags.

type Output = TreeNodeFlags

The resulting type after applying the & operator.

impl BitAndAssign for TreeNodeFlags

fn bitand_assign(&mut self, other: TreeNodeFlags)

Disables all flags disabled in the set.

impl BitOr for TreeNodeFlags

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

Returns the union of the two sets of flags.

type Output = TreeNodeFlags

The resulting type after applying the | operator.

impl BitOrAssign for TreeNodeFlags

fn bitor_assign(&mut self, other: TreeNodeFlags)

Adds the set of flags.

impl BitXor for TreeNodeFlags

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

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

type Output = TreeNodeFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for TreeNodeFlags

fn bitxor_assign(&mut self, other: TreeNodeFlags)

Toggles the set of flags.

impl Clone for TreeNodeFlags

fn clone(&self) -> TreeNodeFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TreeNodeFlags

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

Formats the value using the given formatter.

impl Extend<TreeNodeFlags> for TreeNodeFlags

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

where T: IntoIterator<Item = TreeNodeFlags>,

Extends a collection with the contents of an iterator.

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 FromIterator<TreeNodeFlags> for TreeNodeFlags

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

where T: IntoIterator<Item = TreeNodeFlags>,

Creates a value from an iterator.

impl Hash for TreeNodeFlags

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 LowerHex for TreeNodeFlags

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

Formats the value using the given formatter.

impl Not for TreeNodeFlags

fn not(self) -> TreeNodeFlags

Returns the complement of this set of flags.

type Output = TreeNodeFlags

The resulting type after applying the ! operator.

impl Octal for TreeNodeFlags

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

Formats the value using the given formatter.

impl Ord for TreeNodeFlags

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for TreeNodeFlags

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

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Sub for TreeNodeFlags

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

Returns the set difference of the two sets of flags.

type Output = TreeNodeFlags

The resulting type after applying the - operator.

impl SubAssign for TreeNodeFlags

fn sub_assign(&mut self, other: TreeNodeFlags)

Disables all flags enabled in the set.

impl UpperHex for TreeNodeFlags

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

Formats the value using the given formatter.

impl Copy for TreeNodeFlags

impl Eq for TreeNodeFlags

impl StructuralPartialEq for TreeNodeFlags