Ceci est une ancienne révision du document !
Table des matières
FileDialog [En cours de Traduction Wismerheal][WSL]
Cet objet représente une fenêtre permettant à l'utilisateur de choisir un fichier.
Fonctions
FileDialog
Fonction de construction.
Syntaxe
var myObject = new FileDialog();
var myObject = new FileDialog(parameters);
Arguments
- parameters - (object) paramètres de fenêtre
- title - (string) e titre de la fenêtre
- position - (Point) la position de la fenêtre
- opacity - (float) l'opacité de la fenêtre
- enabled - (boolean) le statut d'activation de la fenêtre
- visible - (boolean) le statut de la fenêtre visible
- acceptMode - (AcceptMode) le mode d'acceptation de fichier
- fileMode - (FileMode) le mode de fichier
- viewMode - (ViewMode) le mode de vue
- selectedFile - (string) le fichier sélectionné par défaut
- selectedNameFilter - (string) le nom du filtre sélectionné par défaut
- defaultSuffix - (string) le suffixe de fichier par défaut
- directory - (string) le répertoire par défaut
- filter - (Filter) le filtre
- nameFilter - (string) le nom du filtre
- nameFilters - (array) un tableau de noms de filtres à utiliser
- showDirectoriesOnly - (boolean) montrer seulement les répertoires
- dontResolveSymlinks - (boolean) ne solutionne pas les liens symboliques (Linux seulement)
- dontConfirmOverwrite - (boolean) ne confirme pas l'écrasement en écriture
- dontUseNativeDialog - (boolean) n'utilise pas un "dialog" natif
- readOnly - (boolean) show read-only files (Windows seulement)
- hideNameFilterDetails - (boolean) cache les détails de nom de filtre
- sidebarUrls - (array) un tableau d'urls affiché sur la barre du côté
- onClosed - (OnClosed évènement appelé quand la fenêtre est fermée
- onCurrentChanged - (OnCurrentChanged évènement appelé quand l'actuelle sélection est changée
- onDirectoryEntered - (OnDirectoryEntered évènement appelé quand le répertoire actuel est changé
- onFileSelected - (OnFileSelected évènement appelé quand la fenêtre est fermée
- onFileSelected - (OnFilesSelected évènement appelé quand la fenêtre est fermée
- onFilterSelected - (OnFilterSelected évènement appelé quand un filtre est sélectionné
Exceptions
- (ParameterTypeError) type de paramètre incorrect
- (ParameterCountError) compte de paramètre incorrect
Example
var myObject = new FileDialog();
var myObject = new FileDialog({ title: "Select a file", acceptMode: FileDialog.Open });
Méthodes
setTitle
Définit le titre de la fenêtre.
Syntaxe
myObject.setTitle(title);
Arguments
- title - (string) le titre de la fenêtre
Renvoi
- (FileDialog) ce "FileDialog"
setPosition
Définit la position de la fenêtre.
Syntaxe
myObject.setPosition(point);
Arguments
- point - (Point) la position de la fenêtre
Renvoi
- (FileDialog) ce "FileDialog"
setOpacity
Définit l'opacité de la fenêtre.
Syntaxe
myObject.setOpacity(opacity);
Arguments
- opacity - (float) l'opacité de la fenêtre
Renvoi
- (FileDialog) ce "FileDialog"
setEnabled
Définit le statut d'activité de la fenêtre.
Syntaxe
myObject.setEnabled(enabled);
Arguments
- enabled - (boolean) le statut d'activité de la fenêtre
Renvoi
- (FileDialog) ce "FileDialog"
setVisible
Définit le statut de visibilité de la fenêtre.
Syntaxe
myObject.setVisible(visible);
Arguments
- visible - (boolean) le statut de visibilité de la fenêtre
Renvois
- (FileDialog) ce "FileDialog"
close
Ferme al fenêtre.
Syntaxe
myObject.close();
Renvoi
- (FileDialog) ce "FileDialog"
title
Renvoi le titre de la fenêtre.
Syntaxe
myObject.title();
Renvoi
- (string) le titre de la fenêtre
position
Renvoi la position de la fenêtre.
Syntaxe
myObject.position();
Renvoi
- (Point) la position de la fenêtre
opacity
Renvoi l'opacité de la fenêtre.
Syntaxe
myObject.opacity();
Renvoi
- (float) l'opacité de la fenêtre
enabled
Renvoi le statut d’activité de la fenêtre.
Syntaxe
myObject.enabled();
Renvoi
- (boolean) the window's enabled status
visible
Renvoi le statut de visibilité de la fenêtre.
Syntaxe
myObject.visible();
Renvoi
- (boolean) le statut de visibilité de la fenêtre
setAcceptMode
Définit le mode d'acceptation.
Syntaxe
myObject.setAcceptMode(acceptMode);
Arguments
- acceptMode - (AcceptMode) le mode d'acceptation
Renvoi
- (FileDialog) ce "FileDialog"
setFileMode
Définit le mode de fichier.
Syntaxe
myObject.setFileMode(fileMode);
Arguments
- fileMode - (FileMode) le mode de fichier
Renvoi
- (FileDialog) ce "FileDialog"
setViewMode
Définit le mode de vue.
Syntaxe
myObject.setViewMode(viewMode);
Arguments
- viewMode - (ViewMode) le mode de vue
Renvoi
- (FileDialog) ce "FileDialog"
setLabelText
Définit un label de texte.
Syntaxe
myObject.setLabelText(dialogLabel, text);
Arguments
- dialogLabel - (DialogLabel) le label de texte
- text - (string) le label de texte
Renvoi
- (FileDialog) ce "FileDialog"
selectFile
Sélectionne un fichier.
Syntaxe
myObject.selectFile(filename);
Arguments
- filename - (string) le fichier sélectionné
Renvoi
- (FileDialog) ce "FileDialog"
selectNameFilter
Sélectionne le nom de filtre.
Syntaxe
myObject.selectNameFilter(filter);
Arguments
- filter - (string) le nom de filtre
Renvoi
- (FileDialog) ce "FileDialog"
setDefaultSuffix
Sélectionne le suffixe par défaut.
Syntaxe
myObject.setDefaultSuffix(defaultSuffix);
Arguments
- defaultSuffix - (string) le suffixe par défaut
Renvoi
- (FileDialog) ce "FileDialog"
setDirectory
Sélectionne le répertoire actuel.
Syntaxe
myObject.setDirectory(directory);
Arguments
- directory - (string) l'actuel répertoire
Renvoi
- (FileDialog) ce "FileDialog"
setFilter
Définit les filtres.
Syntaxe
myObject.setFilter(filters);
Arguments
- filters - (Filters) le filtres à utiliser
Renvoi
- (FileDialog) ce "FileDialog"
setNameFilter
Définit le nom du filtre.
Syntaxe
myObject.setNameFilter(nameFilter);
Arguments
- nameFilter - (string) le nom du filtre
Renvoi
- (FileDialog) this FileDialog
setNameFilters
Sets the name filters. Définit le nom des filtres.
Syntaxe
myObject.setNameFilters(nameFilters);
Arguments
- nameFilters - (array) un tableau avec le nom des filtres à utiliser.
Renvois
- (FileDialog) ce "FileDialog"
setShowDirectoriesOnly
La fenêtre doit-elle afficher les répertoires.
Syntaxe
myObject.setShowDirectoriesOnly(showDirectoriesOnly);
Arguments
- showDirectoriesOnly - (boolean) montre seulement les répertoires
Renvoi
- (FileDialog) ce "FileDialog"
setDontResolveSymlinks
La fenêtre doit-elle résoudre les liens symboliques.
Syntaxe
myObject.setDontResolveSymlinks(dontResolveSymlinks);
Arguments
- dontResolveSymlinks - (boolean) résout les liens symboliques
Renvoi
- (FileDialog) ce "FileDialog"
setDontConfirmOverwrite
Should the window ask for confirmation when overwriting a file.
Syntax
myObject.setDontConfirmOverwrite(dontConfirmOverwrite);
Arguments
- dontConfirmOverwrite - (boolean) ask for confirmation when overwriting a file
Returns
- (FileDialog) this FileDialog
setDontUseNativeDialog
Should the window use native a dialog.
Syntax
myObject.setDontUseNativeDialog(dontUseNativeDialog);
Arguments
- dontUseNativeDialog - (boolean) use native a dialog
Returns
- (FileDialog) this FileDialog
setReadOnly
Should the window show readonly files.
Syntax
myObject.setReadOnly(readOnly);
Arguments
- readOnly - (boolean) show readonly files
Returns
- (FileDialog) this FileDialog
setHideNameFilterDetails
Hide name filter details.
Syntax
myObject.setHideNameFilterDetails(hideNameFilterDetails);
Arguments
- hideNameFilterDetails - (boolean) hide name filter details
Returns
- (FileDialog) this FileDialog
setSidebarUrls
Sets the sidebar urls.
Syntax
myObject.setSidebarUrls(sidebarUrls);
Arguments
- sidebarUrls - (array) the sidebar urls
Returns
- (FileDialog) this FileDialog
selectedFile
Returns the selected file.
Syntax
myObject.selectedFile();
Returns
- (string) the selected file
selectedFiles
Returns the selected files.
Syntax
myObject.selectedFiles();
Returns
- (array) the selected files
selectedNameFilter
Returns the name filter.
Syntax
myObject.selectedNameFilter();
Returns
- (string) the selected name filter
selectedNameFilter
Returns the name filter.
Syntax
myObject.selectedNameFilter();
Returns
- (string) the selected name filter
show
Show the window. (non-blocking) Use the OnClosed event to know when the window has been closed.
Syntax
myObject.show();
Returns
- (FileDialog) this FileDialog
showModal
Show the window. (blocking)
Syntax
myObject.showModal();
Returns
- (integer) the window result (0 means that it has been canceled)
Events
onClosed
Called when the window is closed.
Syntax
myObject.onClosed = function(result) {};
Arguments
- result - (integer) the window result (0 means that it has been canceled)
Example
myObject.onClosed = function(result) { if(result) { //Event action } };
onCurrentChanged
Called when the current file has changed.
Syntax
myObject.onCurrentChanged = function(path) {};
Arguments
- path - (string) the current file
Example
myObject.onCurrentChanged = function(path) { //Event action };
onDirectoryEntered
Called when the current directory has changed.
Syntax
myObject.onDirectoryEntered = function(directory) {};
Arguments
- directory - (string) the current file
Example
myObject.onDirectoryEntered = function(directory) { //Event action };
onFileSelected
Called when the dialog is accepted.
Syntax
myObject.onFileSelected = function(file) {};
Arguments
- file - (string) the selected file
Example
myObject.onFileSelected = function(file) { //Event action };
onFilesSelected
Called when the dialog is accepted.
Syntax
myObject.onFilesSelected = function(files) {};
Arguments
- files - (array) the selected files, as an array containing filenames
Example
myObject.onFilesSelected = function(files) { //Event action };
onFilterSelected
Called when the filter is changed.
Syntax
myObject.onFilterSelected = function(filter) {};
Arguments
- filter - (string) the new filter
Example
myObject.onFilterSelected = function(filter) { //Event action };
Attributes
title
The window's title. (string)
position
The window's position. (Point)
opacity
The window's opacity. (float)
enabled
The window's enabled status. (boolean)
visible
The window's visible status. (boolean)
Enumerations
AcceptMode
Sets the accept mode of the window.
Values
- Open: the dialog is used to open a file
- Save: the dialog is used to save to a file
FileMode
Sets the file mode of the window.
Values
- AnyFile: the selected file has not to exist to be selected
- ExistingFile: there is only one file that can be selected and it has to exist
- ExistingFiles: zero or more existing file can be selected
- Directory: a directory can be selected
ViewMode
Sets the view mode of the window.
Values
- Detail: show files with details
- List: show only the file name and icon
DialogLabel
The label of the window to edit.
Values
- LookIn: the "look in" label
- FileName: the filename label
- FileType: the filetype label
- Accept: the accept label
- Reject: the reject label
Filters
The filters to use.
Values
- Dirs: list directories
- AllDirs: list all directories without applying filters to directory names
- Files: list files
- Drives: list drives (Windows only)
- NoSymLinks: do not list symbolic links (Linux only)
- NoDotAndDotDot: do not list the special entries . and ..
- NoDot: do not list the special entry .
- NoDotDot: do not list the special entry ..
- AllEntries: list directories, files and drives (same as Dirs | Files | Drives)
- Readable: list readable files
- Writable: list writable files
- Executable: list executable files
- Modified: list modified files (Windows only)
- Hidden: list hidden files (on Linux, files starting with a dot)
- System: list system files
- CaseSensitive: the filter string should be case sensitive
Notes
This is a flag enumeration, this means that you can use multiple values using the | operator. Example :
myObject.setFilter(FileDialog.Files | FileDialog.Executable); //List only files that are executable