| Safe Haskell | None |
|---|---|
| Language | GHC2021 |
SDL3.Sys.Bindgen.Tray
Description
SDL offers a way to add items to the "system tray" (more correctly called the "notification area" on Windows). On platforms that offer this concept, an SDL app can add a tray icon, submenus, checkboxes, and clickable entries, and register a callback that is fired when the user clicks on these pieces. An opaque handle representing a toplevel system tray object.
Since: 3.2.0
Synopsis
- data SDL_Tray
- data SDL_TrayMenu
- data SDL_TrayEntry
- newtype SDL_TrayEntryFlags = SDL_TrayEntryFlags {}
- sDL_TRAYENTRY_BUTTON :: CUInt
- sDL_TRAYENTRY_CHECKBOX :: CUInt
- sDL_TRAYENTRY_SUBMENU :: CUInt
- sDL_TRAYENTRY_DISABLED :: CUInt
- sDL_TRAYENTRY_CHECKED :: CUInt
- newtype SDL_TrayCallback_Aux = SDL_TrayCallback_Aux {}
- newtype SDL_TrayCallback = SDL_TrayCallback {}
Documentation
data SDL_TrayMenu Source #
An opaque handle representing a menu/submenu on a system tray object.
- C declaration
struct SDL_TrayMenu, defined atSDL3/SDL_tray.h 58:16
Since: 3.2.0
data SDL_TrayEntry Source #
An opaque handle representing an entry on a system tray object.
- C declaration
struct SDL_TrayEntry, defined atSDL3/SDL_tray.h 65:16
Since: 3.2.0
newtype SDL_TrayEntryFlags Source #
Flags that control the creation of system tray entries.
Some of these flags are required; exactly one of them must be specified at 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.
- See also
sDL_InsertTrayEntryAt- C declaration
SDL_TrayEntryFlags, defined atSDL3/SDL_tray.h 78:16
Since: 3.2.0
Constructors
| SDL_TrayEntryFlags | |
Instances
sDL_TRAYENTRY_BUTTON :: CUInt Source #
Make the entry a simple button. Required.
- C declaration
macro SDL_TRAYENTRY_BUTTON, defined atSDL3/SDL_tray.h 80:9
sDL_TRAYENTRY_CHECKBOX :: CUInt Source #
Make the entry a checkbox. Required.
- C declaration
macro SDL_TRAYENTRY_CHECKBOX, defined atSDL3/SDL_tray.h 81:9
sDL_TRAYENTRY_SUBMENU :: CUInt Source #
Prepare the entry to have a submenu. Required
- C declaration
macro SDL_TRAYENTRY_SUBMENU, defined atSDL3/SDL_tray.h 82:9
sDL_TRAYENTRY_DISABLED :: CUInt Source #
Make the entry disabled. Optional.
- C declaration
macro SDL_TRAYENTRY_DISABLED, defined atSDL3/SDL_tray.h 83:9
sDL_TRAYENTRY_CHECKED :: CUInt Source #
Make the entry checked. This is valid only for checkboxes. Optional.
- C declaration
macro SDL_TRAYENTRY_CHECKED, defined atSDL3/SDL_tray.h 84:9
newtype SDL_TrayCallback_Aux Source #
Auxiliary type used by SDL_TrayCallback
- C declaration
SDL_TrayCallback, defined atSDL3/SDL_tray.h 97:24
Constructors
| SDL_TrayCallback_Aux | |
Instances
| Generic SDL_TrayCallback_Aux Source # | |||||
Defined in SDL3.Sys.Bindgen.Tray Associated Types
Methods from :: SDL_TrayCallback_Aux -> Rep SDL_TrayCallback_Aux x # to :: Rep SDL_TrayCallback_Aux x -> SDL_TrayCallback_Aux # | |||||
| FromFunPtr SDL_TrayCallback_Aux Source # | |||||
Defined in SDL3.Sys.Bindgen.Tray Methods fromFunPtr :: FunPtr SDL_TrayCallback_Aux -> SDL_TrayCallback_Aux # | |||||
| ToFunPtr SDL_TrayCallback_Aux Source # | |||||
Defined in SDL3.Sys.Bindgen.Tray Methods toFunPtr :: SDL_TrayCallback_Aux -> IO (FunPtr SDL_TrayCallback_Aux) # | |||||
| HasCField SDL_TrayCallback_Aux "unwrap" Source # | |||||
Defined in SDL3.Sys.Bindgen.Tray Associated Types
| |||||
| ty ~ (Ptr Void -> Ptr SDL_TrayEntry -> IO ()) => HasField "unwrap" SDL_TrayCallback_Aux ty Source # | |||||
Defined in SDL3.Sys.Bindgen.Tray Methods hasField :: SDL_TrayCallback_Aux -> (ty -> SDL_TrayCallback_Aux, ty) # | |||||
| ty ~ (Ptr Void -> Ptr SDL_TrayEntry -> IO ()) => HasField "unwrap" (Ptr SDL_TrayCallback_Aux) (Ptr ty :: Type) Source # | |||||
Defined in SDL3.Sys.Bindgen.Tray Methods getField :: Ptr SDL_TrayCallback_Aux -> Ptr ty # | |||||
| type Rep SDL_TrayCallback_Aux Source # | |||||
Defined in SDL3.Sys.Bindgen.Tray type Rep SDL_TrayCallback_Aux = D1 ('MetaData "SDL_TrayCallback_Aux" "SDL3.Sys.Bindgen.Tray" "sdl3-bindgen-sys-0.0.1.0-inplace" 'True) (C1 ('MetaCons "SDL_TrayCallback_Aux" 'PrefixI 'True) (S1 ('MetaSel ('Just "unwrap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Ptr Void -> Ptr SDL_TrayEntry -> IO ())))) | |||||
| type CFieldType SDL_TrayCallback_Aux "unwrap" Source # | |||||
Defined in SDL3.Sys.Bindgen.Tray | |||||
newtype SDL_TrayCallback Source #
A callback that is invoked when a tray entry is selected.
userdata- an optional pointer to pass extra data to the callback when it will be invoked.
entry- the tray entry that was selected.
- See also
sDL_SetTrayEntryCallback- C declaration
SDL_TrayCallback, defined atSDL3/SDL_tray.h 97:24
Since: 3.2.0
Constructors
| SDL_TrayCallback | |
Fields | |
Instances
| Storable SDL_TrayCallback Source # | |||||
Defined in SDL3.Sys.Bindgen.Tray Methods sizeOf :: SDL_TrayCallback -> Int # alignment :: SDL_TrayCallback -> Int # peekElemOff :: Ptr SDL_TrayCallback -> Int -> IO SDL_TrayCallback # pokeElemOff :: Ptr SDL_TrayCallback -> Int -> SDL_TrayCallback -> IO () # peekByteOff :: Ptr b -> Int -> IO SDL_TrayCallback # pokeByteOff :: Ptr b -> Int -> SDL_TrayCallback -> IO () # peek :: Ptr SDL_TrayCallback -> IO SDL_TrayCallback # poke :: Ptr SDL_TrayCallback -> SDL_TrayCallback -> IO () # | |||||
| Generic SDL_TrayCallback Source # | |||||
Defined in SDL3.Sys.Bindgen.Tray Associated Types
Methods from :: SDL_TrayCallback -> Rep SDL_TrayCallback x # to :: Rep SDL_TrayCallback x -> SDL_TrayCallback # | |||||
| Show SDL_TrayCallback Source # | |||||
Defined in SDL3.Sys.Bindgen.Tray Methods showsPrec :: Int -> SDL_TrayCallback -> ShowS # show :: SDL_TrayCallback -> String # showList :: [SDL_TrayCallback] -> ShowS # | |||||
| Eq SDL_TrayCallback Source # | |||||
Defined in SDL3.Sys.Bindgen.Tray Methods (==) :: SDL_TrayCallback -> SDL_TrayCallback -> Bool # (/=) :: SDL_TrayCallback -> SDL_TrayCallback -> Bool # | |||||
| Ord SDL_TrayCallback Source # | |||||
Defined in SDL3.Sys.Bindgen.Tray Methods compare :: SDL_TrayCallback -> SDL_TrayCallback -> Ordering # (<) :: SDL_TrayCallback -> SDL_TrayCallback -> Bool # (<=) :: SDL_TrayCallback -> SDL_TrayCallback -> Bool # (>) :: SDL_TrayCallback -> SDL_TrayCallback -> Bool # (>=) :: SDL_TrayCallback -> SDL_TrayCallback -> Bool # max :: SDL_TrayCallback -> SDL_TrayCallback -> SDL_TrayCallback # min :: SDL_TrayCallback -> SDL_TrayCallback -> SDL_TrayCallback # | |||||
| HasFFIType SDL_TrayCallback Source # | |||||
Defined in SDL3.Sys.Bindgen.Tray Associated Types
Methods toFFIType :: SDL_TrayCallback -> FFIType SDL_TrayCallback # fromFFIType :: FFIType SDL_TrayCallback -> SDL_TrayCallback # | |||||
| ReadRaw SDL_TrayCallback Source # | |||||
Defined in SDL3.Sys.Bindgen.Tray Methods | |||||
| StaticSize SDL_TrayCallback Source # | |||||
Defined in SDL3.Sys.Bindgen.Tray Methods staticSizeOf :: Proxy SDL_TrayCallback -> Int # staticAlignment :: Proxy SDL_TrayCallback -> Int # | |||||
| WriteRaw SDL_TrayCallback Source # | |||||
Defined in SDL3.Sys.Bindgen.Tray Methods writeRaw :: Ptr SDL_TrayCallback -> SDL_TrayCallback -> IO () # | |||||
| HasCField SDL_TrayCallback "unwrap" Source # | |||||
Defined in SDL3.Sys.Bindgen.Tray Associated Types
| |||||
| ty ~ FunPtr SDL_TrayCallback_Aux => HasField "unwrap" SDL_TrayCallback ty Source # | |||||
Defined in SDL3.Sys.Bindgen.Tray Methods hasField :: SDL_TrayCallback -> (ty -> SDL_TrayCallback, ty) # | |||||
| ty ~ FunPtr SDL_TrayCallback_Aux => HasField "unwrap" (Ptr SDL_TrayCallback) (Ptr ty :: Type) Source # | |||||
Defined in SDL3.Sys.Bindgen.Tray Methods getField :: Ptr SDL_TrayCallback -> Ptr ty # | |||||
| type Rep SDL_TrayCallback Source # | |||||
Defined in SDL3.Sys.Bindgen.Tray type Rep SDL_TrayCallback = D1 ('MetaData "SDL_TrayCallback" "SDL3.Sys.Bindgen.Tray" "sdl3-bindgen-sys-0.0.1.0-inplace" 'True) (C1 ('MetaCons "SDL_TrayCallback" 'PrefixI 'True) (S1 ('MetaSel ('Just "unwrap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (FunPtr SDL_TrayCallback_Aux)))) | |||||
| type FFIType SDL_TrayCallback Source # | |||||
Defined in SDL3.Sys.Bindgen.Tray | |||||
| type CFieldType SDL_TrayCallback "unwrap" Source # | |||||
Defined in SDL3.Sys.Bindgen.Tray | |||||