eden-emu/SDL
15
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-05-31 00:47:39 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

SDL_tray.h: Filled in doxygen for a few minor missing things.

Browse source
This commit is contained in:
Ryan C. Gordon 2024-12-26 14:09:26 -05:00
parent 17df3fe836
commit 8fde28813e
No known key found for this signature in database
GPG key ID: FA148B892AB48044
1 changed files with 20 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

21
include/SDL3/SDL_tray.h
View file

@ -39,8 +39,25 @@
extern "C" { extern "C" {
#endif #endif
/**
* An opaque handle representing a toplevel system tray object.
*
* \since This struct is available since SDL 3.2.0.
*/
typedef struct SDL_Tray SDL_Tray; typedef struct SDL_Tray SDL_Tray;
/**
* An opaque handle representing a menu/submenu on a system tray object.
*
* \since This struct is available since SDL 3.2.0.
*/
typedef struct SDL_TrayMenu SDL_TrayMenu; typedef struct SDL_TrayMenu SDL_TrayMenu;
/**
* An opaque handle representing an entry on a system tray object.
*
* \since This struct is available since SDL 3.2.0.
*/
typedef struct SDL_TrayEntry SDL_TrayEntry; typedef struct SDL_TrayEntry SDL_TrayEntry;
/** /**
@ -50,7 +67,7 @@ typedef struct SDL_TrayEntry SDL_TrayEntry;
* the time a tray entry is created. Other flags are optional; zero or more of * the time a tray entry is created. Other flags are optional; zero or more of
* those can be OR'ed together with the required flag. * those can be OR'ed together with the required flag.
* *
* \since This datatype is available since SDL 3.0.0. * \since This datatype is available since SDL 3.2.0.
* *
* \sa SDL_InsertTrayEntryAt * \sa SDL_InsertTrayEntryAt
*/ */
@ -69,6 +86,8 @@ typedef Uint32 SDL_TrayEntryFlags;
* it will be invoked. * it will be invoked.
* \param entry the tray entry that was selected. * \param entry the tray entry that was selected.
* *
* \since This datatype is available since SDL 3.2.0.
*
* \sa SDL_SetTrayEntryCallback * \sa SDL_SetTrayEntryCallback
*/ */
typedef void (SDLCALL *SDL_TrayCallback)(void *userdata, SDL_TrayEntry *entry); typedef void (SDLCALL *SDL_TrayCallback)(void *userdata, SDL_TrayEntry *entry);