L'une des opérations les plus fréquentes que je réalise avec GIMP, est la création d'une boîte contenant un texte pour une page Web ou un logo. Mais vous ne savez jamais bien quel taille donner à l'image au départ. Vous ne savez pas combien d'espace le texte occupera avec la taille de police que vous voulez.

Le Maître en Script-Fu (et l'étudiant), se rend compte rapidement que ce problème peut être aisément résolu et automatisé avec un Script-Fu.

Nous allons donc créer un script, appelé Text Box, qui crée une image dont la taille est parfaitement adaptée au texte que saisit l'utilisateur. Nous permettront aussi à l'utilisateur de choisir la police de caractères, sa taille, et la couleur du texte.

Jusqu'à présent, nous avons travaillé avec la Console de Script-Fu. Mais nous allons maintenant à l'édition de fichiers textes de script.

Là où vous stockez vos scripts est affaire de préférence -- si vous avez accès au répertoire de scripts par défaut de GIMP, vous pouvez y placer vos scripts. Néanmoins, je préfère avoir mes scripts dans mon propre répertoire de scripts, bien séparés des scripts installés par GIMP au départ.

Dans le répertoire .gimp-2.2 que GIMP a créé dans votre répertoire personnel, vous devriez trouver un répertoire nommé scripts. GIMP recherchera systématiquement un répertoire pour les scripts dans votre répertoire .gimp-2.2, et ajoutera les scripts de ce répertoire dans la base des Script-Fu. C'est donc là que vous devriez placer vos scripts personnels.

Tout script de Script-Fu définit au moins une fonction, qui est la fonction principale du script. C'est là que vous travaillerez.

Tout script doit également être connu de la base de données de procédures (PDB), de façon à ce que GIMP puisse y accéder.

Nous allons définir la fonction principale en premier :

        (define (script-fu-text-box inText inFont inFontSize inTextColor))
      

Nous definissons ici une fonction appelée script-fu-text-box avec quatre paramètres qui correspondront plus tard à un texte, une police, la taille de la police et la couleur du texte. La fonction est actuellement vide et ne fait rien. Jusqu'ici ça va -- rien de neuf, rien de spécial.

Les conventions de dénomination de Scheme préfèrent les lettres minuscules avec traits d'union, ce que j'ai respecté dans la dénomination de la fonction. Toutefois, je me suis écarté de la convention en ce qui concerne les paramètres. Je préfère en effet les noms descriptifs pour mes paramètres et variables, c'est pourquoi j'ai ajouté le préfixe « in » aux paramètres, de façon à voir d'emblée qu'il s'agit de paramètres reçus par la fonction et non pas de paramètres émis par elle. Et j'utilise le prefixe « the » pour les variables définies au sein du script.

C'est une convention GIMP de nommer vos fonctions de script script-fu-..., parce qu'ainsi elle apparaîtront avec les script-fu quand elles seront listées dans la base de procédures. Cela permet aussi de les distinguer des greffons.

Maintenant, faisons connaître la fonction à GIMP. On réalise cela en appelant la fonction script-fu-register. Quand GIMP lira le script, il exécutera cette fonction qui enregistrera le script dans la base de procédures. Vous pouvez placer cette fonction où vous voulez dans votre script, mais personnellement je la mets à la fin, après tout le reste de mon code.

Voici le listing pour enregistrer cette fonction (j'expliquerai ses paramètres dans un instant) :

        (script-fu-register
          "script-fu-text-box"                        ;func name
          "Text Box"                                  ;menu label
          "Creates a simple text box, sized to fit\
            around the user's choice of text,\
            font, font size, and color."              ;description
          "Michael Terry"                             ;author
          "copyright 1997, Michael Terry"             ;copyright notice
          "October 27, 1997"                          ;date created
          ""                     ;image type that the script works on
          SF-STRING      "Text:"         "Text Box"   ;a string variable
          SF-FONT        "Font:"         "Charter"    ;a font variable
          SF-ADJUSTMENT  "Font size"     '(50 1 1000 1 10 0 1)
                                                      ;a spin-button
          SF-COLOR       "Color:"        '(0 0 0)     ;color variable
        )
        (script-fu-menu-register "script-fu-text-box" "<Toolbox>/Xtns/Script-Fu/Text")
      

Enregistrez ces fonctions dans un fichier texte avec le suffixe .scm dans votre répertoire de scripts, et choisissez Exts → Script-Fu → Rafraîchir les Scripts, et ce nouveau script apparaîtra comme Xtns → Script-Fu → Text → Text Box.

Si vous lancez ce nouveau script, il ne fera rien bien sûr, mais vous pourrez voir les invites que vous avez créées quand vous avez enregistré le script (ça sera plus clair plus loin).

Finalement,si vous invoquez le Navigateur de Procédures ( Exts → Navigateur de Procédures), vous verrez que votre script apparaît maintenant dans la base de procédures.

Pour enregistrer notre script dans GIMP, nous appelons la fonction script-fu-register, remplissons les sept paramètres requis et nous ajoutons nos propres paramètres de script, ainsi qu'une description et une valeur par défaut pour chaque paramètre.

Maintenant que nous avons vu la liste des paramètres requis, nous devons préciser ceux qui correspondent aux besoins de notre script. Nous devons fournir des précisions concernant leur type, pour la fenêtre de dialogue qui apparaît quand l'utilisateur choisit notre script. Nous devons aussi fournir une valeur par défaut.

Cette section du processus d'enregistrement a le format suivant :