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

RAII owning version TrayEntry.

Inheritance diagram for SDL::TrayEntryScoped:
Inheritance graph
[legend]
Collaboration diagram for SDL::TrayEntryScoped:
Collaboration graph
[legend]

Public Member Functions

constexpr TrayEntryScoped (const TrayEntry &other)=delete
 
constexpr TrayEntryScoped (TrayEntry &&other) noexcept
 Move constructor.
 
 ~TrayEntryScoped ()
 Destructor.
 
constexpr TrayEntry (std::nullptr_t=nullptr) noexcept
 Default ctor.
 
constexpr TrayEntry (const TrayEntryRaw resource) noexcept
 Constructs from TrayEntryParam. More...
 
constexpr TrayEntry (const TrayEntry &other) noexcept=default
 Copy constructor.
 
constexpr TrayEntry (TrayEntry &&other) noexcept
 Move constructor.
 
- Public Member Functions inherited from SDL::TrayEntry
constexpr TrayEntry (std::nullptr_t=nullptr) noexcept
 Default ctor.
 
constexpr TrayEntry (const TrayEntryRaw resource) noexcept
 Constructs from TrayEntryParam. More...
 
constexpr TrayEntry (const TrayEntry &other) noexcept=default
 Copy constructor.
 
constexpr TrayEntry (TrayEntry &&other) noexcept
 Move constructor.
 
 ~TrayEntry ()
 Destructor.
 
constexpr TrayEntryoperator= (TrayEntry &&other) noexcept
 Assignment operator.
 
constexpr TrayEntryoperator= (const TrayEntry &other) noexcept=default
 Assignment operator.
 
constexpr TrayEntryRaw get () const noexcept
 Retrieves underlying TrayEntryRaw.
 
constexpr TrayEntryRaw release () noexcept
 Retrieves underlying TrayEntryRaw and clear this.
 
constexpr auto operator<=> (const TrayEntry &other) const noexcept=default
 Comparison.
 
constexpr operator bool () const noexcept
 Converts to bool.
 
constexpr operator TrayEntryParam () const noexcept
 Converts to TrayEntryParam.
 
void Remove ()
 Removes a tray entry. More...
 
TrayMenu CreateSubmenu ()
 Create a submenu for a system tray entry. More...
 
TrayMenu GetSubmenu ()
 Gets a previously created tray entry submenu. More...
 
void SetLabel (StringParam label)
 Sets the label of an entry. More...
 
const char * GetLabel () const
 Gets the label of an entry. More...
 
void SetChecked (bool checked)
 Sets whether or not an entry is checked. More...
 
bool GetChecked () const
 Gets whether or not an entry is checked. More...
 
void SetEnabled (bool enabled)
 Sets whether or not an entry is enabled. More...
 
bool GetEnabled () const
 Gets whether or not an entry is enabled. More...
 
void SetCallback (TrayCB callback)
 Sets a callback to be invoked when the entry is selected. More...
 
void SetCallback (TrayCallback callback, void *userdata)
 Sets a callback to be invoked when the entry is selected. More...
 
void Click ()
 Simulate a click on a tray entry. More...
 
TrayMenu GetParent ()
 Gets the menu containing a certain tray entry. More...
 

Member Function Documentation

◆ TrayEntry()

constexpr SDL::TrayEntry::TrayEntry ( const TrayEntryRaw  resource)
inlineconstexprnoexcept
Parameters
resourcea TrayEntryRaw to be wrapped.

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