====== MessageBox [En cours de Traduction Wismerheal][WSL] ======
Cet objet représente une fenêtre affichant un texte à l'utilisateur.
===== Fonctions =====
==== MessageBox ====
Fonction de construction.
=== Syntaxe ===
var myObject = new MessageBox();
var myObject = new MessageBox(parameters);
=== Arguments ===
- parameters - (object) paramètres de la fenêtre
* title - (string) le titre de la fenêtre
* position - ([[en:code:core:point|Point]]) la position de la fenêtre
* opacity - (float) l'opacité de la fenêtre
* enabled - (boolean) le statut d'activité de la fenêtre
* visible - (boolean) le statut de visibilité de la fenêtre
* text - (string) le texte
* detailedText - (string) le détail du texte
* informativeText - (string) le texte d'information (annexe de texte)
* buttons - ([[#standardbutton|StandardButton]]) a flag list of buttons (une liste de boutons)
* icon - ([[#icon|Icon]]) le nombre de décimales
* defaultButton - ([[#standardbutton|StandardButton]]) le bouton sélectionné par défaut.
* escapeButton - ([[#standardbutton|StandardButton]]) le bouton pressé quand on appui sur "échap"
* onClosed - ([[#onclosed|OnClosed]]) évènement appelé quand la fenêtre est fermée
=== Exceptions ===
* (ParameterTypeError) type de paramètre incorrect
* (ParameterCountError) paramètre de compteur incorrect
=== Example ===
var myObject = new MessageBox();
var myObject = new MessageBox({
title: "Press yes or no",
icon: MessageBox.Warning,
buttons: MessageBox.Yes | MessageBox.No
});
===== 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 ===
* (MessageBox) cette "MessageBox" (boite de dialogue)
==== setPosition ====
Définit la position de la fenêtre.
=== Syntaxe ===
myObject.setPosition(point);
=== Arguments ===
- point - ([[en:code:core:point|Point]]) la position de la fenêtre
=== Renvoi ===
* (MessageBox) cette "MessageBox" (boite de dialogue)
==== setOpacity ====
Définit l'opacité de la fenêtre.
=== Syntaxe ===
myObject.setOpacity(opacity);
=== Arguments ===
- opacity - (float) l'opacité de la fenêtre
=== Renvoi ===
* (MessageBox) cette "MessageBox" (boite de dialogue)
==== 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 ===
* (MessageBox) cette "MessageBox" (boite de dialogue)
==== setVisible ====
Définit le statut visible de la fenêtre.
=== Syntaxe ===
myObject.setVisible(visible);
=== Arguments ===
- visible - (boolean) le statut visible de la fenêtre
=== Renvoi ===
* (MessageBox) cette "MessageBox" (boite de dialogue)
==== close ====
Ferme la fenêtre.
=== Syntaxe ===
myObject.close();
=== Renvoi ===
* (MessageBox) cette "MessageBox" (boite de dialogue)
==== 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 ===
* ([[en:code:core:point|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) le statut d'activité de la fenêtre
==== visible ====
Renvoi le statut visibilité de la fenêtre.
=== Syntaxe ===
myObject.visible();
=== Renvoi ===
* (boolean) le statut visibilité de la fenêtre
==== setText ====
Définit le texte.
=== Syntaxe ===
myObject.setText(text);
=== Arguments ===
- text - (string) le texte
=== Renvoi ===
* (MessageBox) cette "MessageBox" (boite de dialogue)
==== setDetailedText ====
Sets the detailed text.
=== Syntaxe ===
myObject.setDetailedText(detailedText);
=== Arguments ===
- detailedText - (string) le détail du texte
=== Renvoi ===
* (MessageBox) cette "MessageBox" (boite de dialogue)
==== setInformativeText ====
Définit le texte d'information(annexé au texte).
=== Syntaxe ===
myObject.setInformativeText(informativeText);
=== Arguments ===
- informativeText - (string) le texte d'information
=== Renvoi ===
* (MessageBox) cette "MessageBox" (boite de dialogue)
==== setButtons ====
Définit le bouton à utiliser.
=== Syntaxe ===
myObject.setButtons(buttons);
=== Arguments ===
- buttons - ([[#standardbutton|StandardButton]]) le bouton à utiliser (flag)
=== Renvoi ===
* (MessageBox) cette "MessageBox" (boite de dialogue)
==== setIcon ====
D2finit l'icône à utiliser.
=== Syntaxe ===
myObject.setIcon(icon);
=== Arguments ===
- buttons - ([[#icon|Icon]]) l'icône à utiliser
=== Renvoi ===
* (MessageBox) cette "MessageBox" (boite de dialogue)
==== setDefaultButton ====
Définit le bouton sélectionné par défaut.
=== Syntaxe ===
myObject.setDefaultButton(button);
=== Arguments ===
- button - ([[#standardbutton|StandardButton]]) le bouton sélectionné par défaut
=== Renvoi ===
* (MessageBox) cette "MessageBox" (boite de dialogue)
==== setEscapeButton ====
Définit le bouton pressé quand on utilise la touche "échap".
=== Syntaxe ===
myObject.setEscapeButton(button);
=== Arguments ===
- button - ([[#standardbutton|StandardButton]]) le bouton pressé quand on utilise la touche "échap"
=== Renvoi ===
* (MessageBox) cette "MessageBox" (boite de dialogue)
==== addCustomButton ====
Ajoute un bouton personnalisé.
=== Syntaxe ===
myObject.addCustomButton(button, text);
=== Arguments ===
- button - ([[#standardbutton|StandardButton]]) le bouton standard correspondant à ce bouton personnalisé t
- text - (string) le texte de ce bouton
=== Renvoi ===
* (MessageBox) cette "MessageBox" (boite de dialogue)
=== Exceptions ===
* (AddCustomButtonError) l'ajout du bouton personnalisé à échoué
==== show ====
Affiche la fenêtre. (non-bloquant)
Utilise l'évènement OnClosed pour savoir quand la fenêtre a été fermé.
=== Syntaxe ===
myObject.show();
=== Renvoi ===
* (MessageBox) cette "MessageBox" (boite de dialogue)
==== showModal ====
Affiche la fenêtre. (bloquant)
=== Syntaxe ===
myObject.showModal();
=== Renvoi ===
* (integer) le résultat de la fenêtre (0 signifie que cela a été annulé)
===== Evènements =====
==== onClosed ====
Appelé quand la fenêtre est fermée.
=== Syntaxe ===
myObject.onClosed = function(result) {};
=== Arguments ===
- result - (integer) le résultat de la fenêtre (0 signifie que cela a été annulé)
=== Example ===
myObject.onClosed = function(result)
{
if(result)
{
//Event action
}
};
===== Attributs =====
==== title ====
Le titre de la fenêtre. (string)
==== position ====
La position de la fenêtre. ([[en:code:core:point|Point]])
==== opacity ====
L'opacité de la fenêtre. (float)
==== enabled ====
Le statut d’activité de la fenêtre. (boolean)
==== visible ====
Le statut de visibilité de la fenêtre. (boolean)
===== Enumerations =====
==== StandardButton ====
A standard button.
=== Valeurs ===
- Ok: un bouton "ok"
- Open: un bouton "open"
- Save: un bouton "save"
- Cancel: un bouton "cancel"
- Close: un bouton "close"
- Discard: un bouton "discard"
- Apply: un bouton "apply"
- Reset: un bouton "reset"
- RestoreDefaults: un bouton "restore defaults"
- Help: un bouton "help"
- SaveAll: un bouton "save all"
- Yes: un bouton "yes"
- YesToAll: un bouton "yes to all"
- No: un bouton "no"
- NoToAll: un bouton "no to all"
- Abort: un bouton "abort"
- Retry: un bouton "retry"
- Ignore: un bouton "ignore"
- NoButton: pas de bouton
=== Notes ===
Ceci est une énumération d'indicateurs, ce la signifie que vous pouvez utiliser de multiples valeurs en usant de l'opérateur | .
Example :
myObject.setButtons(MessageBox.Yes | MessageBox.Save); //Afficher le bouton "yes" et le bouton "save"
==== Icon ====
Un icône.
=== Valeurs ===
- NoIcon: pas d'icône
- Question: un point d'interrogation
- Information: un icône d'information
- Warning: un icône d'avertissement
- Critical: un icône d'erreur