Documentation de MTimer.

1 files changed, 56 insertions, 5 deletions

diff --git a/doc/manuel_utilisateur.txt b/doc/manuel_utilisateur.txt
index 419f4b4..6fdb202 100644
--- a/doc/manuel_utilisateur.txt
+++ b/doc/manuel_utilisateur.txt
@@ -1,6 +1,12 @@
 		NOTE : Ce manuel est en cours de rédaction.
 		      Il évolue quotidiennement.
 
+Reste à faire :
+- les widgets
+- les comportements
+- les inclassables
+- l'utilisation de tkZinc
+- reprendre la partie 1 et mettre des exemples
 
 Ce manuel utilisateur a pour objectif de faciliter l'utilisation de MTools.
 
@@ -473,7 +479,7 @@ de l'opacité.
 
 Les fonctions applicables à un objet MOpacity sont :
 	- start : démarre l'animation
-	- stop: arrête l'animation
+	- stop : arrête l'animation
 	- isRunning : détermine si l'animation est en cours
 
 Exemple d'utilisation :
@@ -532,7 +538,7 @@ point du chemin.
 
 Les fonctions applicables à un objet MPath sont :
 	- start : démarre l'animation
-	- stop: arrête l'animation
+	- stop : arrête l'animation
 	- isRunning : détermine si l'animation est en cours
 
 Exemple d'utilisation :
@@ -596,7 +602,7 @@ ANIMATION_ABORD et fournit en plus les coordonnées du centre d'homotétie.
 
 Les fonctions applicables à un objet MScalor sont :
 	- start : démarre l'animation
-	- stop: arrête l'animation
+	- stop : arrête l'animation
 	- isRunning : détermine si l'animation est en cours
 
 Exemple d'utilisation :
@@ -657,7 +663,7 @@ position (x, y). La position est un point du segment.
 
 Les fonctions applicables à un objet MTranslator sont :
 	- start : démarre l'animation
-	- stop: arrête l'animation
+	- stop : arrête l'animation
 	- isRunning : détermine si l'animation est en cours
 
 *** Attention : dans le cas où une cible est de type MMover, le comportement est
@@ -685,7 +691,52 @@ MAntiRecouvrementItem.pm :
 
 
 2.7 Les inclassables
+--------------------
+Les composants de cette catégorie sont dans le répertoire MTools, à l'exception
+de WacomAdapter qui est seul dans son répertoire Adapters.
+__________
+MSwitch.pm :
+
+_________
+MTimer.pm :
+Le composant MTimer permet de déclencher des actions dans un certain temps, de
+manière répétitive ou non.
+
+La création nécessite les arguments suivants :
+ 	- timeout : durée associée au timer en ms
+	- repeat : détermine le caractère répétitif du timer (valeur 0 ou 1)
+	- callback : est optionnel et permet d'appeler une callback au
+	déclenchement du timer
+
+Les évènements émis sont :
+	- TIME_OUT : ce message est émis à chaque déclenchement du timer, avant
+	l'exécution éventuelle d'une callback.
+	- TIMER_STOPPED : est émis lorsque le timer est stoppé.
+
 
-ptkdb, MObjet, MTimer, MState, MSwitch, MIvy, WacomAdapter
+Les valeurs modifiables par mconfigure sont :
+	- timeout : durée associée au timer en ms
+	- repeat : détermine le caractère répétitif du timer (valeur 0 ou 1)
+	- callback : est optionnel et permet d'appeler une callback au
+	- -visible : cette propriété est définie pour assurer la compatibilité
+	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.
+
+
+Les fonctions applicables à un objet MTimer sont :
+	- start : démarre le timer
+	- stop : arrête le timer
+
+Remarque : le timer peut être contrôlé par la propriété -visible au lieu
+d'utiliser start/stop.
+
+*** start et stop ne modifient pas la propriété visible, est-ce normal ?
+*** il n'y a pas de fonction isRunning. Faut-il en ajouter une ?
+
+ptkdb, MState, MIvy, WacomAdapter
 
 2.8 L'utilisation de TkZinc
+---------------------------
+