YAD

Traduction de la description sur le site officiel de Yad. 1)

Yad (encore une boîte de dialogue) est un outil pour créer des boîtes de dialogue graphiques à partir de scripts shell.

Yad est un fork de Zenity

Yad a été écrit par Victor Ananjevsky.

L'icone Yad a été créé par Bogdan Lisovich.

Version des dépôts

YAD est dans les dépôts à partir d'Ubuntu 16.04. Pour installer ce logiciel, il suffit d'installer les paquets yad. Pour les versions d'Ubuntu antérieur à 16.04, tel que 14.04, vous pouvez installer YAD avec le PPA (voir ci-dessous).

Avec un ppa

Pour installer une version récente de YAD, ou si vous avez une version Ubuntu antérieur à 16.04, alors vous pouvez installer YAD avec le PPA de webupd8, en une ligne :

sudo add-apt-repository ppa:nilarimogard/webupd8 -y && sudo apt update && sudo apt install yad -y

Par compilation

Yad évolue très vite, il peut être utile de compiler la dernière version.

Pour satisfaire les dépendances, installez Yad par APT puis si vous voulez la dernière version, compilez-la comme suit.

Vous devrez peut-être installer gcc, libwebkitgtk-dev

Pour avoir la dernière version, télécharger l'archive sur la page officielle de Yad Décompressez-la ou vous voulez. Ouvrez un terminal

cd /chemin/vers/le/dossier/décompressé
./configure
make
sudo make install
L'auteur fourni une petite application qui permet de lister les icones pouvant être utilisées. Il vous faut également activer le widget –html. Procèder comme suit pour les installer.
cd /chemin/vers/le/dossier/décompressé
./configure --enable-icon-browser --enable-html 
make
sudo make install

A complèter

Types de fenêtres

Yad permet d'afficher plusieurs types de fenêtre :

Type de fenêtre Argument Description
Sélection --calendar Affiche un calendrier
Sélection --color Affiche un sélecteur de couleur
Sélection --file Affiche un sélecteur de fichiers/dossiers
Sélection --font Affiche un sélecteur de police
Selection --print Affiche une boîte d'impression
Entrée --dnd Affiche une boîte de glisser/déposer
Entrée --entry Affiche une boîte de saisie
Entrée --scale Affiche un bouton glissant
Affichage Affiche une boîte de dialogue (Peut être utilisé pour des informations ou des erreurs.).
Affichage --icons Pas encore testé
Affichage --html Affiche un navigateur
Affichage --list Affiche une liste
Affichage --multi-progress Affiche plusieurs barres de progresion
Affichage --notification Affiche une icone dans la zone de notification
Affichage --progress Affiche une barre de progression
Affichage --text-info Affiche le contenu d'un fichier texte
Affichage --picture Un simple visionneur d'images
Multiples --form Affiche une multitude de boîte
Multiples --notebook Affiche une boîte avec des onglets
Multiple --paned Affiche une boîte en deux parties

Pour plus d'infos, consulter les pages du manuel de Yad.

Types de champs de la fenêtre form (formulaire)

Les formulaires permettent de décliner les différentes options de yad dans la même fenêtre. Les types de champs de formulaire sont saisis sous la forme –field=LABEL[:TYPE] Les types de champs sont les suivants : H, RO, NUM, CHK, CB, CBE, CE, FL, SFL, DIR, CDIR, FN, MFL, MDIR, DT, SCL, CLR, BTN, FBTN, LBL, TXT. ||

Type de champ Utilisation
Les entrée de formulaire non typées sont traitées comme des entrées texte simple (Type CE).
BTN Champ bouton libre. L’étiquette du bouton est un texte saisi selon la convent d’écriture suivante : Etiquette[!Icone[!Infobulle]]. Le séparateur est le caractère !. (point d’exclamation). L’étiquette est un texte ou un identifiant gtk. Icône est un fichier icône (identifiant ou nom de fichier). L’infobulle est un paramètre optionnel correspondant à une fenêtre surgissante d’aide qui apparaît au survol du bouton. Il est possible d’affecter une commande au bouton. Dans ce cas, le symbole spécial%N d’une commande est remplacé par la valeur du champ N. Si la commande débute par le caractère @ (arobase), la sortie de la commande sera parsé et les lignes qui débutent par des nombres et des colonnes seront traitées comme les valeurs de nouveaux champs.
CB Boîte déroulante. Les valeurs possibles sont saisies sous la forme VAL1!VAL2 !… Le séparateur est identique au séparateur des champs numériques. La valeur précédée du caractère ∧ correspond à la valeur par défaut.
CBE Boîte déroulante éditable. Valeurs initiales saisies selon les mêmes règles que pour la boîte déroulante standard. D'autres valeurs que les valeurs proposées peuvent être saisies.
CDIR Bouton de sélection ou de création de répertoire.
CE Texte libre. Correspond au type de champ par défaut.
CHK Case à cocher. La valeur initiale est une constante insensible à la casse (TRUE ou FALSE)
CLR Boîte de sélection de couleur. La valeur par défaut de la couleur peut être saisie au format hexadécimal (#FF0000 par exemple). La boîte de dialogue est moins sophistiquée que le champ yad –color qui affiche une roue des couleurs et des champs de saisie numérique.
DIR Bouton de sélection de répertoire dans l’arborescence. Ne permet pas la saise d’un nom de répertoire qui ne figure pas dans l’arborescence (voir option CDIR).
DT Champ date.
FBTN Identique au champ BTN, le bouton étant en relief.
FL Bouton de sélection de fichier dans l’arborescence. Ne permet pas la saise d’un nom de fichier qui ne figure pas dans l’arborescence (voir option SFL).
FN Boîte de sélection de police de caractère. Les polices de caractère sont saisies sous la forme Famille Style Taille (exemple : Sans Bold 13). La boîte de dialogue est moins sophistiquée que le champ yad –font.
H Champ caché. Tous les caractères saisis apparaissent sous la forme d’un caractère invisible (souvent un point). Permet la saisie discrète d’un mot de passe.
LBL Étiquette. Si le nom du champ est vide, un séparateur linéaire horizontal apparaîtra dans le formulaire.
MDIR Bouton de sélection de plusieurs répertoires dans l’arborescence. Les noms de répertoires apparaîtront séparés par des virgules. Ne permet pas la saisie d’un nom de répertoires qui ne figure pas dans l’arborescence.
MFL Bouton de sélection de plusieurs fichiers dans l’arborescence. Les noms de fichiers apparaîtront séparés par des virgules. Ne permet pas la saisie d’un nom de fichier qui ne figure pas dans l’arborescence.
NUM Valeur numérique. Formatage possible : Valeur[!Echelle[!Pas[!Précision]]]. L’échelle des valeurs se présente sous la forme Min..Max. La précision cocnerne les décimales.
RO Champ en mode lecture seule.
SCL Échelle (réglette). Valeur comprise entre 0 et 100.
SFL Bouton de sélection ou de création de fichier.
TXT Entrée texte multiligne. Occupe l’ensemble de la surface du formulaire.

--calendar

Dans cet exemple le calendrier s'ouvrira à la date du jour et la sortie sera de format sam./27/juil./2019/

–title="Titre de la fenêtre": Indique le titre de votre fenêtre.

–window-icon="yad": Affiche une icone dans la barre du titre (Selon votre thème.) et sur le bouton de la liste des fenêtres.

jour=$(date +%d)
mois=$(date +%m)
annee=$(date +%Y)
yad --calendar --day="$jour" --month="$mois" --year="$annee" --date-format=%a/%d/%b/%Y/ --title="Titre de la fenêtre" --window-icon="yad"

--dnd

#!/bin/bash
yad --dnd \
--title="dnd dialog box" \
--window-icon="gtk-dnd-multiple" \
--width="200" --height="200" \
--center --on-top \
--undecorated \
--text="<span font_desc='Sans Bold Italic 13' foreground='#08fc00'>Glisser\nune\nimage.</span>" \
--text-align="center" --command="xdg-open"

--entry

Une boîte de recherche sur les pages en français de Google

#!/bin/bash
recherche=$(yad --entry --title='Recherche web' --text='Tapez votre recherche' --text-align="center" --no-escape --mouse --undecorated --skip-taskbar --on-top)
recherche=$(echo "$recherche" | sed 's/ /+/g')
xdg-open https://www.google.fr/search?q="$recherche"\&site=webhp\&source=lnt\&tbs=lr:lang_1fr\&lr=lang_fr

--form

C'est ici que Yad devient intêressant car il permet de cumuler plusieurs types de boîtes dans une seule fenêtre.

Deux exemples récapitulatifs :

retour=$(yad --form --field="BTN":BTN  --field="CB":CB  --field="CBE":CBE  --field="CDIR":CDIR  --field="CE":CE  --field="CHK":CHK  --field="CLR":CLR  --field="DIR":DIR  --field="DT":DT  --field="FBTN":FBTN  --field="FL":FL  --field="FN":FN  --field="H":H "gtk-cancel:1" "Valeur 1\!Valeur 2\!^Valeur 3\!Valeur 4" "Valeur 1\!Valeur 2\!Valeur 3\!Valeur 4" "/home/user/Documents/" "Texte libre." "TRUE" "#FA892F" "/home/user/Documents/" "12/11/2018" "Firefox" "/home/user/Documents/fichier.txt" "Sans Bold 12" "motdepasse")
echo "$retour"

et (un seul formulaireavec toutes les options risque de dépasser les dimensions de votre écrann) :

retour=$(yad --form  --field="LBL":LBL  --field=:LBL  --field="MDIR":MDIR  --field="MFL":MFL  --field="NUM":NUM  --field="RO":RO  --field="SCL":SCL  --field="SFL":SFL  --field="TXT":TXT  --field="Champ dépourvu d'option : '" "Une étiquette" "" "/home/user/Documents/,/home/user/Musique" "/home/user/Documents/fichierun.txt,/home/user/Documents/fichierdeux.txt" "10.00\!0..1000\!0.05\!2" "Lecture seule" "27" "/home/user/NouveauFichier.txt" "Texte multiligne" "Valeur par défaut : texte simple")
echo "$retour"

Si l'on reprend l'exemple précédent vous pouvez entrer votre recherche et choisir le moteur le plus approprié :

#!/bin/bash
search=$(yad --title='Recherche web' --text='Tapez votre recherche' --text-align="center" --no-escape --mouse --undecorated --skip-taskbar --on-top \
--form \
--field="recherche:" '' \
--field="Moteur:CB" 'Forum ubuntu!^Google fr')
rech=$(echo $search | awk 'BEGIN {FS="|" } { print $1 }')
moteur=$(echo $search | awk 'BEGIN {FS="|" } { print $2 }')
if [ "$moteur" = "Forum ubuntu" ]
then
rech=$(echo "$rech" | sed 's/^/+/;s/ /+/g')
xdg-open https://www.google.fr/search?q=site:forum.ubuntu-fr.org"$rech"
elif  [ "$moteur" = "Google fr" ]
then
rech=$(echo "$rech" | sed 's/^/+/;s/ /+/g')
xdg-open https://www.google.fr/search?q="$rech"\&lr=lang_fr
fi

--notification

Affiche une icône dans la zone de notification du panel (le systray).

Un exemple concret tout simple, qui affiche une icône et quitte lorsqu'on clic gauche dessus :

yad --notification

On peux changer l'icone avec le paramètre –image

yad --notification --image="gtk-help"
yad --notification --image="system-software-update"

La liste des noms d'icones standard sont là : LIEN

Quelques exemples du site officiel : LIEN

Reprenons l'exemple d'avant et mettons-le dans une icone.

#!/bin/bash
#####Commande qui permet de montrer/cacher la fenêtre
function _commande ()
{
commande=$(ps -ef | grep "yad --title=Recherche web --text=Tapez votre recherche" | sed 's/^.*grep.*$//' | sed -n "1p" | awk 'BEGIN { FS=" " } { print $2 }')
if [ -n "$commande" ]
then
kill -9 "$commande"
else
_recherche
fi
}
export -f _commande
#####Recherche internet
function _recherche ()
{
search=$(yad --title='Recherche web' --text='Tapez votre recherche' --text-align="center" --no-escape --mouse --undecorated --skip-taskbar --on-top \
--form \
--field="recherche:" '' \
--field="Moteur:CB" 'Forum ubuntu!^Google fr')
rech=$(echo $search | awk 'BEGIN {FS="|" } { print $1 }')
moteur=$(echo $search | awk 'BEGIN {FS="|" } { print $2 }')
if [ "$moteur" = "Forum ubuntu" ]
then
rech=$(echo "$rech" | sed 's/^/+/;s/ /+/g')
xdg-open https://www.google.fr/search?q=site:forum.ubuntu-fr.org"$rech"
elif  [ "$moteur" = "Google fr" ]
then
rech=$(echo "$rech" | sed 's/^/+/;s/ /+/g')
xdg-open https://www.google.fr/search?q="$rech"\&lr=lang_fr
fi
}
export -f _recherche
#####lancement
yad --notification --no-middle --title="Recherche internet" --command="bash -c _commande" --text="Recherche internet" --image="search" --menu='Quitter!quit!exit'

--notebook

Une boite à onglets.

#!/bin/bash
#####ID --KEY Création aléatoire de l'id 
id=$(echo $[($RANDOM % ($[10000 - 32000] + 1)) + 10000] )
##########Onglet 1##########
#####Avec une colonne#######
yad --plug="$id" --tabnum=1 --form --columns="1" --item-separator='!' --focus-field="1" --dialog-sep --align="center" \
--field="Fichier d'entrée:FL" "$HOME" \
--field=":LBL" "" \
--field="Fichier de sortie:SFL" "" \
&> /tmp/data1 &
##########Onglet 2##########
#####Avec 3 colonnes########
yad --plug="$id" --tabnum=2 --form --columns="3" --item-separator='!' --focus-field="2" --dialog-sep --align="center" \
--field="<span weight='Bold' foreground='black'>Du texte.</span>:LBL" "" \
--field="motif:" "" \
--field="bouton avec relief:FBTN" '' \
--field="Bouton sans relief:BTN" '' \
--field="bouton avec relief:FBTN" '' \
--field="Bouton sans relief:BTN" '' \
&> /tmp/data2 &
yad --notebook --width="900" --height="700" --center --title="yad notebook" --window-icon="gnome-util" --key="$id" \
--tab="onglet 1" --tab="Onglet 2" \
--button="gtk-cancel:1" \
--button="gtk-ok:0"
fermernotebook=$?
if [ $fermernotebook -eq 252 ]
then
exit
elif [ $fermernotebook -eq 1 ]
then
exit
fi

États de sorties

0 L'utilisateur a appuyé sur le bouton OK

1 L'utilisateur a appuyé sur le bouton Annuler

70 La boîte de dialogue a été fermée parce que le délai d'attente a été atteint. (Dans le cas d'un timeout)

252 La boîte de dialogue a été fermé en appuyant sur la touche Echap ou en cliquant sur le bouton de fermeture de la barre du titre de la boîte de dialogue

Les codes de sortie pour les boutons créés par l'utilisateur doivent être spécifiés dans la ligne de commande. Le code de sortie spécifié sera imprimé comme résultat .

Test sur les boutons

#!/bin/bash

yad  --title="Tests sur les boutons." --window-icon="yad" --width="200" --height="200" --center --text="<span font_desc='Ubuntu Mono Bold Italic 12' foreground='#14006c'>Cliquez sur le bouton\nValider.</span>" --text-align="center"
echo "$?"

yad  --title="Tests sur les boutons." --window-icon="yad" --width="200" --height="200" --center --text="<span font_desc='Ubuntu Mono Bold Italic 12' foreground='#14006c'>Cliquez sur le bouton\nAnnuler.</span>" --text-align="center"
echo "$?"

yad  --title="Tests sur les boutons." --window-icon="yad" --width="200" --height="200" --center --text="<span font_desc='Ubuntu Mono Bold Italic 12' foreground='#14006c'>Appuyez sur la touche\nEchap.</span>" --text-align="center"
echo "$?"

yad  --title="Tests sur les boutons." --window-icon="yad" --width="200" --height="200" --center --text="<span font_desc='Ubuntu Mono Bold Italic 12' foreground='#14006c'>Cliquer sur le bouton de\nfermeture de la barre du titre.</span>" --text-align="center"
echo "$?"

yad  --title="Tests sur les boutons." --window-icon="yad" --width="200" --height="200" --center --text="<span font_desc='Ubuntu Mono Bold Italic 12' foreground='#14006c'>Tests sur les\nboutons standard.</span><span font_desc='Ubuntu Mono Bold Italic 15' foreground='#000000'>\n\nTimeout\n\n</span>" --text-align="center" --timeout="5" --timeout-indicator=top --undecorated --no-buttons
echo "$?"

Comme vous le constaté la fenêtre se ferme mais le script continu.

Personnellement lorsque je clique sur le bouton de fermeture, le bouton Annuler ou la touche Echap je veux arrêter le script.

Pour ce faire nous allons utiliser la variable bash $? qui contient le code de retour de la dernière opération.

Je me sert de la structure case mais Il existe d'autre méthodes.

#!/bin/bash

yad  --title="Tests sur les boutons." --window-icon="yad" --width="200" --height="200" --center --text="<span font_desc='Ubuntu Mono Bold Italic 12' foreground='#14006c'>Cliquez sur le bouton\nValider.</span>" --text-align="center"
case $? in
    1)
    exit;;
    70)
    exit;;
    252)
    exit;;
esac

yad  --title="Tests sur les boutons." --window-icon="yad" --width="200" --height="200" --center --text="<span font_desc='Ubuntu Mono Bold Italic 12' foreground='#14006c'>Cliquez sur le bouton\nAnnuler.</span>" --text-align="center"
echo "$?"

Les boutons.

Comportements

Il y-a deux types de comportements:

Si la sortie est numérique, la fenêtre se ferme.

Si la sortie est non numérique, la fenêtre reste ouverte.

yad --width="300" --height="300" --text='Boutons standards:\nla sortie sera 0, 1, 70 ou 252'
yad --width="300" --height="300" --text="Bouton personnalisé:\nLa fenêtre s'est fermée car la sortie est numérique.\n Le bouton ci-dessous ne fermera pas la fenêtre\ncar la sortie n'est pas numérique mais le bouton de fermeture de la fenêtre et la touche d'échappement fermeront la fenêtre car les sorties sont numériques." --button='add:echo "La fenêtre reste ouverte."'

Décorations

Pour personnaliser les boutons vous pouvez:

Utiliser ceux prédéfinis gtk-stock (ex: gtk-close ou gtk-ok).

Définir vos propres options sous la forme LABEL[!ICON[!TOOLTIP]] où LABEL est le texte du bouton, ICON est l'icone du bouton et TOOLTIP est le texte qui s'affichera au survol du bouton (Le séparateur par défaut est "!".

yad --width="300" --height="300" --text="Bouton personnalisé avec gtk-add." --button='gtk-add:0"'
yad --width="300" --height="300" --text="Bouton personnalisé avec LABEL[!ICON[!TOOLTIP]]." --button='Mon bouton!search!Ceci est mon bouton personnalisé:0"'

L'icone peut-être définie par son chemin complet ou par une icone système (Dans mon exemple "search".).

Récupérer les sorties dans les boîtes multiples.

Dans les boîtes multiples la sortie standard sera de type champ1|champ2|champ3| où "|" est le séparateur par défaut. Pour récupérer les champs il est donc pratique d'utiliser awk et les variables.

#Envoi de la sortie dans une variable.
champs=$(yad --title="Mon titre" --text="Mon texte." --text-align="center" \
--form \
--field="champ 1:" '' \
--field="champ 2:" '' \
--field="champ 3:" '')
echo "$champs"
#Récupération des champs avec awk.
champ1=$(echo $champs | awk 'BEGIN {FS="|" } { print $1 }')
champ2=$(echo $champs | awk 'BEGIN {FS="|" } { print $2 }')
champ3=$(echo $champs | awk 'BEGIN {FS="|" } { print $3 }')
#Affichage des champs.
echo "$champ1"
echo "$champ2"
echo "$champ3"

Gestion d'erreur : Gtk-Message

L'utilisation de fenêtres gtk génère l'affichage d'un message d'erreur dans la console.

usr@pc:~/Rep$ Gtk-Message: GtkDialog mapped without a transient parent. This is discouraged.

Ce message est bien connu et ne correspond pas à une erreur grave. Pour s'en débarrasser, il est conseillé de rediriger les erreurs vers /dev/null.

usr@pc:~/Rep$  yad --title "Exemple simple"  2>/dev/null

Pour supprimer cette application, il suffit de supprimer son paquet. Selon la méthode choisie, la configuration globale de l'application est conservée ou supprimée. Les journaux du système, et les fichiers de préférence des utilisateurs dans leurs dossiers personnels sont toujours conservés.


1)
YAD (yet another dialog) is a tool for create graphical dialogs from shell scripts
  • yad_yet_another_dialog.txt
  • Dernière modification: Le 27/05/2018, 23:42
  • par zococo