Wikipédia:LiveRC/Documentation/Hooks/AfterCreateParamPanel/fr

1.0.5^m

Documentation

(fr) •(en) •(it)[edit]

Article principal : Wikipédia:LiveRC/Documentation/Extensions/fr.

"AfterCreateParamPanel" est le nom d'un hook inséré dans le code de LiveRC permettant à des fonctions annexes définies par une extension d'être exécutées juste après création du menu de personnalisation et avant création des "onglets".

Utilisation[modifier le code]

Le hook AfterCreateParamPanel est utilisable pour ajouter une page supplémentaire dans le menu de configuration.

Une fonction, LiveRC_ManageParams_CreateNewListMenu(), est dédiée à cet usage. Elle sert à créer un sous-menu supplémentaire dans le menu de configuration. La fonction renvoie le <ul> dans lequel les choses personnalisables peut être listées.

Sa syntaxe est la suivante :

LiveRC_ManageParams_CreateNewListMenu(menuname, buttons, columns)
- menuname
  nom identifiant le menu.
  Deux entrées dans la variable lrcParamDesc se chargeront d'indiquer les textes qui doivent figurer dans le "bouton-onglet" et en titre du sous-menu avec les identifiants suivants (remplacer XXXX par l'identifiant donné ci-dessus) :
  - DescXXXX_short : Texte de l'onglet
  - DescXXXX : Texte décrivant la page
- buttons
  boutons à ajouter au début du sous-menu (pour sauvegarde, fermeture du menu, etc...). Le programme attend ici un objet de type "node". Les boutons standards sont créés et retournés par la fonction LiveRC_ManageParams_CreateActionButtons() (pas de paramètres nécessaires)
- columns
  nombre de colonnes du "ul" qui contient le contenu (à ajouter par la suite)

Ce sous-menu n'est pas pris en compte lors de la sauvegarde dans les autres sous-menus; une fonction spécifique doit être crée pour cela (voir le hook BeforeParamPanelSaved).

Si l'objectif est de ne paramétrer qu'une variable basique de type Object, voir plutôt le hook AfterFillParamPanel.

Syntaxe[modifier le code]

LiveRC_AddHook("AfterCreateParamPanel", function(){
    var Buttons = LiveRC_ManageParams_CreateActionButtons();                            // 1. Création des boutons standards
    var ButtonPlus = document.createElement('input');                                   // 2. Création  
    ButtonPlus.type = "button";                                                         //    et ajout
    ButtonPlus.value = "My button";                                                     //    d'un bouton
    Buttons.appendChild(ButtonPlus);                                                    //    supplémentaire
    var MyNewMenu = LiveRC_ManageParams_CreateNewListMenu("MySpecialMenu", Buttons, 2); // 3. Création de la page
    MyNewMenu.innerHTML = "<li>My Menu Content</li>";                                   // 4. Insertion de contenu dans la page
});

lrcParamDesc["DescMySpecialMenu_short"] = "My new menu";                                // 5. Texte de l'onglet
lrcParamDesc["DescMySpecialMenu"] = "My new menu description";                          // 6. Texte décrivant la page

Exemple[modifier le code]

Extension utilisant ce hook :

it:InserisciTemplate (AddComplexTemplateExtension) ^(doc)