guillaume 2026.6.1
A C++ UI framework designed for modern desktop and extended reality (XR) applications.
Loading...
Searching...
No Matches
guillaume::components::List::Item Struct Reference

Description of one list entry, as given by the user. More...

#include <headers/guillaume/components/list.hpp>

Public Attributes

std::string headline
 Main text of the row.
std::string supporting
std::string leadingIcon
std::string trailingIcon
std::string leadingImage {}
std::function< void(void)> onPress {}
 Called on press.
bool disabled { false }
ItemKind kind { ItemKind::Item }
 What the entry is.
std::vector< Item > children {}
bool expanded { false }

Detailed Description

Description of one list entry, as given by the user.

A subheader only uses headline; a divider uses no field but kind.

Definition at line 84 of file list.hpp.

Member Data Documentation

◆ children

std::vector<Item> guillaume::components::List::Item::children {}

Rows shown under this one while it is expanded.

Definition at line 98 of file list.hpp.

◆ disabled

bool guillaume::components::List::Item::disabled { false }

True when the row ignores presses.

Definition at line 95 of file list.hpp.

◆ expanded

bool guillaume::components::List::Item::expanded { false }

True while an accordion shows its children.

Definition at line 100 of file list.hpp.

◆ headline

std::string guillaume::components::List::Item::headline

Main text of the row.

Definition at line 85 of file list.hpp.

◆ kind

ItemKind guillaume::components::List::Item::kind { ItemKind::Item }

What the entry is.

Definition at line 97 of file list.hpp.

◆ leadingIcon

std::string guillaume::components::List::Item::leadingIcon

Glyph name of the icon before the texts; empty for none.

Definition at line 88 of file list.hpp.

◆ leadingImage

std::string guillaume::components::List::Item::leadingImage {}

Path of the image before the texts; empty for none.

Definition at line 92 of file list.hpp.

◆ onPress

std::function<void(void)> guillaume::components::List::Item::onPress {}

Called on press.

Definition at line 94 of file list.hpp.

◆ supporting

std::string guillaume::components::List::Item::supporting

Second text, under the headline; empty for none.

Definition at line 86 of file list.hpp.

◆ trailingIcon

std::string guillaume::components::List::Item::trailingIcon

Glyph name of the icon at the far edge; empty for none.

Definition at line 90 of file list.hpp.


The documentation for this struct was generated from the following file: