SDL::TrayEntry Struct Reference

An opaque handle representing an entry on a system tray object. More...

Inheritance diagram for SDL::TrayEntry:

Public Member Functions
	TrayEntry (TrayMenu menu, int pos, StringParam label, TrayEntryFlags flags)
	Insert a tray entry at a given position.
	TrayEntry (TrayMenuRaw menu, StringParam label, TrayEntryFlags flags)
	Appends a tray entry.
constexpr	operator TrayEntryRaw () const noexcept
	Converts to underlying TrayEntryRaw.
void	Remove ()
	Removes a tray entry.
TrayMenu	CreateSubmenu ()
	Create a submenu for a system tray entry.
TrayMenu	GetSubmenu ()
	Gets a previously created tray entry submenu.
void	SetLabel (StringParam label)
	Sets the label of an entry.
const char *	GetLabel () const
	Gets the label of an entry.
void	SetChecked (bool checked)
	Sets whether or not an entry is checked.
bool	GetChecked () const
	Gets whether or not an entry is checked.
void	SetEnabled (bool enabled)
	Sets whether or not an entry is enabled.
bool	GetEnabled () const
	Gets whether or not an entry is enabled.
void	SetCallback (TrayCallback callback, void *userdata)
	Sets a callback to be invoked when the entry is selected.
void	SetCallback (TrayCB callback)
	Sets a callback to be invoked when the entry is selected.
void	Click ()
	Simulate a click on a tray entry.
TrayMenu	GetParent ()
	Gets the menu containing a certain tray entry.
constexpr	ResourceBase (RawPointer resource)
	Constructs from resource pointer.
constexpr	ResourceBase (std::nullptr_t=nullptr)
	Constructs null/invalid.
Public Member Functions inherited from SDL::ResourceBase< TrayEntryRaw >
constexpr	ResourceBase (RawPointer resource)
	Constructs from resource pointer.
constexpr	operator bool () const
	Converts to bool.
constexpr auto	operator<=> (const ResourceBase &other) const=default
	Comparison.
constexpr RawConstPointer	operator-> () const noexcept
	member access to underlying resource pointer.
constexpr RawPointer	get () const noexcept
	Retrieves underlying resource pointer.
constexpr RawPointer	release () noexcept
	Retrieves underlying resource pointer and clear this.

Additional Inherited Members
Public Types inherited from SDL::ResourceBase< TrayEntryRaw >
using	RawPointer
	The underlying raw pointer type.
using	RawConstPointer
	The underlying const raw pointer type.

Detailed Description

An opaque handle representing an entry on a system tray object.

Since

This struct is available since SDL 3.2.0.

Category:

Resource

---

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

• SDL3pp/SDL3pp_tray.h