Button

Description

Élément objet permettant de créer des boutons.

Éléments pouvant contenir des boutons : Ui, Frames.

Propriétés

name

Le nom sous lequel le bouton sera référencée par le jeu. Utiliser la chaine $parent permet de remplacer celle-ci par le nom de l'élément objet parent.

parent

Le nom de l'élément objet contenant le bouton. Si celui-ci est placé directement sur la fenêtre de jeu, donc par exemple la fenêtre de base d'un addon, il faut attribuer la valeur UIParent, qui correspond à la fenêtre de jeu.

inherits

Nom du modèle sur lequel est basé le bouton. Cela peut être un bouton virtuel précédemment créée, ou l'un des modèles pré-existants :

setAllPoints

Définit si l'objet est exactement de la même taille que l'objet parent.

virtual

Si cette propriété prend la valeur "true", le bouton n'apparaîtra pas. Un bouton virtuel peut être créée comme modèle pour pouvoir être réemployée plus loin dans le document.

hidden

Si cette propriété prend la valeur true, le bouton sera par défaut invisible.

visible

Si cette propriété prend la valeur false, le bouton sera invisible. Il s'agit de la propriété opposée à hidden.

alpha

Valeur comprise entre 0 et 1, qui définit le degré d'opacité du bouton. 0 est transparent, 1 opaque. Par défaut, tout bouton est opaque (alpha = 1).

toplevel

Si cette propriété prend la valeur true, le bouton sera au-dessus de tout autre élément.

movable

Si cette propriété prend la valeur true, le bouton pourra être déplacé.

resizable

Si cette propriété prend la valeur true, le bouton pourra être redimensionné.

frameStrata

Propriété définissant le niveau où se trouve le bouton. De plus bas au plus élevé :

• BACKGROUND
• LOW
• MEDIUM
• HIGH
• DIALOG
• TOOLTIP

frameLevel

Une propriété supplémentaire à frameStrata qui permet de donner un ordre entre éléments du même niveau. La valeur par défaut est zéro.

id

Le numéro associé au bouton. Ceci sert dans le cas où il y a plusieurs boutons similaires.

enableMouse

Si cette propriété prend la valeur true, les clics de l'utilisateur sur le bouton pourront être interceptés via les éléments événements. Ceci permet de donner un effet au clic, notamment pour déplacer la fenêtre.

enableKeyboard

Si cette propriété prend la valeur true, les commandes du clavier pourront être interceptés via les éléments événements. Ceci permet de donner un effet aux touches.

text

Le texte affiché sur le bouton.

Méthodes

• ClearAllAnchors : Suppression des points d'ancrage
• GetAlpha : Renvoie l'opacité
• GetAnchor : Renvoie les points d'ancrage
• GetAnchorOffset : Renvoie les décalages par rapport aux ponts d'ancrage
• GetBottom : Renvoie la position du bas
• GetCenter : Renvoie la position du centre
• GetColor : Renvoie la couleur
• GetHeight : Renvoie la hauteur
• GetLeft : Renvoie la position de la gauche
• GetName : Renvoie le nom
• GetParent : Renvoie l'objet parent
• GetPos : Renvoie la position
• GetRealScale : Renvoie l'échelle décimale
• GetRealSize : Renvoie la taille décimale
• GetRight : Renvoie la position de la droite
• GetScale : Renvoie l'échelle
• GetSize : Renvoie la taille
• GetTop : Renvoie la position du haut
• GetWidth : Renvoie la largeur
• Hide : Masque
• IsVisible : Indique si visible ou non
• Moving : Indique si en déplacement ou non
• SetAlpha : Définit l'opacité
• SetAnchor : Définit les points d'ancrage
• SetColor : Définit la couleur
• SetHeight : Définit la hauteur
• SetPos : Définit la position
• SetScale : Définit l'échelle
• SetSize : Définit la taille
• SetWidth : Définit la largeur
• Show : Affiche
• Disable : Désactive
• Enable : Active
• GetID : Renvoie l'ID
• IsEnable : Indique si activée
• Locked : Indique si verrouillée
• RegisterEvent : Enregistrement des événements LUA à intercepter
• RegisterForClicks : Enregistrement des clics à intercepter
• RegisterForDrag : Enregistrer des glisser/déplacer à intercepter
• ResetFrameOrder : Réinitialisation de l'ordre
• SetBackdrop : Définition de la l'arrière-plan
• SetBackdropEdgeAlpha : Définition de l'opacité des bordures de l'arrière-plan
• SetBackdropEdgeColor : Définition de la couleur des bordures de l'arrière-plan
• SetBackdropTileAlpha : Définition de l'opacité de l'arrière-plan
• SetBackdropTileColor : Définition de la couleur de l'arrière-plan
• SetFrameLevel : Définition du niveau de plans
• SetFrameStrata : Définition du plan
• SetID : Définition de l'ID
• SetKeyboardEnable : Active ou désactive l'interception du clavier
• SetLayers : Définit les couches
• SetMouseEnable : Active ou désactive l'interception de la souris
• SetParent : Définit l'objet parent
• SetScripts : Définit les scripts
• StartMoving : Démarre le déplacement
• StartSizing : Démarre le redimensionnement
• StopMovingOrSizing : Arrête tout déplacement ou redimensionnement
• Unlocked : Indique si déverrouillée
• UnregisterEvent : Annule l'enregistrement des événements LUA interceptés

• GetDisabledText : Renvoie la police du texte désactivé
• GetDisabledTexture : Renvoie la texture de l'élément désactivé
• GetHighlightText : Renvoie la police du texte surligné
• GetHighlightTexture : Renvoie la texture de l'élément surligné
• GetNormalText : Renvoie la police du texte normal
• GetNormalTexture : Renvoie la texture de l'élément normal
• GetPushedTexture : Renvoie la texture de l'élément pressé
• GetText : Renvoie le texte
• GetTextHeight : Renvoie la hauteur du texte
• GetTextWidth : Renvoie la largeur du texte
• IsButtonPushed : Indique si le bouton est pressé
• LockHighlight : Verrouille l'état surligné
• LockPushed : Verrouille l'état pressé
• SetDisabledTexture : Définit la texture de l'élément désactivé
• SetHighlightTexture : Définit la texture de l'élément surligné
• SetNormalTexture : Définit la texture de l'élément normal
• SetPushedTexture : Définit la texture de l'élément pressé
• SetText : Définit le texte
• SetTextAnchor : Définit les points d'ancrage du texte
• SetTextColor : Définit la couleur du texte
• UnlockHighlight : Déverrouille l'état surligné
• UnlockPushed : Déverrouillé l'état pressé

Sous-Eléments

• Size : Taille de la frame
• Anchors : Positionnement de la frame
• Backdrop : Définition de l'arrière-plan
• ResizeBounds : Limites de taille
• HitRectInsets : Zones d'interception de clics de la frame
• Layers : Couches de la frame
• Frames : Éléments objets inclus dans la frame
• Scripts : Gestion des événements utilisateurs

Exemple(s)

 <Button name="BoutonModèle" virtual="true" inherits="ItemButtonTemplate">
    ...
 </Button>