EDocumentation en cours...

1 files changed, 62 insertions, 10 deletions

diff --git a/doc/user_manual.txt b/doc/user_manual.txt
index ae89ddc..714dfdd 100644
--- a/doc/user_manual.txt
+++ b/doc/user_manual.txt
@@ -7,8 +7,10 @@ La deuxième partie décrit l'utilisation spécifique de chaque objet.
 
 
 PARTIE 1 : Les fonctionnalités communes
+---------------------------------------
 
 1.1 MTools.pm
+-------------
 
 Cette partie de la documentation est principalement extraite de MTools.pm
 
@@ -101,6 +103,7 @@ http://www.tkzinc.org/Documentation/refman-3.3.4/index.html
 	- chggroup
 	
 1.2 MObjet.pm
+-------------
 
 Cette partie de la documentation est principalement extraite de MObjet.pm
 
@@ -142,12 +145,14 @@ Les fonctions publiques :
 
 
 PARTIE 2 : Les objets de MTools
+-------------------------------
 
 2.1 Les éléments graphiques
+---------------------------
 
 Les objets graphiques élémentaires sont de type MObjet. Ils se trouvent dans
 MTools::GUI.
-
+_______
 MCircle : l'objet cercle. La création nécessite les arguments suivants :
 	- parent : père de l'objet.
 	- x, y : coordonnées du centre du cercle
@@ -155,18 +160,63 @@ MCircle : l'objet cercle. La création nécessite les arguments suivants :
 	- %options : table de hash passée en paramètre de la création de l'objet
 	zinc arc
 
-MAntiRecouvrementGroup.pm :
-
-MClip.pm :
-
+Exemple d'utilisation :
+use MTools;
+use MTools::GUI::MCircle;
+new MTools (800, 600, "Exemple de cercle");
+my $cercle = new MTools::GUI::MCircle (1, 400, 300, 200);
+my $disque = new MTools::GUI::MCircle (1, 400, 300, 200,
+				       -filled => 1, -fillcolor => red);
+mrun;
+________
+MRect.pm :  l'objet rectangle. La création nécessite les arguments suivants :
+	- parent : père de l'objet.
+	- x, y : coordonnées de l'angle en haut à gauche du rectangle
+	- w, h : largeur et hauteur du rectangle
+	- %options : table de hash passée en paramètre de la création de l'objet
+	zinc rectangle
+
+Exemple d'utilisation :
+use MTools;
+use MTools::GUI::MRect;
+new MTools (800, 600, "Exemple de rectangle");
+my $contour = new MTools::GUI::MRect (1, 400, 300, 200, 10);
+my $surface = new MTools::GUI::MRect (1, 400, 400, 200, 20, -filled => 1, -fillcolor => red);
+mrun;
+________
+MClip.pm : l'objet permettant de faire du clipping. Le clipping est une
+technique qui consiste à réaliser une fenêtre de visualisation. En pratique,
+le clip est un objet qui définit une surface. Les portions du groupe clippé qui
+se trouvent à l'intérieur de cette surface sont visibles, tout ce qui est en
+dehors n'est pas affiché.
+La création nécessite les arguments suivants :
+	- clipped : groupe zinc clippé
+	- path : description de l'objet clippant
+		- soit une descrition sous forme [_type, _coords] créant un
+		objet zinc de type _type et de coordonnées _coords
+		- soit un objet existant qui prendra pour père le groupe $clipped.
+
+Exemple d'utilisation :
+use MTools;
+use MTools::MGroup;
+use MTools::GUI::MCircle;
+use MTools::GUI::MRect;
+use MTools::GUI::MClip;
+new MTools (800, 600, "Exemple de clip");
+my $fenetre = new MTools::MGroup (1);
+my $disque = new MTools::GUI::MCircle ($fenetre, 400, 300, 100, -filled => 1);
+my $trou = new MTools::GUI::MRect ($fenetre, 250, 300, 100, 60);
+new MTools::GUI::MClip ($fenetre, $trou);
+mrun;
+_________
 MCurve.pm :
-
+_________________________
+MAntiRecouvrementGroup.pm :
+_________
 MImage.pm :
-
-MRect.pm :
-
+________
 MText.pm :
-
+___________
 MTexture.pm :
 
 2.2 Le SVG
@@ -182,3 +232,5 @@ MTexture.pm :
 2.7 Les inclassables
 
 MGroup, ptkdb, MObjet, MTimer, MState, MSwitch, MIvy, WacomAdapter
+
+2.8 L'utilisation de TkZinc