SDL::TrayMenu Class Reference

An opaque handle representing a menu/submenu on a system tray object. More...

Public Member Functions
constexpr	TrayMenu (TrayMenuRaw trayMenu={}) noexcept
	Wraps TrayMenu.
constexpr	operator TrayMenuRaw () const noexcept
	Unwraps to the underlying TrayMenu.
std::span< TrayEntry >	GetEntries ()
	Returns a list of entries in the menu, in order.
TrayEntry	InsertEntry (int pos, StringParam label, TrayEntryFlags flags)
	Insert a tray entry at a given position.
TrayEntry	AppendEntry (StringParam label, TrayEntryFlags flags)
	Appends a tray entry.
TrayEntry	GetParentEntry () const
	Gets the entry for which the menu is a submenu, if the current menu is a submenu.
TrayRef	GetParentTray () const
	Gets the tray for which this menu is the first-level menu, if the current menu isn't a submenu.

Detailed Description

An opaque handle representing a menu/submenu on a system tray object.

Since

This struct is available since SDL 3.2.0.

Constructor & Destructor Documentation

TrayMenu()

SDL::TrayMenu::TrayMenu ( TrayMenuRaw trayMenu = {} )

inlineconstexprnoexcept

Wraps TrayMenu.

Parameters

trayMenu

the value to be wrapped

Member Function Documentation

operator TrayMenuRaw()

SDL::TrayMenu::operator TrayMenuRaw ( ) const

inlineconstexprnoexcept

Unwraps to the underlying TrayMenu.

Returns

the underlying TrayMenuRaw.

---

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

• SDL3pp/SDL3pp_tray.h