diff options
| -rw-r--r-- | doc/user_manual.txt | 90 |
1 files changed, 86 insertions, 4 deletions
diff --git a/doc/user_manual.txt b/doc/user_manual.txt index b39859e..ae89ddc 100644 --- a/doc/user_manual.txt +++ b/doc/user_manual.txt @@ -6,14 +6,16 @@ celles communes à tous les objets MTools. La deuxième partie décrit l'utilisation spécifique de chaque objet. -PARTIE 1 : MTools.pm +PARTIE 1 : Les fonctionnalités communes + +1.1 MTools.pm Cette partie de la documentation est principalement extraite de MTools.pm MTools exporte des fonctions destinées principalement à : - - activer des fonctions propres à la librairie mtools - - assurer la compatibilité entre la manipulation des objets mtools et des - objets zincs + - activer des fonctions propres à la librairie mtools + - assurer la compatibilité entre la manipulation des objets mtools et des + objets zincs Ainsi, d'une manière générale, toutes fonctions exportées s'appliquent aussi bien à des objets zinc qu'à des objets mtools. L'unique restriction est dans la @@ -98,5 +100,85 @@ http://www.tkzinc.org/Documentation/refman-3.3.4/index.html - clone - chggroup +1.2 MObjet.pm + +Cette partie de la documentation est principalement extraite de MObjet.pm + +Le composant MObjet est l'objet racine des composants MTools. +Il definit les fonctions applicables uniquement aux objets MTools. + +IMPORTANT : Une autre partie des fonctions applicables aux objets MTools est +définie dans la classe MTools. La différence entre ces deux classes de fonctions +est que les fonctions définies dans MTools sont également applicables à des +objets zinc tandis que les fonctions définies ici ne peuvent être appliquées +qu'à des objets héritant de MTools::MObjet. + +Concepts : + - Objet MTools : objet héritant de MObjet + - Les PROPERTY : les propriétés sont des attributs particuliers et + modifiables par un appel à "mconfigure". Elles peuvent être écoutées et + synchronisées avec d'autres propriétés MTools ou meme zinc ! (cf + MTools::plink et MTools::plisten). En conséquence elles sont là pour + engendrer un comportement consécutif à leur modification et doivent être + distinguées des attibuts qui peuvent se contenter d'être des clef de + hash de l'objet. + - Les EVENT : les évènements peuvent être émis par n'importe quel objet + MTools et captés par un binding. + +Les fonctions publiques : + - recordEvent : permet de permettre à un objet MObjet d'émettre un + évènement. + - recordProperty : permet de déclarer et initialiser une propriété. + NOTA : il pourrait manquer une déclaration collective des + propriétés. Initialement, celle-ci n'a pas été effectuée pour essayer de + limiter l'usage des propriétés et ne pas les utiliser comme des + attributs. + - notify : permet à un objet MTools de notifier un évènement + préalablement enregistré par recordEvent + - propagate : permet à un objet de propager un évènement émis par un + autre objet (correspond à un recordEvent puis un binding sur un + évènement d'un objet effectuant le notify du meme évènement depuis + l'objet declarant la propagation) + 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 + - r : rayon du cercle + - %options : table de hash passée en paramètre de la création de l'objet + zinc arc + +MAntiRecouvrementGroup.pm : + +MClip.pm : + +MCurve.pm : + +MImage.pm : + +MRect.pm : + +MText.pm : + +MTexture.pm : + +2.2 Le SVG + +2.3 Les widgets + +2.4 Les transformations + +2.5 Les animations + +2.6 Les comportements + +2.7 Les inclassables + +MGroup, ptkdb, MObjet, MTimer, MState, MSwitch, MIvy, WacomAdapter |