| Safe Haskell | None |
|---|---|
| Language | GHC2021 |
SDL3.Sys.Bindgen.Dialog
Description
File dialog support.
SDL offers file dialogs, to let users select files with native GUI interfaces. There are "open" dialogs, "save" dialogs, and folder selection dialogs. The app can control some details, such as filtering to specific files, or whether multiple files can be selected by the user.
Note that launching a file dialog is a non-blocking operation; control returns to the app immediately, and a callback is called later (possibly in another thread) when the user makes a choice. An entry for filters for file dialogs.
name is a user-readable label for the filter (for example, "Office document").
pattern is a semicolon-separated list of file extensions (for example, "doc;docx"). File extensions may only contain alphanumeric characters, hyphens, underscores and periods. Alternatively, the whole string can be a single asterisk ("*"), which serves as an "All files" filter.
- See also
SDL_DialogFileCallback,sDL_ShowOpenFileDialog,sDL_ShowSaveFileDialog,sDL_ShowOpenFolderDialog,sDL_ShowFileDialogWithProperties
Since: 3.2.0
Synopsis
- data SDL_DialogFileFilter = SDL_DialogFileFilter {}
- newtype SDL_DialogFileCallback_Aux = SDL_DialogFileCallback_Aux {}
- newtype SDL_DialogFileCallback = SDL_DialogFileCallback {}
- newtype SDL_FileDialogType = SDL_FileDialogType {}
- pattern SDL_FILEDIALOG_OPENFILE :: SDL_FileDialogType
- pattern SDL_FILEDIALOG_SAVEFILE :: SDL_FileDialogType
- pattern SDL_FILEDIALOG_OPENFOLDER :: SDL_FileDialogType
- sDL_PROP_FILE_DIALOG_FILTERS_POINTER :: ByteString
- sDL_PROP_FILE_DIALOG_NFILTERS_NUMBER :: ByteString
- sDL_PROP_FILE_DIALOG_WINDOW_POINTER :: ByteString
- sDL_PROP_FILE_DIALOG_LOCATION_STRING :: ByteString
- sDL_PROP_FILE_DIALOG_MANY_BOOLEAN :: ByteString
- sDL_PROP_FILE_DIALOG_TITLE_STRING :: ByteString
- sDL_PROP_FILE_DIALOG_ACCEPT_STRING :: ByteString
- sDL_PROP_FILE_DIALOG_CANCEL_STRING :: ByteString
Documentation
data SDL_DialogFileFilter Source #
- C declaration
struct SDL_DialogFileFilter, defined atSDL3/SDL_dialog.h 70:16
Constructors
| SDL_DialogFileFilter | |
Instances
newtype SDL_DialogFileCallback_Aux Source #
Auxiliary type used by SDL_DialogFileCallback
- C declaration
SDL_DialogFileCallback, defined atSDL3/SDL_dialog.h 113:24
Constructors
| SDL_DialogFileCallback_Aux | |
Instances
| Generic SDL_DialogFileCallback_Aux Source # | |||||
Defined in SDL3.Sys.Bindgen.Dialog Associated Types
Methods from :: SDL_DialogFileCallback_Aux -> Rep SDL_DialogFileCallback_Aux x # to :: Rep SDL_DialogFileCallback_Aux x -> SDL_DialogFileCallback_Aux # | |||||
| FromFunPtr SDL_DialogFileCallback_Aux Source # | |||||
Defined in SDL3.Sys.Bindgen.Dialog | |||||
| ToFunPtr SDL_DialogFileCallback_Aux Source # | |||||
Defined in SDL3.Sys.Bindgen.Dialog Methods toFunPtr :: SDL_DialogFileCallback_Aux -> IO (FunPtr SDL_DialogFileCallback_Aux) # | |||||
| HasCField SDL_DialogFileCallback_Aux "unwrap" Source # | |||||
Defined in SDL3.Sys.Bindgen.Dialog Associated Types
| |||||
| ty ~ (Ptr Void -> PtrConst (PtrConst CChar) -> CInt -> IO ()) => HasField "unwrap" SDL_DialogFileCallback_Aux ty Source # | |||||
Defined in SDL3.Sys.Bindgen.Dialog Methods hasField :: SDL_DialogFileCallback_Aux -> (ty -> SDL_DialogFileCallback_Aux, ty) # | |||||
| ty ~ (Ptr Void -> PtrConst (PtrConst CChar) -> CInt -> IO ()) => HasField "unwrap" (Ptr SDL_DialogFileCallback_Aux) (Ptr ty :: Type) Source # | |||||
Defined in SDL3.Sys.Bindgen.Dialog Methods getField :: Ptr SDL_DialogFileCallback_Aux -> Ptr ty # | |||||
| type Rep SDL_DialogFileCallback_Aux Source # | |||||
Defined in SDL3.Sys.Bindgen.Dialog type Rep SDL_DialogFileCallback_Aux = D1 ('MetaData "SDL_DialogFileCallback_Aux" "SDL3.Sys.Bindgen.Dialog" "sdl3-bindgen-sys-0.0.1.0-inplace" 'True) (C1 ('MetaCons "SDL_DialogFileCallback_Aux" 'PrefixI 'True) (S1 ('MetaSel ('Just "unwrap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Ptr Void -> PtrConst (PtrConst CChar) -> CInt -> IO ())))) | |||||
| type CFieldType SDL_DialogFileCallback_Aux "unwrap" Source # | |||||
Defined in SDL3.Sys.Bindgen.Dialog type CFieldType SDL_DialogFileCallback_Aux "unwrap" = Ptr Void -> PtrConst (PtrConst CChar) -> CInt -> IO () | |||||
newtype SDL_DialogFileCallback Source #
Callback used by file dialog functions.
The specific usage is described in each function.
If filelist is:
- NULL, an error occurred. Details can be obtained with SDL_GetError().
- A pointer to NULL, the user either didn't choose any file or canceled the dialog.
- A pointer to non-
NULL, the user chose one or more files. The argument is a null-terminated array of pointers to UTF-8 encoded strings, each containing a path.
The filelist argument should not be freed; it will automatically be freed when the callback returns.
The filter argument is the index of the filter that was selected, or -1 if no filter was selected or if the platform or method doesn't support fetching the selected filter.
In Android, the filelist are content:// URIs. They should be opened using SDL_IOFromFile() with appropriate modes. This applies both to open and save file dialog.
userdata- an app-provided pointer, for the callback's use.
filelist- the file(s) chosen by the user.
filter- index of the selected filter.
- See also
SDL_DialogFileFilter,sDL_ShowOpenFileDialog,sDL_ShowSaveFileDialog,sDL_ShowOpenFolderDialog,sDL_ShowFileDialogWithProperties- C declaration
SDL_DialogFileCallback, defined atSDL3/SDL_dialog.h 113:24
Since: 3.2.0
Constructors
| SDL_DialogFileCallback | |
Fields | |
Instances
| Storable SDL_DialogFileCallback Source # | |||||
Defined in SDL3.Sys.Bindgen.Dialog Methods sizeOf :: SDL_DialogFileCallback -> Int # alignment :: SDL_DialogFileCallback -> Int # peekElemOff :: Ptr SDL_DialogFileCallback -> Int -> IO SDL_DialogFileCallback # pokeElemOff :: Ptr SDL_DialogFileCallback -> Int -> SDL_DialogFileCallback -> IO () # peekByteOff :: Ptr b -> Int -> IO SDL_DialogFileCallback # pokeByteOff :: Ptr b -> Int -> SDL_DialogFileCallback -> IO () # peek :: Ptr SDL_DialogFileCallback -> IO SDL_DialogFileCallback # poke :: Ptr SDL_DialogFileCallback -> SDL_DialogFileCallback -> IO () # | |||||
| Generic SDL_DialogFileCallback Source # | |||||
Defined in SDL3.Sys.Bindgen.Dialog Associated Types
Methods from :: SDL_DialogFileCallback -> Rep SDL_DialogFileCallback x # to :: Rep SDL_DialogFileCallback x -> SDL_DialogFileCallback # | |||||
| Show SDL_DialogFileCallback Source # | |||||
Defined in SDL3.Sys.Bindgen.Dialog Methods showsPrec :: Int -> SDL_DialogFileCallback -> ShowS # show :: SDL_DialogFileCallback -> String # showList :: [SDL_DialogFileCallback] -> ShowS # | |||||
| Eq SDL_DialogFileCallback Source # | |||||
Defined in SDL3.Sys.Bindgen.Dialog Methods (==) :: SDL_DialogFileCallback -> SDL_DialogFileCallback -> Bool # (/=) :: SDL_DialogFileCallback -> SDL_DialogFileCallback -> Bool # | |||||
| Ord SDL_DialogFileCallback Source # | |||||
Defined in SDL3.Sys.Bindgen.Dialog Methods compare :: SDL_DialogFileCallback -> SDL_DialogFileCallback -> Ordering # (<) :: SDL_DialogFileCallback -> SDL_DialogFileCallback -> Bool # (<=) :: SDL_DialogFileCallback -> SDL_DialogFileCallback -> Bool # (>) :: SDL_DialogFileCallback -> SDL_DialogFileCallback -> Bool # (>=) :: SDL_DialogFileCallback -> SDL_DialogFileCallback -> Bool # max :: SDL_DialogFileCallback -> SDL_DialogFileCallback -> SDL_DialogFileCallback # min :: SDL_DialogFileCallback -> SDL_DialogFileCallback -> SDL_DialogFileCallback # | |||||
| HasFFIType SDL_DialogFileCallback Source # | |||||
Defined in SDL3.Sys.Bindgen.Dialog Associated Types
| |||||
| ReadRaw SDL_DialogFileCallback Source # | |||||
Defined in SDL3.Sys.Bindgen.Dialog Methods readRaw :: Ptr SDL_DialogFileCallback -> IO SDL_DialogFileCallback # | |||||
| StaticSize SDL_DialogFileCallback Source # | |||||
Defined in SDL3.Sys.Bindgen.Dialog Methods | |||||
| WriteRaw SDL_DialogFileCallback Source # | |||||
Defined in SDL3.Sys.Bindgen.Dialog Methods writeRaw :: Ptr SDL_DialogFileCallback -> SDL_DialogFileCallback -> IO () # | |||||
| HasCField SDL_DialogFileCallback "unwrap" Source # | |||||
Defined in SDL3.Sys.Bindgen.Dialog Associated Types
| |||||
| ty ~ FunPtr SDL_DialogFileCallback_Aux => HasField "unwrap" SDL_DialogFileCallback ty Source # | |||||
Defined in SDL3.Sys.Bindgen.Dialog Methods hasField :: SDL_DialogFileCallback -> (ty -> SDL_DialogFileCallback, ty) # | |||||
| ty ~ FunPtr SDL_DialogFileCallback_Aux => HasField "unwrap" (Ptr SDL_DialogFileCallback) (Ptr ty :: Type) Source # | |||||
Defined in SDL3.Sys.Bindgen.Dialog Methods getField :: Ptr SDL_DialogFileCallback -> Ptr ty # | |||||
| type Rep SDL_DialogFileCallback Source # | |||||
Defined in SDL3.Sys.Bindgen.Dialog type Rep SDL_DialogFileCallback = D1 ('MetaData "SDL_DialogFileCallback" "SDL3.Sys.Bindgen.Dialog" "sdl3-bindgen-sys-0.0.1.0-inplace" 'True) (C1 ('MetaCons "SDL_DialogFileCallback" 'PrefixI 'True) (S1 ('MetaSel ('Just "unwrap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (FunPtr SDL_DialogFileCallback_Aux)))) | |||||
| type FFIType SDL_DialogFileCallback Source # | |||||
Defined in SDL3.Sys.Bindgen.Dialog | |||||
| type CFieldType SDL_DialogFileCallback "unwrap" Source # | |||||
Defined in SDL3.Sys.Bindgen.Dialog | |||||
newtype SDL_FileDialogType Source #
Various types of file dialogs.
This is used by SDL_ShowFileDialogWithProperties() to decide what kind of dialog to present to the user.
- See also
sDL_ShowFileDialogWithProperties- C declaration
enum SDL_FileDialogType, defined atSDL3/SDL_dialog.h 272:14
Since: 3.2.0
Constructors
| SDL_FileDialogType | |
Instances
| Storable SDL_FileDialogType Source # | |||||
Defined in SDL3.Sys.Bindgen.Dialog Methods sizeOf :: SDL_FileDialogType -> Int # alignment :: SDL_FileDialogType -> Int # peekElemOff :: Ptr SDL_FileDialogType -> Int -> IO SDL_FileDialogType # pokeElemOff :: Ptr SDL_FileDialogType -> Int -> SDL_FileDialogType -> IO () # peekByteOff :: Ptr b -> Int -> IO SDL_FileDialogType # pokeByteOff :: Ptr b -> Int -> SDL_FileDialogType -> IO () # peek :: Ptr SDL_FileDialogType -> IO SDL_FileDialogType # poke :: Ptr SDL_FileDialogType -> SDL_FileDialogType -> IO () # | |||||
| Generic SDL_FileDialogType Source # | |||||
Defined in SDL3.Sys.Bindgen.Dialog Associated Types
Methods from :: SDL_FileDialogType -> Rep SDL_FileDialogType x # to :: Rep SDL_FileDialogType x -> SDL_FileDialogType # | |||||
| Read SDL_FileDialogType Source # | |||||
Defined in SDL3.Sys.Bindgen.Dialog Methods readsPrec :: Int -> ReadS SDL_FileDialogType # readList :: ReadS [SDL_FileDialogType] # | |||||
| Show SDL_FileDialogType Source # | |||||
Defined in SDL3.Sys.Bindgen.Dialog Methods showsPrec :: Int -> SDL_FileDialogType -> ShowS # show :: SDL_FileDialogType -> String # showList :: [SDL_FileDialogType] -> ShowS # | |||||
| Eq SDL_FileDialogType Source # | |||||
Defined in SDL3.Sys.Bindgen.Dialog Methods (==) :: SDL_FileDialogType -> SDL_FileDialogType -> Bool # (/=) :: SDL_FileDialogType -> SDL_FileDialogType -> Bool # | |||||
| Ord SDL_FileDialogType Source # | |||||
Defined in SDL3.Sys.Bindgen.Dialog Methods compare :: SDL_FileDialogType -> SDL_FileDialogType -> Ordering # (<) :: SDL_FileDialogType -> SDL_FileDialogType -> Bool # (<=) :: SDL_FileDialogType -> SDL_FileDialogType -> Bool # (>) :: SDL_FileDialogType -> SDL_FileDialogType -> Bool # (>=) :: SDL_FileDialogType -> SDL_FileDialogType -> Bool # max :: SDL_FileDialogType -> SDL_FileDialogType -> SDL_FileDialogType # min :: SDL_FileDialogType -> SDL_FileDialogType -> SDL_FileDialogType # | |||||
| Prim SDL_FileDialogType Source # | |||||
Defined in SDL3.Sys.Bindgen.Dialog Methods sizeOfType# :: Proxy SDL_FileDialogType -> Int# # sizeOf# :: SDL_FileDialogType -> Int# # alignmentOfType# :: Proxy SDL_FileDialogType -> Int# # alignment# :: SDL_FileDialogType -> Int# # indexByteArray# :: ByteArray# -> Int# -> SDL_FileDialogType # readByteArray# :: MutableByteArray# s -> Int# -> State# s -> (# State# s, SDL_FileDialogType #) # writeByteArray# :: MutableByteArray# s -> Int# -> SDL_FileDialogType -> State# s -> State# s # setByteArray# :: MutableByteArray# s -> Int# -> Int# -> SDL_FileDialogType -> State# s -> State# s # indexOffAddr# :: Addr# -> Int# -> SDL_FileDialogType # readOffAddr# :: Addr# -> Int# -> State# s -> (# State# s, SDL_FileDialogType #) # writeOffAddr# :: Addr# -> Int# -> SDL_FileDialogType -> State# s -> State# s # setOffAddr# :: Addr# -> Int# -> Int# -> SDL_FileDialogType -> State# s -> State# s # | |||||
| CEnum SDL_FileDialogType Source # | |||||
Defined in SDL3.Sys.Bindgen.Dialog Associated Types
Methods toCEnum :: CEnumZ SDL_FileDialogType -> SDL_FileDialogType # fromCEnum :: SDL_FileDialogType -> CEnumZ SDL_FileDialogType # declaredValues :: proxy SDL_FileDialogType -> DeclaredValues SDL_FileDialogType # showsUndeclared :: proxy SDL_FileDialogType -> Int -> CEnumZ SDL_FileDialogType -> ShowS # readPrecUndeclared :: ReadPrec SDL_FileDialogType # isDeclared :: SDL_FileDialogType -> Bool # mkDeclared :: CEnumZ SDL_FileDialogType -> Maybe SDL_FileDialogType # | |||||
| SequentialCEnum SDL_FileDialogType Source # | |||||
Defined in SDL3.Sys.Bindgen.Dialog | |||||
| HasFFIType SDL_FileDialogType Source # | |||||
Defined in SDL3.Sys.Bindgen.Dialog Associated Types
Methods toFFIType :: SDL_FileDialogType -> FFIType SDL_FileDialogType # fromFFIType :: FFIType SDL_FileDialogType -> SDL_FileDialogType # | |||||
| ReadRaw SDL_FileDialogType Source # | |||||
Defined in SDL3.Sys.Bindgen.Dialog Methods readRaw :: Ptr SDL_FileDialogType -> IO SDL_FileDialogType # | |||||
| StaticSize SDL_FileDialogType Source # | |||||
Defined in SDL3.Sys.Bindgen.Dialog Methods staticSizeOf :: Proxy SDL_FileDialogType -> Int # | |||||
| WriteRaw SDL_FileDialogType Source # | |||||
Defined in SDL3.Sys.Bindgen.Dialog Methods writeRaw :: Ptr SDL_FileDialogType -> SDL_FileDialogType -> IO () # | |||||
| HasCField SDL_FileDialogType "unwrap" Source # | |||||
Defined in SDL3.Sys.Bindgen.Dialog Associated Types
| |||||
| ty ~ CUInt => HasField "unwrap" SDL_FileDialogType ty Source # | |||||
Defined in SDL3.Sys.Bindgen.Dialog Methods hasField :: SDL_FileDialogType -> (ty -> SDL_FileDialogType, ty) # | |||||
| ty ~ CUInt => HasField "unwrap" (Ptr SDL_FileDialogType) (Ptr ty :: Type) Source # | |||||
Defined in SDL3.Sys.Bindgen.Dialog Methods getField :: Ptr SDL_FileDialogType -> Ptr ty # | |||||
| type Rep SDL_FileDialogType Source # | |||||
Defined in SDL3.Sys.Bindgen.Dialog type Rep SDL_FileDialogType = D1 ('MetaData "SDL_FileDialogType" "SDL3.Sys.Bindgen.Dialog" "sdl3-bindgen-sys-0.0.1.0-inplace" 'True) (C1 ('MetaCons "SDL_FileDialogType" 'PrefixI 'True) (S1 ('MetaSel ('Just "unwrap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CUInt))) | |||||
| type CEnumZ SDL_FileDialogType Source # | |||||
Defined in SDL3.Sys.Bindgen.Dialog | |||||
| type FFIType SDL_FileDialogType Source # | |||||
Defined in SDL3.Sys.Bindgen.Dialog | |||||
| type CFieldType SDL_FileDialogType "unwrap" Source # | |||||
Defined in SDL3.Sys.Bindgen.Dialog | |||||
pattern SDL_FILEDIALOG_OPENFILE :: SDL_FileDialogType Source #
- C declaration
SDL_FILEDIALOG_OPENFILE, defined atSDL3/SDL_dialog.h 274:5
pattern SDL_FILEDIALOG_SAVEFILE :: SDL_FileDialogType Source #
- C declaration
SDL_FILEDIALOG_SAVEFILE, defined atSDL3/SDL_dialog.h 275:5
pattern SDL_FILEDIALOG_OPENFOLDER :: SDL_FileDialogType Source #
- C declaration
SDL_FILEDIALOG_OPENFOLDER, defined atSDL3/SDL_dialog.h 276:5
sDL_PROP_FILE_DIALOG_FILTERS_POINTER :: ByteString Source #
- C declaration
macro SDL_PROP_FILE_DIALOG_FILTERS_POINTER, literal"SDL.filedialog.filters", defined atSDL3/SDL_dialog.h 328:9
sDL_PROP_FILE_DIALOG_NFILTERS_NUMBER :: ByteString Source #
- C declaration
macro SDL_PROP_FILE_DIALOG_NFILTERS_NUMBER, literal"SDL.filedialog.nfilters", defined atSDL3/SDL_dialog.h 329:9
sDL_PROP_FILE_DIALOG_WINDOW_POINTER :: ByteString Source #
- C declaration
macro SDL_PROP_FILE_DIALOG_WINDOW_POINTER, literal"SDL.filedialog.window", defined atSDL3/SDL_dialog.h 330:9
sDL_PROP_FILE_DIALOG_LOCATION_STRING :: ByteString Source #
- C declaration
macro SDL_PROP_FILE_DIALOG_LOCATION_STRING, literal"SDL.filedialog.location", defined atSDL3/SDL_dialog.h 331:9
sDL_PROP_FILE_DIALOG_MANY_BOOLEAN :: ByteString Source #
- C declaration
macro SDL_PROP_FILE_DIALOG_MANY_BOOLEAN, literal"SDL.filedialog.many", defined atSDL3/SDL_dialog.h 332:9
sDL_PROP_FILE_DIALOG_TITLE_STRING :: ByteString Source #
- C declaration
macro SDL_PROP_FILE_DIALOG_TITLE_STRING, literal"SDL.filedialog.title", defined atSDL3/SDL_dialog.h 333:9
sDL_PROP_FILE_DIALOG_ACCEPT_STRING :: ByteString Source #
- C declaration
macro SDL_PROP_FILE_DIALOG_ACCEPT_STRING, literal"SDL.filedialog.accept", defined atSDL3/SDL_dialog.h 334:9
sDL_PROP_FILE_DIALOG_CANCEL_STRING :: ByteString Source #
- C declaration
macro SDL_PROP_FILE_DIALOG_CANCEL_STRING, literal"SDL.filedialog.cancel", defined atSDL3/SDL_dialog.h 335:9