SDL::Tray Struct Reference

An opaque handle representing a toplevel system tray object. More...

Inheritance diagram for SDL::Tray:

Public Member Functions
constexpr	Tray (TrayRaw resource) noexcept
	Constructs from raw Tray.
constexpr	Tray (const Tray &other)=delete
	Copy constructor.
constexpr	Tray (Tray &&other) noexcept
	Move constructor.
constexpr	Tray (const TrayRef &other)=delete
constexpr	Tray (TrayRef &&other)=delete
	Tray (SurfaceRef icon, StringParam tooltip)
	Create an icon to be placed in the operating system's tray, or equivalent.
	~Tray ()
	Destructor.
constexpr Tray &	operator= (Tray &&other) noexcept
	Assignment operator.
Tray &	operator= (const Tray &other)=delete
	Assignment operator.
void	Destroy ()
	Destroys a tray object.
void	SetIcon (SurfaceRef icon)
	Updates the system tray icon's icon.
void	SetTooltip (StringParam tooltip)
	Updates the system tray icon's tooltip.
TrayMenu	CreateMenu ()
	Create a menu for a system tray.
TrayMenu	GetMenu () const
	Gets a previously created tray menu.
constexpr	ResourceBase (RawPointer resource)
	Constructs from resource pointer.
constexpr	ResourceBase (std::nullptr_t=nullptr)
	Constructs null/invalid.
Public Member Functions inherited from SDL::ResourceBase< TrayRaw >
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< TrayRaw >
using	RawPointer
	The underlying raw pointer type.
using	RawConstPointer
	The underlying const raw pointer type.

Detailed Description

An opaque handle representing a toplevel system tray object.

Since

This struct is available since SDL 3.2.0.

Category:

Resource

Constructor & Destructor Documentation

Tray()

SDL::Tray::Tray ( TrayRaw resource )

inlineexplicitconstexprnoexcept

Constructs from raw Tray.

Parameters

resource

a TrayRaw to be wrapped.

This assumes the ownership, call release() if you need to take back.

---

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

• SDL3pp/SDL3pp_tray.h