Struct ItemDataRole

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

Each item in the model has a set of data elements associated with it, each with its own role. The roles are used by the view to indicate to the model which type of data it needs. Custom models should return data in these types.

C++ enum: Qt::ItemDataRole.

C++ documentation:

Each item in the model has a set of data elements associated with it, each with its own role. The roles are used by the view to indicate to the model which type of data it needs. Custom models should return data in these types.

The general purpose roles (and the associated types) are:

Roles describing appearance and meta data (with associated types):

Accessibility roles (with associated types):

User roles:

For user roles, it is up to the developer to decide which types to use and ensure that components use the correct types when accessing and setting data.

Implementations

impl ItemDataRole

pub fn to_int(&self) -> c_int

impl ItemDataRole

pub const DisplayRole: ItemDataRole

The key data to be rendered in the form of text. (QString) (C++ enum variant: DisplayRole = 0)

pub const DecorationRole: ItemDataRole

The data to be rendered as a decoration in the form of an icon. (QColor, QIcon or QPixmap) (C++ enum variant: DecorationRole = 1)

pub const EditRole: ItemDataRole

The data in a form suitable for editing in an editor. (QString) (C++ enum variant: EditRole = 2)

pub const ToolTipRole: ItemDataRole

The data displayed in the item’s tooltip. (QString) (C++ enum variant: ToolTipRole = 3)

pub const StatusTipRole: ItemDataRole

The data displayed in the status bar. (QString) (C++ enum variant: StatusTipRole = 4)

pub const WhatsThisRole: ItemDataRole

The data displayed for the item in “What’s This?” mode. (QString) (C++ enum variant: WhatsThisRole = 5)

pub const FontRole: ItemDataRole

The font used for items rendered with the default delegate. (QFont) (C++ enum variant: FontRole = 6)

pub const TextAlignmentRole: ItemDataRole

The alignment of the text for items rendered with the default delegate. (Qt::Alignment) (C++ enum variant: TextAlignmentRole = 7)

pub const BackgroundColorRole: ItemDataRole

This role is obsolete. Use BackgroundRole instead. (C++ enum variant: BackgroundColorRole = 8)

pub const BackgroundRole: ItemDataRole

The background brush used for items rendered with the default delegate. (QBrush) (C++ enum variant: BackgroundRole = 8)

pub const TextColorRole: ItemDataRole

This role is obsolete. Use ForegroundRole instead. (C++ enum variant: TextColorRole = 9)

pub const ForegroundRole: ItemDataRole

The foreground brush (text color, typically) used for items rendered with the default delegate. (QBrush) (C++ enum variant: ForegroundRole = 9)

pub const CheckStateRole: ItemDataRole

This role is used to obtain the checked state of an item. (Qt::CheckState) (C++ enum variant: CheckStateRole = 10)

pub const AccessibleTextRole: ItemDataRole

The text to be used by accessibility extensions and plugins, such as screen readers. (QString) (C++ enum variant: AccessibleTextRole = 11)

pub const AccessibleDescriptionRole: ItemDataRole

A description of the item for accessibility purposes. (QString) (C++ enum variant: AccessibleDescriptionRole = 12)

pub const SizeHintRole: ItemDataRole

The size hint for the item that will be supplied to views. (QSize) (C++ enum variant: SizeHintRole = 13)

pub const InitialSortOrderRole: ItemDataRole

This role is used to obtain the initial sort order of a header view section. (Qt::SortOrder). This role was introduced in Qt 4.8. (C++ enum variant: InitialSortOrderRole = 14)

pub const DisplayPropertyRole: ItemDataRole

C++ enum variant: DisplayPropertyRole = 27

pub const DecorationPropertyRole: ItemDataRole

C++ enum variant: DecorationPropertyRole = 28

pub const ToolTipPropertyRole: ItemDataRole

C++ enum variant: ToolTipPropertyRole = 29

pub const StatusTipPropertyRole: ItemDataRole

C++ enum variant: StatusTipPropertyRole = 30

pub const WhatsThisPropertyRole: ItemDataRole

C++ enum variant: WhatsThisPropertyRole = 31

pub const UserRole: ItemDataRole

The first role that can be used for application-specific purposes. (C++ enum variant: UserRole = 256)

Trait Implementations

impl Clone for ItemDataRole

fn clone(&self) -> ItemDataRole

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ItemDataRole

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

Formats the value using the given formatter.

impl From<ItemDataRole> for c_int

fn from(value: ItemDataRole) -> Self

Converts to this type from the input type.

impl From<i32> for ItemDataRole

fn from(value: c_int) -> Self

Converts to this type from the input type.

impl PartialEq for ItemDataRole

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

impl Eq for ItemDataRole

impl StructuralPartialEq for ItemDataRole