Documentation‎ > ‎Buttons‎ > ‎

    gnocl::checkButton

    A widget which changes between two states when clicked.

    Synopsis

    gnocl::checkButton [-option value...]

    Screenshot

    Options

    -active boolean (default: 0)
    Whether the widget is active.
    -activeBackgroundColor color
    Background colour.
    -data string
    User defined data which can be retrieved via the cget subcommand.
    -hasFocus 1
    This sets the focus to the widget. To unset the focus it must be set to another widget.
    -indicatorOn boolean (default: true)
    Determines whether or not the toggle button is drawn on screen
    -name string
    Name of the widget, can be used to set options in an rc file.
    -normalBackgroundColor color
    Background colour. DISCLAIMER_COLOR
    -offValue string (default: 0)
    Value to store in the button's associated variable whenever this button is not selected
    -onButtonPress string (default: "")
    Tcl script which is executed if a mouse button is press inside the widget. Before evaluation the following percent strings are substituted:

    %w    widget name
    %t    type of event. One of buttonPress, button2Press or button3Press
    %x    x coordinate
    %y    y coordinate
    %b    button number
    %s    state of the buttons and modifiers (bitmask)

    -onButtonRelease string (default: "")
    Tcl script which is executed if a mouse button is released inside the widget. Before evaluation the following percent strings are substituted:

    %w    widget name
    %t    type of event. One of buttonPress, button2Press or button3Press
    %x    x coordinate
    %y    y coordinate
    %b    button number
    %s    state of the buttons and modifiers (bitmask)
    -onPopupMenu string (default: "")
    Tcl script which is executed if the "popup-menu" signal is received, which is normally the case if the user presses Shift-F10. Before evaluation the following percent strings are substituted:

    %w    widget name

    -onShowHelp string (default: "")

    Tcl script which is executed in the global scope if the "show-help" signal is received, which is normally the case if the user presses F1 or Ctrl-F1. Before evaluation the following percent strings are substituted:

    %w    widget name
    %h     help type: either "whatsThis" or "tooltip"
    -onToggled string (default: "")
    Tcl script which is executed if the radio button is toggled. Before evaluation the following percent strings are substituted:

    %w    widget name
    %v    onValue or offValue depending upon the widget state
    -onValue string (default: 1)
    Value to store in the button's associated variable whenever this button is selected
    -prelightBackgroundColor color
    Background colour. DISCLAIMER_COLOR
    -relief ONE OF normal, half or none (default: normal)
    Relief of the button.
    -sensitive boolean (default: 1)
    Whether or not the item is sensitive to user input.
    -text percent-string (default: "")
    Text or icon of the button
    -tooltip string
    Message that appear next to this widget when the mouse pointer is held over it for a short amount of time.
    -variable: string
    Name of a (global) variable which is changed when the state of the button changes.
    -visible boolean (default: 1)
    Whether or not the item is visible.

    Description

    A check button widget has two states: on and off. If the state is changed, it executes a command and sets a tcl variable appropriately.

    Commands

    id cget option
    Returns the value for one option. The option may have any of the values accepted by configure.
    id class
    Return the class for this widget object, i.e.'checkButton'.
    id configure [-option value...]
    Configures the widget. Option may have any of the values accepted on creation of the widget.
    id delete
    Deletes the widget and the associated tcl command.
    id onToggled
    Invoke the Tcl command associated with the check button if there is one. This command is ignored if the button's state is not sensitive.

    Example

    set but [gnocl::checkButton \
        -text "%__Status" \
        -onValue "ok" \
        -offValue "danger" \
        -variable status]

    gnocl::window \
        -title "Check Button" \
        -child $but




    Comments

    Sections