sdl3-bindgen-sys
Safe HaskellNone
LanguageGHC2021

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

Documentation

data SDL_Tray Source #

C declaration
struct SDL_Tray, defined at SDL3/SDL_tray.h 51:16

data SDL_TrayMenu Source #

An opaque handle representing a menu/submenu on a system tray object.

C declaration
struct SDL_TrayMenu, defined at SDL3/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 at SDL3/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 at SDL3/SDL_tray.h 78:16

Since: 3.2.0

Constructors

SDL_TrayEntryFlags 

Fields

Instances

Instances details
Bits SDL_TrayEntryFlags Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

FiniteBits SDL_TrayEntryFlags Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

Bounded SDL_TrayEntryFlags Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

Enum SDL_TrayEntryFlags Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

Storable SDL_TrayEntryFlags Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

Generic SDL_TrayEntryFlags Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

Associated Types

type Rep SDL_TrayEntryFlags 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

type Rep SDL_TrayEntryFlags = D1 ('MetaData "SDL_TrayEntryFlags" "SDL3.Sys.Bindgen.Tray" "sdl3-bindgen-sys-0.0.1.0-inplace" 'True) (C1 ('MetaCons "SDL_TrayEntryFlags" 'PrefixI 'True) (S1 ('MetaSel ('Just "unwrap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Uint32)))
Ix SDL_TrayEntryFlags Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

Num SDL_TrayEntryFlags Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

Read SDL_TrayEntryFlags Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

Integral SDL_TrayEntryFlags Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

Real SDL_TrayEntryFlags Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

Show SDL_TrayEntryFlags Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

Eq SDL_TrayEntryFlags Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

Ord SDL_TrayEntryFlags Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

Prim SDL_TrayEntryFlags Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

HasFFIType SDL_TrayEntryFlags Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

Associated Types

type FFIType SDL_TrayEntryFlags 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

ReadRaw SDL_TrayEntryFlags Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

StaticSize SDL_TrayEntryFlags Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

WriteRaw SDL_TrayEntryFlags Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

Bitfield SDL_TrayEntryFlags Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

HasCField SDL_TrayEntryFlags "unwrap" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

Associated Types

type CFieldType SDL_TrayEntryFlags "unwrap" 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

Methods

offset# :: Proxy# SDL_TrayEntryFlags -> Proxy# "unwrap" -> Int #

ty ~ Uint32 => HasField "unwrap" SDL_TrayEntryFlags ty Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

ty ~ Uint32 => HasField "unwrap" (Ptr SDL_TrayEntryFlags) (Ptr ty :: Type) Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

type Rep SDL_TrayEntryFlags Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

type Rep SDL_TrayEntryFlags = D1 ('MetaData "SDL_TrayEntryFlags" "SDL3.Sys.Bindgen.Tray" "sdl3-bindgen-sys-0.0.1.0-inplace" 'True) (C1 ('MetaCons "SDL_TrayEntryFlags" 'PrefixI 'True) (S1 ('MetaSel ('Just "unwrap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Uint32)))
type FFIType SDL_TrayEntryFlags Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

type CFieldType SDL_TrayEntryFlags "unwrap" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

sDL_TRAYENTRY_BUTTON :: CUInt Source #

Make the entry a simple button. Required.

C declaration
macro SDL_TRAYENTRY_BUTTON, defined at SDL3/SDL_tray.h 80:9

sDL_TRAYENTRY_CHECKBOX :: CUInt Source #

Make the entry a checkbox. Required.

C declaration
macro SDL_TRAYENTRY_CHECKBOX, defined at SDL3/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 at SDL3/SDL_tray.h 82:9

sDL_TRAYENTRY_DISABLED :: CUInt Source #

Make the entry disabled. Optional.

C declaration
macro SDL_TRAYENTRY_DISABLED, defined at SDL3/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 at SDL3/SDL_tray.h 84:9

newtype SDL_TrayCallback_Aux Source #

Auxiliary type used by SDL_TrayCallback

C declaration
SDL_TrayCallback, defined at SDL3/SDL_tray.h 97:24

Constructors

SDL_TrayCallback_Aux 

Fields

Instances

Instances details
Generic SDL_TrayCallback_Aux Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

Associated Types

type Rep SDL_TrayCallback_Aux 
Instance details

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 ()))))
FromFunPtr SDL_TrayCallback_Aux Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

ToFunPtr SDL_TrayCallback_Aux Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

HasCField SDL_TrayCallback_Aux "unwrap" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

Associated Types

type CFieldType SDL_TrayCallback_Aux "unwrap" 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

Methods

offset# :: Proxy# SDL_TrayCallback_Aux -> Proxy# "unwrap" -> Int #

ty ~ (Ptr Void -> Ptr SDL_TrayEntry -> IO ()) => HasField "unwrap" SDL_TrayCallback_Aux ty Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

ty ~ (Ptr Void -> Ptr SDL_TrayEntry -> IO ()) => HasField "unwrap" (Ptr SDL_TrayCallback_Aux) (Ptr ty :: Type) Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

type Rep SDL_TrayCallback_Aux Source # 
Instance details

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 # 
Instance details

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 at SDL3/SDL_tray.h 97:24

Since: 3.2.0

Instances

Instances details
Storable SDL_TrayCallback Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

Generic SDL_TrayCallback Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

Associated Types

type Rep SDL_TrayCallback 
Instance details

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))))
Show SDL_TrayCallback Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

Eq SDL_TrayCallback Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

Ord SDL_TrayCallback Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

HasFFIType SDL_TrayCallback Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

ReadRaw SDL_TrayCallback Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

StaticSize SDL_TrayCallback Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

WriteRaw SDL_TrayCallback Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

HasCField SDL_TrayCallback "unwrap" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

Associated Types

type CFieldType SDL_TrayCallback "unwrap" 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

Methods

offset# :: Proxy# SDL_TrayCallback -> Proxy# "unwrap" -> Int #

ty ~ FunPtr SDL_TrayCallback_Aux => HasField "unwrap" SDL_TrayCallback ty Source # 
Instance details

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 # 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

type Rep SDL_TrayCallback Source # 
Instance details

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 # 
Instance details

Defined in SDL3.Sys.Bindgen.Tray

type CFieldType SDL_TrayCallback "unwrap" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Tray