Classe Outil

Propriétés de la classe Outil

Propriété	Explication
cursor	Permet de mettre à jour le curseur lorsque l'utilisateur clique sur l'outil. Par défaut, le curseur est défini sur 0. Les choix de valeurs d'ID du curseur sont indiqués ici :
enabled	Renvoie la disponibilité de l'outil, définie par défaut sur True. Lorsque cette propriété est définie sur False, l'outil est désactivé et non disponible. Cette propriété permet d'écrire la logique destinée à tester l'état de l'application bureautique afin de désactiver ou d'activer l'outil. Vous pouvez, par exemple, avoir un outil nécessitant qu'une couche de données soit chargée dans ArcMap pour que l'exécution soit possible.
shape	Permet de spécifier le type de forme dessiné sur la carte. La carte peut être utilisée pour sélectionner des entités, définir une étendue, ou comme entrée des outils de géotraitement. Une fois la forme ajoutée à la carte, la forme disparaît de l'affichage et sa fonction correspondante est appelée. Les fonctions sont présentées ci-dessous. Trois types de formes peuvent être définies. Ligne Rectangle Cercle

Fonctions de la classe Outil

Fonction	Explication
__init__(self)	Cette fonction intégrée de Python est le constructeur dans lequel certaines variables initiales peuvent être définies. Par défaut, les propriétés cursor et enabled de l'outil sont initialement définies.
onDblClick(self)	Survient lorsque l'utilisateur double-clique sur le bouton de la souris lorsque cet outil est actif.
onCircle(self, circle_geometry)	Survient lorsque l'utilisateur relâche le bouton de la souris une fois que le cercle est tracé sur la carte. circle_geometry représente un objet polygone.
onLine(self, line_geometry)	Survient lorsque l'utilisateur double-clique sur le bouton de la souris pour finir de tracer la ligne sur la carte. line_geometry représente un objet polyligne.
onRectangle(self, rectangle_geometry)	Survient lorsque l'utilisateur relâche le bouton de la souris une fois que le rectangle est tracé sur la carte. rectangle_geometry représente un objet étendue.
onMouseDown(self, x, y, button, shift)	Survient lorsque l'utilisateur relâche le bouton de la souris lorsque cet outil est actif. Les valeurs x et y des fonctions onMouseDown et onMouseUp représentent les coordonnées de la fenêtre dans laquelle l'utilisateur a cliqué sur le bouton ou l'a relâché. Les valeurs x et y des fonctions onMouseDownMap et onMouseUpMap représentent les coordonnées de la fenêtre dans laquelle l'utilisateur a cliqué sur le bouton ou l'a relâché. button précise sur quel bouton de souris l'utilisateur a cliqué. Les valeurs renvoyées pour le bouton sont répertoriées ci-après. shift indique si l'utilisateur appuie sur la touche MAJ, CTRL ou ALT lorsqu'il relâche le bouton de la souris. Les valeurs renvoyées pour shift sont répertoriées ci-après.
onMouseDownMap(self, x, y, button, shift)
onMouseUp(self, x, y, button, shift)
onMouseUpMap(self, x, y, button, shift)
onKeyDown(self, keycode, shift)	Survient lorsque l'utilisateur appuie sur une touche du clavier (onKeyDown) ou la relâche (onKeyUp) lorsque cet outil est actif. keycode précise sur quelle touche l'utilisateur a appuyé. shift indique si l'utilisateur appuie sur la touche MAJ, CTRL ou ALT lorsqu'il appuie aussi sur le bouton de touche. Les valeurs renvoyées pour shift sont répertoriées ci-après.
onKeyUp(self, keycode, shift)
deactivate(self)	Le code au sein de cette méthode s'exécute lorsqu'un utilisateur clique sur un autre outil (tel que l'outil Déplacer) et que cet outil n'est plus actif.

Codes des touches

Code de touche	Touches enfoncées
0	Aucune touche
1	Touche Maj
2	Touche Ctrl
3	Touches Maj + Ctrl
4	Touche Alt
5	Touches Maj + Alt
6	Touches Ctrl + Alt
7	MAJ + CTRL + ALT keys

Codes de bouton de souris

Code de bouton	Boutons de souris enfoncés
1	Bouton gauche
2	Bouton droit
3	Boutons droit et gauche
4	Bouton central
5	Boutons gauche et central
6	Boutons droit et central
7	Tous les boutons