From 805f3d3e157155761b89dad0545c37bf5a14b4c7 Mon Sep 17 00:00:00 2001
From: ribet
Date: Tue, 5 Jun 2007 16:14:30 +0000
Subject: Documentation de MSwitch.

---
 doc/manuel_utilisateur.txt | 36 +++++++++++++++++++++++++++++++++++-
 1 file changed, 35 insertions(+), 1 deletion(-)

(limited to 'doc/manuel_utilisateur.txt')

diff --git a/doc/manuel_utilisateur.txt b/doc/manuel_utilisateur.txt
index 6f24b6a..ae4a163 100644
--- a/doc/manuel_utilisateur.txt
+++ b/doc/manuel_utilisateur.txt
@@ -696,6 +696,39 @@ Les composants de cette cat
 de WacomAdapter qui est seul dans son répertoire Adapters.
 __________
 MSwitch.pm :
+Un MSwitch est un objet défini par un ensemble d'états. Un seul état est actif à
+la fois, l'objet passe donc d'un état à l'autre.
+
+Les états sont nommés. Chaque état est décrit par l'ensemble des objets qui
+doivent être affichés pour réprésenter cet état. Les composants qui servent à
+décrire un état peuvent être des éléments graphiques, des composants abstraits,
+des comportements, des objets complexes, des animations...
+L'activation/désactivation de chaque composant se fait par modification des
+propriétés visible et sensitive.
+
+Exemple :
+	etat1 => [], # état ne comportant aucun composant
+	etat2 => 'fichier_svg.svg#tag_svg', # dans cet état, un objet issu d'un
+					    svg va être instancié et affiché
+	etat3 => ['fichier_svg.svg#tag_svg', $obj], # dans cet état, deux objets
+				vont être affichés : l'un est instancié par le
+				MSwitch, l'autre a déjà été créé.
+
+*** Je ne sais pas trop dans quel répertoire classer l'objet MSwitch.
+
+La création nécessite les arguments suivants :
+	- parent : parent de l'objet MSwitch
+	- %etats : table de hash définissant les états
+
+Les valeurs modifiables par mconfigure sont :
+	- state : nom de l'état actif du MSwitch
+	- -visible : détermine si l'état courant est actif. Le changement de
+		     valeur permet de rendre visibles ou invisibles les
+		     composants qui constituent l'état actif du switch.
+
+Les fonctions applicables à un objet MOpacity sont :
+	- setState : $switch->setState('etat') équivalent à
+		     $swicth->mconfigure(state=>'etat')
 
 _________
 MTimer.pm :
@@ -722,7 +755,8 @@ Les valeurs modifiables par mconfigure sont :
 	avec les autres objets MTools.
  	Si la valeur est 0 le timer est arrêté (appel de la fonction stop),
 	si la valeur est 1 (appel de la fonction start), le timer est activé.
-	Cette propriété permet notamment d'activer un timer dans un état d'un MSwitch.
+	Cette propriété permet notamment d'activer un timer dans un état d'un
+	MSwitch.
 
 
 Les fonctions applicables à un objet MTimer sont :
-- 
cgit v1.1