Introduction à Perl/Tk

Je l'admets : j'aime les exemples. Ce sont des points de repère où l'on peut revenir lorsque l'on passe aux choses sérieuses. Comme il y a beaucoup de points épineux avec les widgets composites, nous commencerons par des exemples simples et progresserons à partir d'eux.

En consultant le code des widgets composites cités plus haut, on constate que celui du widget LabEntry est le plus court. Voici le contenu de LabEntry.pm(37) :

# Copyright (c) 1995-1997 Nick Ing-Simmons. Tous droits réservés.
# Ce programme est un logiciel libre ; vous pouvez le redistribuer
# et/ou le modifier selon les mêmes conditions que Perl lui-même.
# Classe LabeledEntry (zone de saisie étiquetée)
package Tk::LabEntry;
require Tk::Frame;
@ISA = qw(Tk::Frame);
Construct Tk::Widget 'LabEntry';

sub Populate {
    require Tk::Entry;

    # Constructeur d'un LabeledEntry (zone de saisie étiquetée)
    #
    my ( $cw, $args ) = @_;
    $cw->SUPER::Populate($args);

    # Advertised subwidgets: entry.
    my $e = $cw->Entry();
    $e->pack( -expand => 1, -fill => 'both' );
    $cw->Advertise( 'entry' => $e );
    $cw->ConfigSpecs( DEFAULT => [$e] );
    $cw->Delegates( DEFAULT => $e );
    $cw->AddScrollbars($e) if ( exists $args->{-scrollbars} );
}
1;

Il s'agit du code commenté et complet. La ligne @ISA = qw(Tk::Frame) indique qu'il s'agit d'un widget composite construit autour d'un cadre. Nous pouvons nous reporter à Programming Perl (O'Reilly, 1997)(38) pour savoir à quoi sert le tableau @ISA : « À l'intérieur de chaque package, un tableau spécial appelé @ISA indique à Perl où chercher une méthode s'il ne parvient pas à la trouver dans ce package. » On trouve, par la suite, de nombreux détails sur cette implantation de l'héritage, mais je ne voudrais pas abuser des mots qu'il emploie, uniquement pour expliquer un concept simple : pour que votre widget composite fonctionne, il faut insérer cette ligne dans votre code(39). Toutes les autres explications vont trop dans les détails(40).

L'étape suivante consiste à comprendre comment intervient le widget de saisie. On sait qu'il est créé, car lorsque l'on utilise une zone de saisie étiquetée, on constate qu'elle contient une zone de saisie. On remarquera que le fichier ne contient qu'une fonction, nommée Populate. Elle n'est jamais appelée directement, mais elle l'est. Les paramètres de cette fonction sont deux scalaires : une référence au cadre lui-même et une référence à un hachage contenant tous les couples de paramètres utilisés pour créer le widget. Voici un exemple de création d'un widget LabEntry :

$saisie_etiquettee = $mw->LabEntry(
    -textvariable => \$texte,
    -label        => "Entrez votre nom :",
    -labelPack    => [ -side => 'left' ]
)->pack();

Si vous examinez le code de LabEntry.pm, vous saurez qu'il crée une zone de saisie grâce à la ligne my $e = $cw->Entry(). Viennent ensuite plusieurs opérations lancées par Advertising, ConfigSpecs et Delegates. Pour l'instant, il nous suffit de dire que ces fonctions permettent à la zone de saisie de se comporter comme on le souhaite.

L'étiquette de la zone de saisie étiquetée est automatiquement créée, car on utilise l'option -label lors de sa création. Si l'on se souvient du chapitre 12, Cadres, on sait que l'utilisation de cette option avec un cadre crée automatiquement une étiquette. Ce qui rend ce widget composite simple est qu'il utilise l'étiquette déjà comprise dans un widget cadre.

Lorsque l'on construit ses propres widgets composites, on crée un fichier portant le même nom (à la casse près) que le widget et terminé par .pm. Si, par exemple, on créait un nouveau widget composite nommé BoutonListe, son code serait placé dans un fichier BoutonListe.pm.

Si les fichiers des widgets composites sont placés dans le même répertoire que ceux

de l'application, il suffit d'ajouter la ligne use BoutonListe après la ligne use Tk commençant le code utilisant le nouveau widget. Si les fichiers des widgets sont placés ailleurs, il faut ajouter la ligne suivante, avant toute instruction use ou require :

use lib ("repertoire_1", "repertoire_2");

afin d'indiquer les répertoires utilisés pour BoutonListe.pm.

La création d'un widget composite utilisant un cadre est légèrement différente de celle d'un widget utilisant un widget de premier niveau. Je donnerai un bref exemple pour chacun d'eux afin que vous puissiez vous rendre compte de ce que vous pouvez faire.

Si vous comptez créer un widget composite nommé MonWidget, les lignes suivantes doivent absolument être placées au début du code de celui-ci :

package MonWidget; 
require Tk::Frame; 
@ISA = qw(Tk::Frame);
 
Construct Tk::Widget 'MonWidget'; 

sub Populate 
{ 
    ... 
}

Il faut déclarer le nouveau widget comme étant son propre paquetage, d'où la ligne package MonWidget (si vos widgets se trouvent dans un sous-répertoire, utilisez SousRep::MonWidget). Les deux lignes suivantes sont faciles à comprendre : require Tk::Frame assure que l'on a chargé les informations nécessaires à la manipulation d'un cadre, et @ISA = qw(Tk::Frame) ajoute le widget Tk::Frame au tableau @ISA. La ligne qui suit appelle la méthode Construct de Tk::Widget (nous aurions également pu écrire Tk::Widget-> Construct("MonWidget")) en lui passant le nom de notre widget. Dans cet appel, on n'ajoute pas le nom du répertoire où se trouve le widget.

L'appel à Construct crée un constructeur pour le nouveau widget ; cela vous permettra de créer un nouveau MonWidget en appelant la méthode MonWidget :

$nouveau_widget = $mw->MonWidget(…);

Lorsque l'on crée un widget composite à partir d'un cadre, il faut utiliser la fonction Populate pour créer les sous-widgets et réaliser les autres configurations nécessaires.

XV-C-1. Populate détaillé ▲

my ($widget_comp, $params) = @_;

$valeur_option = delete $params->"-option" ; 
if (defined $valeur_option) { 
  ...
}

$nom_fic = delete $params->{"-filename"}; 
if (defined $nom_fic) { 
    # Ouvrir le fichier... 
}

$widget_comp->SUPER::Populate($params);

XV-C-2. Appel de Advertise ▲

$saisie_etiquette = $mw->LabEntry(
    -textvariable => \$texte,
    -label        => "Entrez votre nom :",
    -labelPack    => [ -side => 'left' ]
)->pack();
$saisie      = $saisie_etiquette->Subwidget("entry");
$texte_saisi = $saisie->get();

$cw->Advertise('entry' => $saisie); 
$cw->Advertise('button' => $bouton);

XV-C-3. Appel de Delegates ▲

$cw->Delegates(DEFAULT => $saisie);

$cw->Delegates(
    'insert' => $liste_defil, 
    'delete => $liste_defil,
    DEFAULT => $saisie
);

XV-C-4. Appel de ConfigSpecs▲

$cw->ConfigSpecs(DEFAULT => [$saisie]);

$cw->ConfigSpecs('-file' => '-filename');

$cw->ConfigSpecs(-nouvelle_option => [ <action>,
                                       "nouvelle_Option",
                                       "Nouvelle_Option",
                                       <valeur_defaut> ]);

$w->ConfigSpecs(
-listwidth  => [qw/PASSIVE listWidth ListWidth/, undef],
-listcmd    => [qw/CALLBACK listCmd ListCmd/, undef],
-browsecmd  => [qw/CALLBACK browseCmd BrowseCmd/, undef],
-choices    => [qw/METHOD choices Choices/, undef],
-state      => [qw/METHOD state State normal/],
-arrowimage => [{-image => $b}, qw/arrowImage ArrowImage/, undef],
-variable   => "-textvariable",
DEFAULT     => [$e] );

XV-C-5. Résumé sur les widgets construits à partir d'un cadre▲

$package NouveauWidget;
@ISA = qw(Tk::Frame);

Tk::Widget->Construct('NouveauWidget');

sub Populate()
{
    my ($cw, $params) = @_;
    
    # Ne traite que les options de création seulement
    my $valeur = delete $params->{-option};
    if (defined $valeur) {
        …
    }

    # Création de tous les sous-widgets souhaités…
    $widget = $cw->Widget(…);

    $cw->Delegates();
    $cw->ConfigSpecs( … );
}

sub mon_option {
    …
}

1;

Il n'existe qu'une seule petite différence entre un widget composite construit à partir d'un cadre et un construit à partir d'un widget de premier niveau. Si l'on souhaite utiliser la méthode new pour créer la fenêtre, il faut définir InitObject au lieu de Populate. Cependant, la plupart des widgets composites fournis avec la distribution de Tk ne le font pas. Examinez les fichiers ColorEditor.pm et DialogBox.pm pour avoir des exemples de création de tels widgets composites. Toutes les règles d'utilisation de ConfigSpecs restent identiques.