  NOM
    checkbutton - Crée et manipule les widgets cases à cocher
  SYNTAXE
    checkbutton pathName ?options?
  STANDARD OPTIONS
    -activebackground, activeBackground, Foreground
    -activeforeground, activeForeground, Background
    -anchor, anchor, Anchor
    -background ou -bg, background, Background
    -bitmap, bitmap, Bitmap
    -borderwidth ou -bd, borderWidth, BorderWidth
    -cursor, cursor, Cursor
    -disabledforeground, disabledForeground, DisabledForeground
    -font, font, Font
    -foreground ou -fg, foreground, Foreground
    -highlightbackground, highlightBackground, HighlightBackground
    -highlightcolor, highlightColor, HighlightColor
    -highlightthickness, highlightThickness, HighlightThickness
    -image, image, Image
    -justify, justify, Justify
    -padx, padX, Pad
    -pady, padY, Pad
    -relief, relief, Relief
    -takefocus, takeFocus, TakeFocus
    -text, text, Text
    -textvariable, textVariable, Variable
    -underline, underline, Underline
    -wraplength, wrapLength, WrapLength
  OPTIONS SPECIFIQUES AU WIDGET
    -commande, commande, Command
    -height, height, Height
    -indicatoron, indicatorOn, IndicatorOn
    -offvalue, offValue, Value
    -onvalue, onValue, Value
    -overrelief, overRelief, OverRelief
    -selectcolor, selectColor, Background
    -selectimage, selectImage, SelectImage
    -state, state, State
    -variable, variable, Variable
    -width, width, Width
  DESCRIPTION
  COMMANDES DE WIDGET
    pathName cget option
    pathName configure ?option? ?valeur option valeur ...?
    pathName deselect
    pathName flash
    pathName invoke
    pathName select
    pathName toggle
  BINDINGS
  MOTS-CLES

### NOM

checkbutton - Crée et manipule les widgets cases à cocher

### SYNTAXE

checkbutton pathName ?options?

### STANDARD OPTIONS

-activebackground, activeBackground, Foreground
-activeforeground, activeForeground, Background
-anchor, anchor, Anchor
-background ou -bg, background, Background
-bitmap, bitmap, Bitmap
-borderwidth ou -bd, borderWidth, BorderWidth
-cursor, cursor, Cursor
-disabledforeground, disabledForeground, DisabledForeground
-font, font, Font
-foreground ou -fg, foreground, Foreground
-highlightbackground, highlightBackground, HighlightBackground
-highlightcolor, highlightColor, HighlightColor
-highlightthickness, highlightThickness, HighlightThickness
-image, image, Image
-justify, justify, Justify
-padx, padX, Pad
-pady, padY, Pad
-relief, relief, Relief
-takefocus, takeFocus, TakeFocus
-text, text, Text
-textvariable, textVariable, Variable
-underline, underline, Underline
-wraplength, wrapLength, WrapLength

### OPTIONS SPECIFIQUES AU WIDGET

Command-Line Name: -command
Database Name: command
Database Class: Command
  Spécifie une commande Tcl à associer à la case. cette commande est appelée quand le bouton1 de la souris est relaché au dessus de la case à cocher. Sa variable globale (l'option -variable )sera mise à jour avant que la commande soit appelée.

Command-Line Name: -height
Database Name: height
Database Class: Height
  Spécifie la hauteur désirée de la case. Si une image ou un bitmap est affiché dans la case alors la valeur est donnée en unités d'écran (c.a.d. toutes formes acceptable par Tk_GetPixels); pour le texte c'est en lignes de texte. Si cette option n'est pas spécifiée, la hauteur désirée est calculée à partir de la taille de l'image, du bitmap ou du texte affiché à l'intérieur.

Command-Line Name: -indicatoron
Database Name: indicatorOn
Database Class: IndicatorOn
  Spécifie si ou non l'indicator doit être dessiné. Doit être une valeur booléenne correcte. Si fausse, l'option relief est ignorée et le relief du widget est toujours sunken (enfoncé) si le widget est sélectionné et raised (èlevé) autrement.

Command-Line Name: -offvalue
Database Name: offValue
Database Class: Value
  Spécifie la valeur à ranger dans la variable associée quand la case est déselectionnée. Par défaut de ``0''.

Command-Line Name: -onvalue
Database Name: onValue
Database Class: Value
  Spécifie la valeur à ranger dans la variable associée quand la case est sélectionnée. Par défaut de ``1''.

Command-Line Name: -overrelief
Database Name: overRelief
Database Class: OverRelief
  Spécifie un relief alternatif pour la case à cocher, à utiliser quand le curseur de la souris est au dessus du widget. Cette option peut être utilisée pour fabriquer des barres de boutons, en configurant -relief flat -overrelief raised. Si la valeur de cette option est la chaîne vide, alors aucun relief alternatif n'est utilisé quand le curseur de la souris est au dessus de la case à cocher. La chaîne vide est la valeur par défaut.

Command-Line Name: -selectcolor
Database Name: selectColor
Database Class: Background
  Spécifie une couleur d'arrière-plan à utiliser quand la case à cocher est sélectionné. Si indicatorOn est true alors la couleur s'applique à l'indicateur. Sous Windows, cette couleur est utilisée comme arrière-plan pour l'indicateur indépendemment de l'état de sélection. Si indicatorOn est faux, cette couleur est utilisé comme arrière-plan pour le widget entier, à la place de background ou activeBackground, chaque fois que le widget est sélectionné. Si spécifié comme chaîne vide alors aucune couleur spéciale n'est utilisée pour l'affichage quand le widget est sélectionné.

Command-Line Name: -selectimage
Database Name: selectImage
Database Class: SelectImage
  Spécifie une image à afficher (à la place de the image option) quand la case à cocher est sélectionnée. Cette option est ignorée à moins que l'option image ait été spécifiée.

Command-Line Name: -state
Database Name: state
Database Class: State
  Spécifie un des trois états de la case à cocher: normal, active, ou disabled. Dans l'état normal la case à cocher est affichée en utilisant les options foreground et background. The état actif est généralement utilisé quand le pointeur est au-dessus de la case à cocher. dans l'état actif la case à cocher est affichée en utilisant les options activeForeground et activeBackground. L'état désactivé (disabled) signifie que la case à cocher sera insensible: les bindings par défaut refuseront d'activer le widget et ignoreront les clic sur la souris. Dans cet état les options disabledForeground et background déterminent comment la case à cocher est affichée.

Command-Line Name: -variable
Database Name: variable
Database Class: Variable
  Spécifie le nom de la variable globale à positionner pour indiquer si ou non la case est sélectionnée. Par défaut du nom de la case dans son parent (c.a.d. le dernier élément du nom de chemin de la case).

Command-Line Name: -width
Database Name: width
Database Class: Width
  Spécifie la largeur désirée. Si une image ou un bitmap est affiché dans la case alors la valeur est en unités écran(c.a.d. n'importe quelle des formes acceptable par Tk_GetPixels); pour le texte c'est en caractères. Si cette option n'est pas spécifiée, la largeur désirée est calculée à partir de la taille de l'image,du bitmap ou du texte affiché.

### DESCRIPTION

La commande checkbutton crée une nouvelle fenêtre (donné par l'argument pathName ) et en fait un widget case à cocher. Des options supplémentaires, décrites ci-dessus, peuvent être spécifiées sur la ligne de commande ou dans la base de données d'options pour configurer des aspects de la case à cocher comme ses couleurs, police, texte, et relief initial. La commande checkbutton retourne son argument pathName. A l'instant ou cette commande est appelée, il ne doit pas exister une fenêtre nommée pathName, mais le pathName de son parent doit exister.

Une case à cocher est un widget qui affiche une chaîne textuelle, un bitmap ou une image et a carré appelé un indicator. Si du texte est affiché, il doit être d'une seule police, mais il peut occuper de multiples lignes sur l'écran (s'il contient des newlines ou si le retour à la ligne se produit à cause de l'option wrapLength) et un des caractères peut optionellement être souligné en utilisant l'option underline. Une case à cocher a tous les comportements d'un simple bouton, incluant les suivant: il peut s'afficher dans un des trois différents états, suivant l'option state; il peut apparaitre "raised", "sunken", ou "flat"; il peut clignoter; et il appelle une commande Tcl quand le bouton1 de la souris est cliqué dans la case à cocher.

De plus, les cases à cocher peuvent être sélectionnée. Si une case à cocher est sélectionnée alors l'indicateur est normalement dessiné avec une sélectionné apparence, et la variable Tcl associée à la case à cocher est positionnée à une valeur particulière(normalement 1). Sous Unix, l'indicateur est dessiné avec un relief enfoncé et une couleur spéciale. Sous Windows, l'indicateur est dessiné avec une coche. Si la case à cocher n'est pas sélectionnée, alors l'indicateur est dessiné avec une apparence déselectionnée, et la variable associée est positionnée à une valeur différente (généralement 0). Sous Unix, l'indicateur est dessiné avec un relief èlevé et aucune couleur spéciale. Sous Windows, l'indicateur est dessiné sans coche. Par défaut, le nom de la variable associée avec une case à cocher est le même que le NOM utilisé pour créer la case à cocher. Le nom de variable, et les valeurs ``on'' et ``off'' qu'elle stocke, peuvent être modifiés avec les options de la ligne de commande ou dans la base de données d'options. Les options de configuration peuvent être également utilisées pour modifier la manière dont l'indicateur est affiché (ou s'il est affiché tout court). Par défaut une case à cocher est configurée pour se selectionner et déselectionner lors de clics alternés. De plus, chaque case à cocher suit sa variable associée et se selectionne et déselectionne automatiquement quand la valeur de la variable change.

### COMMANDES DE WIDGET

La commande checkbutton crée une nouvelle commande Tcl dont le nom est pathName. Cette commande peut être utilisée pour appeler diverses opérations sur le widget. Elle a la forme générale suivante:

    pathName option ?arg arg ...?

Option et args déterminent le comportement exact de la commande. Les commandes suivantes sont possibles pour les widgets case à cocher :

pathName cget option
  Retourne la valeur courante de l'option de configuration donnée par option. Option peut prendre n'importe quelle des valeurs acceptées par la commandecheckbutton .

pathName configure ?option? ?valeur option valeur ...?
  Interroge ou modifie les options de configuration du widget. Si aucune option n'est spécifiée, retourne une liste décrivant chacune des options disponibles pour pathName (voir Tk_ConfigureInfo pour des informations sur le format de cette liste). Si option est spécifiée sans valeur, alors la commande retourne une liste décrivant l'option nommée (cette liste sera identique à la sous-liste correspondante de la valeur retournée si aucune option n'est spécifiée). Si une ou plus paires option-valeur sont spécifiées, alors la commande modifie le(s) option(s) donné à la valeur(s) indiquée; dans ce cas la commande retourne une chaîne vide. Option peut prendre n'importe quelle des valeurs acceptées par la commandecheckbutton.

pathName deselect
  Déselectionne la case à cocher et positionne la variable associée à ``off''.

pathName flash
  Fait clignoter la case à cocher. Ceci est réalisé en réaffichant la case à cocher plusieurs fois, alternant entre les couleurs actives et normales. A la fin du flash la case à cocher est laissée dans le même état normal/active que quand la commande a été appelée. cette commande est ignorée si l'état de la case à cocher est disabled.

pathName invoke
  Fait ce qui se serait produit si l'utilisateur coche la case avec la souris: bascule l'état de la case et appelle la commande Tcl associée à la case à cocher, s'il y en a une. La valeur de retour est la valeur de retour de la commande Tcl, ou une chaîne vide s'il n'y a pas de commande associé à la case à cocher. cette commande est ignorée si l'état est disabled.

pathName select
  Selectionne la case à cocher et positionne la variable associée à ``on''.

pathName toggle
  Bascule l'état de sélection de la case, la réaffiche et modifie sa variable associée pour refléter le nouvel état.

### BINDINGS

Tk crée automatiquement des bindings de classe pour les cases à cocher qui leur donne le comportement par défaut suivant:

[1]
  Sur les systèmes Unix, une case à cocher s'active chaque fois que la souris passe au-dessus et se désactive quand la souris quitte la case à cocher. Sur les systèmes Mac et Windows, quand le bouton1 de la souris est appuyé au-dessus d'une case à cocher, elle s'active quand le pointeur de souris est dans la case, et se désactive quand le pointeur de souris quitte la case.

[2]
  Quand le bouton1 de la souris est appuyé au-dessus d'une case à cocher, elle est appelée (son état de sélection bascule et la commande associée est appelée, s'il y en a une).

[3]
  Quand une case à cocher a le focus, la barre d'espace provoque l'appel de la case à cocher. Sous Windows, il y a des bindings supplémentaires ; plus (+) et égal (=) selectionne la case, et moins (-) la déselectionne.

Si l'état de la case à cocher est disabled alors aucune des actions ci-dessus ne se produit: la case à cocher est complètement inerte.

Le comportement des cases à cocher peut être changé en définissant des nouveaux bindings ou en redéfinissant les bindings de classe.

### MOTS-CLES

checkbutton, widget

    Copyright © 1990-1994 The Regents of the University of California.
    Copyright © 1994-1996 Sun Microsystems, Inc.
    Copyright © 1995-1997 Roger E. Critchlow Jr.

Copyright © 2003 - Le Portail Tcl/Tk Francophone.