SDL3pp
A slim C++ wrapper for SDL3
Loading...
Searching...
No Matches
Public Member Functions | List of all members
SDL::Tray Struct Reference

Handle to an owned tray. More...

Inheritance diagram for SDL::Tray:
Inheritance graph
[legend]

Public Member Functions

constexpr Tray (SDL_Tray *resource={})
 Constructs from the underlying resource.
 
constexpr Tray (const Tray &other)=delete
 
constexpr Tray (Tray &&other)=default
 Move constructor.
 
 ~Tray ()
 Frees up resource when object goes out of scope.
 
Trayoperator= (Tray other)
 Assignment operator.
 
constexpr TrayRef (const TrayRef &other)
 Copy constructor.
 
constexpr TrayRef (TrayRef &&other)
 Move constructor.
 
- Public Member Functions inherited from SDL::TrayRef
constexpr TrayRef (const TrayRef &other)
 Copy constructor.
 
constexpr TrayRef (TrayRef &&other)
 Move constructor.
 
constexpr ~TrayRef ()=default
 Default constructor.
 
TrayRefoperator= (TrayRef other)
 Assignment operator.
 
void reset (SDL_Tray *newResource={})
 Destroys a tray object.
 
 TrayBase (SurfaceBase &icon, StringParam tooltip)
 Create an icon to be placed in the operating system's tray, or equivalent.
 
- Public Member Functions inherited from SDL::TrayBase
 TrayBase (SurfaceBase &icon, StringParam tooltip)
 Create an icon to be placed in the operating system's tray, or equivalent.
 
void SetIcon (SurfaceBase &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 Resource (T resource={})
 Constructs the underlying resource.
 
constexpr Resource (std::nullptr_t)
 Equivalent to default ctor.
 
constexpr Resource (std::nullopt_t)
 Equivalent to default ctor.
 
 Resource (const Resource &other)=delete
 
 Resource (Resource &&other)=delete
 
- Public Member Functions inherited from SDL::Resource< SDL_Tray * >
constexpr Resource (SDL_Tray * resource={})
 Constructs the underlying resource.
 
constexpr Resource (std::nullptr_t)
 Equivalent to default ctor.
 
constexpr Resource (std::nullopt_t)
 Equivalent to default ctor.
 
 Resource (const Resource &other)=delete
 
 Resource (Resource &&other)=delete
 
Resourceoperator= (const Resource &other)=delete
 
Resourceoperator= (Resource &&other)=delete
 
constexpr operator bool () const
 True if contains a valid resource.
 
constexpr bool operator== (const Resource &other) const=default
 Comparison.
 
constexpr bool operator== (std::nullopt_t) const
 Comparison.
 
constexpr bool operator== (std::nullptr_t) const
 Comparison.
 
constexpr SDL_Tray * get () const
 Return contained resource;.
 
constexpr SDL_Tray * release (SDL_Tray * newResource={})
 Return contained resource and empties or replace value.
 
constexpr const SDL_Tray * operator-> () const
 Access to fields.
 
constexpr SDL_Tray * operator-> ()
 Access to fields.
 

Detailed Description

Category:
Resource
See also
TrayBase
TrayRef

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