DialogMenu

The DialogMenu class provides a platform-native customizable menu dialog, allowing users to create and manage a list of interactive menu items. It supports various features such as setting the position and text of items, associating keys and images with items, and enabling or disabling them. Additionally, it allows for checking/unchecking items, hiding them, and grouping them together.

#include <interface/TellusimDialogs.h>

Constructors

DialogMenu()

Methods

Dialog position.

void setPosition(int32_t x, int32_t y)
int32_t getPositionX() const
int32_t getPositionY() const

---

Number of items.

uint32_t getNumItems() const

---

Item text.

void setItemText(uint32_t index, const char *text)
void setItemText(uint32_t index, const String &text)
String getItemText(uint32_t index) const

---

Item key.

void setItemKey(uint32_t index, const char *key)
String getItemKey(uint32_t index) const

---

Item image.

void setItemImage(uint32_t index, const Image &image)
Image getItemImage(uint32_t index) const

---

Item checked.

void setItemChecked(uint32_t index, bool checked, bool callback = false)
bool isItemChecked(uint32_t index) const

---

Item enabled.

void setItemEnabled(uint32_t index, bool enabled)
bool isItemEnabled(uint32_t index) const

---

Item hidden.

void setItemHidden(uint32_t index, bool hidden)
bool isItemHidden(uint32_t index) const

---

Item group.

void setItemsGroup(uint32_t index, uint32_t size)
uint32_t getItemGroupIndex(uint32_t index) const
uint32_t getItemGroupSize(uint32_t index) const

---

Text item.

uint32_t addItem(const char *text, const char *key = nullptr)
uint32_t addItem(const String &text, const char *key = nullptr)
uint32_t addItem(const char *text, const Image &image, const char *key = nullptr)
uint32_t addItem(const String &text, const Image &image, const char *key = nullptr)

---

Click item.

uint32_t addItem(const char *text, const ClickedCallback &func, const char *key = nullptr)
uint32_t addItem(const String &text, const ClickedCallback &func, const char *key = nullptr)
uint32_t addItem(const char *text, const Image &image, const ClickedCallback &func, const char *key = nullptr)
uint32_t addItem(const String &text, const Image &image, const ClickedCallback &func, const char *key = nullptr)
ClickedCallback getItemClickedCallback(uint32_t index) const

---

Check item.

uint32_t addItem(const char *text, bool checked, const ChangedCallback &func, const char *key = nullptr)
uint32_t addItem(const String &text, bool checked, const ChangedCallback &func, const char *key = nullptr)
uint32_t addItem(const char *text, const Image &image, bool checked, const ChangedCallback &func, const char *key = nullptr)
uint32_t addItem(const String &text, const Image &image, bool checked, const ChangedCallback &func, const char *key = nullptr)
ChangedCallback getItemChangedCallback(uint32_t index) const

---

Update callback.

void setUpdateCallback(const UpdateCallback &func)
UpdateCallback getUpdateCallback() const

---

Run dialog.

Result run(Flags flags = DefaultFlags)

Types

using ClickedCallback = Function<void()>
using ChangedCallback = Function<void(bool)>
using UpdateCallback = Function<bool()>

Enums

Flags

Dialog flags.

Name	Value
FlagNone	0
FlagMouse	(1 << 0)
DefaultFlags	FlagNone
NumFlags	1

---

Result

Dialog result.

Name	Value
ResultCancel	0
ResultClick	1
NumResults	2