Frame

Description

Élément objet permettant de définir une zone pouvant contenir d'autres éléments objets. En attribuant une bordure et un fond à une Frame, il est ainsi possible de créer une fenêtre d'interface.

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

Propriétés

name

Le nom sous lequel la frame 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 la frame. Si celle-ci est placée 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é la frame. Cela peut être une frame virtuelle précédemment créée, ou l'un des modèles pré-existants :

• UIPanelTitleFrameTemplate : Fenêtre barre de titre.

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", la frame n'apparaîtra pas. Une frame virtuelle 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, la fenêtre sera par défaut invisible. Ceci peut permettre de la faire apparaître uniquement en cliquant sur un bouton.

visible

Si cette propriété prend la valeur false, la fenêtre 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é de la frame. 0 est transparent, 1 opaque. Par défaut, toute frame est opaque (alpha = 1).

toplevel

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

movable

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

resizable

Si cette propriété prend la valeur true, la frame pourra être redimensionnée.

frameStrata

Propriété définissant le niveau où se trouve la frame. 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é à la frame. Ceci sert dans le cas où il y a plusieurs frames similaires.

enableMouse

Si cette propriété prend la valeur true, les clics de l'utilisateur sur la fenêtre 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.

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
• 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

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)

 <Frame name="FrameTest" parent="UIParent" enableMouse="true">
    ...
 </Frame>