Crosstales.FB.WrapperExample Class Reference

Example for a custom wrapper with all callbacks (only for demonstration - it doesn't do anything). NOTE: please make sure you understand the Wrapper and its variables More...

Inheritance diagram for Crosstales.FB.WrapperExample:
Crosstales.FB.Wrapper.BaseCustomFileBrowser Crosstales.FB.Wrapper.IFileBrowser

Public Member Functions

override string[] OpenFiles (string title, string directory, string defaultName, bool multiselect, params ExtensionFilter[] extensions)
 Open native file browser for multiple files. More...
 
override string[] OpenFolders (string title, string directory, bool multiselect)
 Open native folder browser for multiple folders. More...
 
override string SaveFile (string title, string directory, string defaultName, params ExtensionFilter[] extensions)
 Open native save file browser. More...
 
override void OpenFilesAsync (string title, string directory, string defaultName, bool multiselect, ExtensionFilter[] extensions, System.Action< string[]> cb)
 Asynchronously opens native file browser for multiple files. More...
 
override void OpenFoldersAsync (string title, string directory, bool multiselect, System.Action< string[]> cb)
 Asynchronously opens native folder browser for multiple folders. More...
 
override void SaveFileAsync (string title, string directory, string defaultName, ExtensionFilter[] extensions, System.Action< string > cb)
 Asynchronously opens native save file browser. More...
 
- Public Member Functions inherited from Crosstales.FB.Wrapper.BaseCustomFileBrowser
string OpenSingleFile (string title, string directory, string defaultName, params ExtensionFilter[] extensions)
 Open native file browser for a single file. More...
 
string OpenSingleFolder (string title, string directory)
 Open native folder browser for a single folder. More...
 

Properties

override bool canOpenFile [get]
 
override bool canOpenFolder [get]
 
override bool canSaveFile [get]
 
override bool canOpenMultipleFiles [get]
 
override bool canOpenMultipleFolders [get]
 
override bool isPlatformSupported [get]
 
override bool isWorkingInEditor [get]
 
override string CurrentOpenSingleFile [get, set]
 
override string[] CurrentOpenFiles [get, set]
 
override string CurrentOpenSingleFolder [get, set]
 
override string[] CurrentOpenFolders [get, set]
 
override string CurrentSaveFile [get, set]
 
- Properties inherited from Crosstales.FB.Wrapper.BaseCustomFileBrowser
abstract bool canOpenFile [get]
 
abstract bool canOpenFolder [get]
 
abstract bool canSaveFile [get]
 
abstract bool canOpenMultipleFiles [get]
 
abstract bool canOpenMultipleFolders [get]
 
abstract bool isPlatformSupported [get]
 
abstract bool isWorkingInEditor [get]
 
abstract string CurrentOpenSingleFile [get, set]
 
abstract string[] CurrentOpenFiles [get, set]
 
abstract string CurrentOpenSingleFolder [get, set]
 
abstract string[] CurrentOpenFolders [get, set]
 
abstract string CurrentSaveFile [get, set]
 
virtual byte[] CurrentOpenSingleFileData [get]
 
virtual byte[] CurrentSaveFileData [get, set]
 
- Properties inherited from Crosstales.FB.Wrapper.IFileBrowser
bool canOpenFile [get]
 Indicates if this wrapper can open a file. More...
 
bool canOpenFolder [get]
 Indicates if this wrapper can open a folder. More...
 
bool canSaveFile [get]
 Indicates if this wrapper can save a file. More...
 
bool canOpenMultipleFiles [get]
 Indicates if this wrapper can open multiple files. More...
 
bool canOpenMultipleFolders [get]
 Indicates if this wrapper can open multiple folders. More...
 
bool isPlatformSupported [get]
 Indicates if this wrapper is supporting the current platform. More...
 
bool isWorkingInEditor [get]
 Indicates if this wrapper is working directly inside the Unity Editor (without 'Play'-mode). More...
 
string CurrentOpenSingleFile [get, set]
 Returns the file from the last "OpenSingleFile"-action. More...
 
string[] CurrentOpenFiles [get, set]
 Returns the array of files from the last "OpenFiles"-action. More...
 
string CurrentOpenSingleFolder [get, set]
 Returns the folder from the last "OpenSingleFolder"-action. More...
 
string[] CurrentOpenFolders [get, set]
 Returns the array of folders from the last "OpenFolders"-action. More...
 
string CurrentSaveFile [get, set]
 Returns the file from the last "SaveFile"-action. More...
 
byte[] CurrentOpenSingleFileData [get]
 Returns the data of the file from the last "OpenSingleFile"-action. More...
 
byte[] CurrentSaveFileData [get, set]
 The data for the "SaveFile"-action. More...
 

Additional Inherited Members

- Protected Attributes inherited from Crosstales.FB.Wrapper.BaseCustomFileBrowser
byte[] openSingleFileData
 
string lastOpenFile
 

Detailed Description

Example for a custom wrapper with all callbacks (only for demonstration - it doesn't do anything). NOTE: please make sure you understand the Wrapper and its variables

Member Function Documentation

◆ OpenFiles()

override string [] Crosstales.FB.WrapperExample.OpenFiles ( string  title,
string  directory,
string  defaultName,
bool  multiselect,
params ExtensionFilter[]  extensions 
)
virtual

Open native file browser for multiple files.

Parameters
titleDialog title
directoryRoot directory
defaultNameDefault file name (currently only supported under Windows standalone)
multiselectAllow multiple file selection
extensionsList of extension filters. Filter Example: new ExtensionFilter("Image Files", "jpg", "png")
Returns
Returns array of chosen files. Null when cancelled

Implements Crosstales.FB.Wrapper.BaseCustomFileBrowser.

◆ OpenFilesAsync()

override void Crosstales.FB.WrapperExample.OpenFilesAsync ( string  title,
string  directory,
string  defaultName,
bool  multiselect,
ExtensionFilter[]  extensions,
System.Action< string[]>  cb 
)
virtual

Asynchronously opens native file browser for multiple files.

Parameters
titleDialog title
directoryRoot directory
defaultNameDefault file name (currently only supported under Windows standalone)
multiselectAllow multiple file selection
extensionsList of extension filters. Filter Example: new ExtensionFilter("Image Files", "jpg", "png")
cbCallback for the async operation.
Returns
Returns array of chosen files. Null when cancelled

Implements Crosstales.FB.Wrapper.BaseCustomFileBrowser.

◆ OpenFolders()

override string [] Crosstales.FB.WrapperExample.OpenFolders ( string  title,
string  directory,
bool  multiselect 
)
virtual

Open native folder browser for multiple folders.

Parameters
titleDialog title
directoryRoot directory
multiselectAllow multiple folder selection
Returns
Returns array of chosen folders. Null when cancelled

Implements Crosstales.FB.Wrapper.BaseCustomFileBrowser.

◆ OpenFoldersAsync()

override void Crosstales.FB.WrapperExample.OpenFoldersAsync ( string  title,
string  directory,
bool  multiselect,
System.Action< string[]>  cb 
)
virtual

Asynchronously opens native folder browser for multiple folders.

Parameters
titleDialog title
directoryRoot directory
multiselectAllow multiple folder selection
cbCallback for the async operation.
Returns
Returns array of chosen folders. Null when cancelled

Implements Crosstales.FB.Wrapper.BaseCustomFileBrowser.

◆ SaveFile()

override string Crosstales.FB.WrapperExample.SaveFile ( string  title,
string  directory,
string  defaultName,
params ExtensionFilter[]  extensions 
)
virtual

Open native save file browser.

Parameters
titleDialog title
directoryRoot directory
defaultNameDefault file name
extensionsList of extension filters. Filter Example: new ExtensionFilter("Image Files", "jpg", "png")
Returns
Returns chosen file. Null when cancelled

Implements Crosstales.FB.Wrapper.BaseCustomFileBrowser.

◆ SaveFileAsync()

override void Crosstales.FB.WrapperExample.SaveFileAsync ( string  title,
string  directory,
string  defaultName,
ExtensionFilter[]  extensions,
System.Action< string >  cb 
)
virtual

Asynchronously opens native save file browser.

Parameters
titleDialog title
directoryRoot directory
defaultNameDefault file name
extensionsList of extension filters. Filter Example: new ExtensionFilter("Image Files", "jpg", "png")
cbCallback for the async operation.
Returns
Returns chosen file. Null when cancelled

Implements Crosstales.FB.Wrapper.BaseCustomFileBrowser.


The documentation for this class was generated from the following file:
  • C:/Users/slaub/Unity/assets/FileBrowser/FileBrowserPro/Assets/Plugins/crosstales/FileBrowser/Scripts/WrapperExample.cs