Struct TableFlags 

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

Flags for table widgets

Implementations

impl TableFlags

pub const NONE: Self

No flags

pub const RESIZABLE: Self

Enable resizing columns

pub const REORDERABLE: Self

Enable reordering columns in header row (need calling TableSetupColumn() + TableHeadersRow() to display headers)

pub const HIDEABLE: Self

Enable hiding/disabling columns in context menu

pub const SORTABLE: Self

Enable sorting. Call TableGetSortSpecs() to obtain sort specs. Also see ImGuiTableFlags_SortMulti and ImGuiTableFlags_SortTristate.

pub const NO_SAVED_SETTINGS: Self

Disable persisting columns order, width and sort settings in the .ini file

pub const CONTEXT_MENU_IN_BODY: Self

Right-click on columns body/contents will display table context menu. By default it is available in TableHeadersRow().

pub const ROW_BG: Self

Set each RowBg color with ImGuiCol_TableRowBg or ImGuiCol_TableRowBgAlt (equivalent of calling TableSetBgColor with ImGuiTableBgFlags_RowBg0 on each row manually)

pub const BORDERS_INNER_H: Self

Draw horizontal borders between rows

pub const BORDERS_OUTER_H: Self

Draw horizontal borders at the top and bottom

pub const BORDERS_INNER_V: Self

Draw vertical borders between columns

pub const BORDERS_OUTER_V: Self

Draw vertical borders on the left and right sides

pub const BORDERS_H: Self

Draw horizontal borders

pub const BORDERS_V: Self

Draw vertical borders

pub const BORDERS_INNER: Self

Draw inner borders

pub const BORDERS_OUTER: Self

Draw outer borders

pub const BORDERS: Self

Draw all borders

pub const NO_BORDERS_IN_BODY: Self

[ALPHA] Disable vertical borders in columns Body (borders will always appears in Headers). -> May move to style

pub const NO_BORDERS_IN_BODY_UNTIL_RESIZE: Self

[ALPHA] Disable vertical borders in columns Body until hovered for resize (borders will always appears in Headers). -> May move to style

pub const SIZING_FIXED_FIT: Self

Columns default to _WidthFixed or _WidthAuto (if resizable or not resizable), matching contents width

pub const SIZING_FIXED_SAME: Self

Columns default to _WidthFixed or _WidthAuto (if resizable or not resizable), matching the maximum contents width of all columns. Implicitly enable ImGuiTableFlags_NoKeepColumnsVisible.

pub const SIZING_STRETCH_PROP: Self

Columns default to _WidthStretch with default weights proportional to each columns contents widths.

pub const SIZING_STRETCH_SAME: Self

Columns default to _WidthStretch with default weights all equal, unless overridden by TableSetupColumn().

pub const NO_HOST_EXTEND_X: Self

Make outer width auto-fit to columns, overriding outer_size.x value. Only available when ScrollX/ScrollY are disabled and Stretch columns are not used.

pub const NO_HOST_EXTEND_Y: Self

Make outer height stop exactly at outer_size.y (prevent auto-extending table past the limit). Only available when ScrollX/ScrollY are disabled. Data below the limit will be clipped and not visible.

pub const NO_KEEP_COLUMNS_VISIBLE: Self

Disable keeping column always minimally visible when ScrollX is on and table gets too small. Not recommended if columns are resizable.

pub const PRECISE_WIDTHS: Self

Disable distributing remainder width to stretched columns (width allocation on a 100-wide table with 3 columns: Without this flag: 33,33,34. With this flag: 33,33,33). With larger number of columns, resizing will appear to be less smooth.

pub const NO_CLIP: Self

Disable clipping rectangle for every individual columns (reduce draw command count, items will be able to overflow into other columns). Generally incompatible with TableSetupScrollFreeze().

pub const PAD_OUTER_X: Self

Default if BordersOuterV is on. Enable outer-most padding. Generally desirable if you have headers.

pub const NO_PAD_OUTER_X: Self

Default if BordersOuterV is off. Disable outer-most padding.

pub const NO_PAD_INNER_X: Self

Disable inner padding between columns (double inner padding if BordersOuterV is on, single inner padding if BordersOuterV is off).

pub const SCROLL_X: Self

Enable horizontal scrolling. Require ‘outer_size’ parameter of BeginTable() to specify the container size. Changes default sizing policy. Because this creates a child window, ScrollY is currently generally recommended when using ScrollX.

pub const SCROLL_Y: Self

Enable vertical scrolling. Require ‘outer_size’ parameter of BeginTable() to specify the container size.

pub const SORT_MULTI: Self

Hold shift when clicking headers to sort on multiple column. TableGetSortSpecs() may return specs where (SpecsCount > 1).

pub const SORT_TRISTATE: Self

Allow no sorting, disable default sorting. TableGetSortSpecs() may return specs where (SpecsCount == 0).

pub const HIGHLIGHT_HOVERED_COLUMN: Self

Highlight column headers when hovered (may not be visible if table header is declaring a background color)

impl TableFlags

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 TableFlags

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

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

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 TableFlags

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

Formats the value using the given formatter.

impl BitAnd for TableFlags

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

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

type Output = TableFlags

The resulting type after applying the & operator.

impl BitAndAssign for TableFlags

fn bitand_assign(&mut self, other: Self)

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

impl BitOr for TableFlags

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

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

type Output = TableFlags

The resulting type after applying the | operator.

impl BitOrAssign for TableFlags

fn bitor_assign(&mut self, other: Self)

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

impl BitXor for TableFlags

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

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

type Output = TableFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for TableFlags

fn bitxor_assign(&mut self, other: Self)

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

impl Clone for TableFlags

fn clone(&self) -> TableFlags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TableFlags

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

Formats the value using the given formatter.

impl Extend<TableFlags> for TableFlags

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 TableFlags

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

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

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

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

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

impl Hash for TableFlags

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 TableFlags

type Item = TableFlags

The type of the elements being iterated over.

type IntoIter = Iter<TableFlags>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for TableFlags

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

Formats the value using the given formatter.

impl Not for TableFlags

fn not(self) -> Self

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

type Output = TableFlags

The resulting type after applying the ! operator.

impl Octal for TableFlags

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

Formats the value using the given formatter.

impl PartialEq for TableFlags

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

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 TableFlags

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

The resulting type after applying the - operator.

impl SubAssign for TableFlags

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 TableFlags

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

Formats the value using the given formatter.

impl Copy for TableFlags

impl Eq for TableFlags

impl StructuralPartialEq for TableFlags