confirm

 

confirm

Affiche une boîte de dialogue modale de confirmation.

Méthode de

Objet Install

Syntaxe

int confirm( Chaîne aText );
int confirm( Chaîne aText,
             Chaîne aDialogTitle,
             Nombre aButtonFlags,
             Chaîne aButton0Title,
             Chaîne aButton1Title,
             Chaîne aButton2Title,
             Chaîne aCheckMsg,
             Objet aCheckState );

Paramètres

Pour la seconde syntaxe, la méthode étendue confirm() est supportée depuis Gecko 1.8. Elle accepte jusqu'à 8 paramètres. Dans les versions précédentes de Gecko seule la première syntaxe était supportée, méthode à un paramètre, qui retournera une erreur pour la forme étendue. Voir les notes à la fin de ce document pour une manière sûre d'implémenter une procédure de secours.

aText
La chaîne à afficher dans la boîte de confirmation. Cette chaîne est généralement sous la forme d'un message pour l'utilisateur (par exemple : « Êtes-vous sûr de vouloir effacer le(s) fichier(s) sélectionné(s) ? »).
aDialogTitle
La chaîne à utiliser comme titre de la boîte de dialogue. La valeur par défaut est Confirm (ou son équivalent localisé).
aButtonFlags
Un ensemble de flags définissant les boutons devant s'afficher dans la boîte de dialogue. La valeur est calculée en multipliant la position correspondante du bouton avec une constante de titre de bouton pour chaque bouton, puis en ajoutant les résultats et toutes autres options (voir Autre constantes).
Constantes de position des boutons
  • BUTTON_POS_0: Le premier bouton logique
  • BUTTON_POS_1: Le deuxième bouton logique
  • BUTTON_POS_2: Le troisième bouton logique
Constantes des titres des boutons
  • BUTTON_TITLE_OK: Un bouton OK
  • BUTTON_TITLE_CANCEL: Un bouton Annuler
  • BUTTON_TITLE_YES: Un bouton Oui
  • BUTTON_TITLE_NO: Un bouton Non
  • BUTTON_TITLE_SAVE: Un bouton Enregistrer
  • BUTTON_TITLE_DONT_SAVE: Un bouton Ne pas enregistrer
  • BUTTON_TITLE_REVERT: Un bouton Précédent
  • BUTTON_TITLE_IS_STRING: Titre personnalisé spécifié par le paramètre correspondant aButtonXTitle
Autres constantes
  • BUTTON_POS_0_DEFAULT: Définit le bouton 0 comme bouton par défaut. Sauf indication contraire, c'est la valeur par défaut.
  • BUTTON_POS_1_DEFAULT: Définit le bouton 1 comme bouton par défaut.
  • BUTTON_POS_2_DEFAULT: Définit le bouton 2 comme bouton par défaut.
  • BUTTON_DELAY_ENABLE: Spécifie que les boutons ne doivent être actifs que passé un certain délai. Ceci ne s'applique qu'aux bouton 0 et 2, mais pas au bouton 1 (le bouton Annuler ).
  • STD_OK_CANCEL_BUTTONS: Utilisez cela plutôt que les constantes ci-dessus pour avoir les boutons standard OK et Annuler . Si vous n'utilisez pas aButtonFlags, c'est l'argument par défaut.
  • STD_YES_NO_BUTTONS: Utilisez cela plutôt que les constantes ci-dessus pour avoir les boutons standard Oui et Non .
Avertissement : Ne faites aucune hypothèse quant au placement des boutons, l'implémentation de base peut librement décider de la place de chacun des trois boutons. Les exemples suivants montrent le résultat de l'appel de la fonction confirm() avec trois boutons 0='A', 1='B' et 2='C'.
Firefox sous Linux
Suite Mozilla sous Win32
Il est donc recommandé de n'utiliser que deux boutons dans la mesure du possible, et de garder à l'esprit que le bouton 1 à la même valeur de retour que « fenêtre fermée » (voir ci-dessous).
aButton0Title
Titre personnalisé pour le bouton 0.
aButton1Title
Titre personnalisé pour le bouton 1.
aButton2Title
Titre personnalisé pour le bouton 2.
aCheckMsg
Une chaîne à afficher comme étiquette d'une case à cocher.
aCheckState
Un objet avec une propriété valeur booléenne représentant l'état de la case à cocher : lorsque la boîte de dialogue s'affiche, sa case à cocher sera cochée lorsque la valeur de cet objet est true. Après la sélection d'un bouton (ou la fermeture de la fenêtre) par l'utilisateur, la propriété est mise à jour selon l'état de la case à cocher.
var check = { value: false };
var button = confirm("Êtes-vous sûr de vouloir installer FooBar 0.1?",
                     "Confirmation",
                     STD_YES_NO_BUTTONS,
                     null,
                     null,
                     null,
                     "Install FluxCompensator 0.4 as well",
                     check);

Retour

La valeur retournée est un entier indiquant quel bouton l'utilisateur a sélectionné :

Valeur Bouton
0 'Annuler' ou bouton 1. Également: l'utilisateur a fermé la fenêtre de dialogue
1 'OK' ou bouton 0
2 Le troisème bouton

Les versions précédentes de l'API XPInstall mentionnaient que la valeur de retour de confirm() était un booléen. C'est incorrect, confirm() retourne toujours un nombre entier (0 ou 1 dans les versions antérieures à pre-Gecko-1.8).

Notes

La meilleure méthode pour détecter le support des boîtes de dialogue personnalisées est de déterminer l'existence des constantes de bouton. Les autres approches (par exemple, comparaison des buildID) ne sont pas recommandées.

if ("BUTTON_POS_0" in Install) {
  // Utilisation de la méthode étendue de confirm()
} else {
  // Utilisation de la méthode classique de confirm()
}

Interwiki Languages Links

Étiquettes et contributeurs liés au document

 Contributeurs à cette page : teoli, Kyodev, Fredchat
 Dernière mise à jour par : teoli,