Skunkware 5

home *** CD-ROM | disk | FTP | other *** search

/ Skunkware 5 / Skunkware 5.iso / man / cat.n / checkbutton.n < prev next >

Wrap

Text File | 1995-07-26 | 19.6 KB | 330 lines

cccchhhheeeecccckkkkbbbbuuuuttttttttoooonnnn((((nnnn)))) TTTTkkkk (((( )))) cccchhhheeeecccckkkkbbbbuuuuttttttttoooonnnn((((nnnn)))) _________________________________________________________________ NNNNAAAAMMMMEEEE checkbutton - Create and manipulate check-button widgets SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS cccchhhheeeecccckkkkbbbbuuuuttttttttoooonnnn _p_a_t_h_N_a_m_e ?_o_p_t_i_o_n_s? SSSSTTTTAAAANNNNDDDDAAAARRRRDDDD OOOOPPPPTTTTIIIIOOOONNNNSSSS aaaaccccttttiiiivvvveeeeBBBBaaaacccckkkkggggrrrroooouuuunnnndddd bbbbiiiittttmmmmaaaapppp ffffoooonnnnttttrrrreeeelllliiiieeeeffff | aaaaccccttttiiiivvvveeeeFFFFoooorrrreeeeggggrrrroooouuuunnnndddd bbbboooorrrrddddeeeerrrrWWWWiiiiddddtttthhhh ffffoooorrrreeeeggggrrrroooouuuunnnnddddtttteeeexxxxtttt | aaaannnncccchhhhoooorrrr ccccuuuurrrrssssoooorrrr ppppaaaaddddXXXX tttteeeexxxxttttVVVVaaaarrrriiiiaaaabbbblllleeee | bbbbaaaacccckkkkggggrrrroooouuuunnnndddd ddddiiiissssaaaabbbblllleeeeddddFFFFoooorrrreeeeggggrrrroooouuuunnnndddd ppppaaaaddddYYYY | See the ``options'' manual entry for details on the standard options. WWWWIIIIDDDDGGGGEEEETTTT----SSSSPPPPEEEECCCCIIIIFFFFIIIICCCC OOOOPPPPTTTTIIIIOOOONNNNSSSS Name: ccccoooommmmmmmmaaaannnndddd Class: CCCCoooommmmmmmmaaaannnndddd Command-Line Switch:----ccccoooommmmmmmmaaaannnndddd Specifies a Tcl command to associate with the button. This command is typically invoked when mouse button 1 is released over the button window. The button's global variable (----vvvvaaaarrrriiiiaaaabbbblllleeee option) will be updated before the command is invoked. Name: hhhheeeeiiiigggghhhhtttt | Class: HHHHeeeeiiiigggghhhhtttt | Command-Line Switch:----hhhheeeeiiiigggghhhhtttt | || Specifies a desired height for the button. If a bitmap | is being displayed in the button then the value is in | screen units (i.e. any of the forms acceptable to | TTTTkkkk____GGGGeeeettttPPPPiiiixxxxeeeellllssss); for text it is in lines of text. If | this option isn't specified, the button's desired | height is computed from the size of the bitmap or text | being displayed in it. Name: ooooffffffffVVVVaaaalllluuuueeee Class: VVVVaaaalllluuuueeee Command-Line Switch:----ooooffffffffvvvvaaaalllluuuueeee Specifies value to store in the button's associated variable whenever this button is deselected. Defaults to ``0''. Name: oooonnnnVVVVaaaalllluuuueeee Class: VVVVaaaalllluuuueeee Command-Line Switch:----oooonnnnvvvvaaaalllluuuueeee Page 1 (printed 7/23/95) cccchhhheeeecccckkkkbbbbuuuuttttttttoooonnnn((((nnnn)))) TTTTkkkk (((( )))) cccchhhheeeecccckkkkbbbbuuuuttttttttoooonnnn((((nnnn)))) Specifies value to store in the button's associated variable whenever this button is selected. Defaults to ``1''. Name: sssseeeelllleeeeccccttttoooorrrr Class: FFFFoooorrrreeeeggggrrrroooouuuunnnndddd Command-Line Switch:----sssseeeelllleeeeccccttttoooorrrr Specifies the color to draw in the selector when this button is selected. If specified as an empty string | then no selector is drawn for the button. | Name: ssssttttaaaatttteeee | Class: SSSSttttaaaatttteeee | Command-Line Switch:----ssssttttaaaatttteeee | || Specifies one of three states for the check button: | nnnnoooorrrrmmmmaaaallll, aaaaccccttttiiiivvvveeee, or ddddiiiissssaaaabbbblllleeeedddd. In normal state the check | button is displayed using the ffffoooorrrreeeeggggrrrroooouuuunnnndddd and bbbbaaaacccckkkkggggrrrroooouuuunnnndddd | options. The active state is typically used when the | pointer is over the check button. In active state the | check button is displayed using the aaaaccccttttiiiivvvveeeeFFFFoooorrrreeeeggggrrrroooouuuunnnndddd | and aaaaccccttttiiiivvvveeeeBBBBaaaacccckkkkggggrrrroooouuuunnnndddd options. Disabled state means | that the check button is insensitive: it doesn't | activate and doesn't respond to mouse button presses. | In this state the ddddiiiissssaaaabbbblllleeeeddddFFFFoooorrrreeeeggggrrrroooouuuunnnndddd and bbbbaaaacccckkkkggggrrrroooouuuunnnndddd | options determine how the check button is displayed. Name: vvvvaaaarrrriiiiaaaabbbblllleeee Class: VVVVaaaarrrriiiiaaaabbbblllleeee Command-Line Switch:----vvvvaaaarrrriiiiaaaabbbblllleeee Specifies name of global variable to set to indicate whether or not this button is selected. Defaults to the name of the button within its parent (i.e. the last element of the button window's path name). Name: wwwwiiiiddddtttthhhh | Class: WWWWiiiiddddtttthhhh | Command-Line Switch:----wwwwiiiiddddtttthhhh | || Specifies a desired width for the button. If a bitmap | is being displayed in the button then the value is in | screen units (i.e. any of the forms acceptable to | TTTTkkkk____GGGGeeeettttPPPPiiiixxxxeeeellllssss); for text it is in characters. If this | option isn't specified, the button's desired width is | computed from the size of the bitmap or text being | displayed in it. _________________________________________________________________ Page 2 (printed 7/23/95) cccchhhheeeecccckkkkbbbbuuuuttttttttoooonnnn((((nnnn)))) TTTTkkkk (((( )))) cccchhhheeeecccckkkkbbbbuuuuttttttttoooonnnn((((nnnn)))) DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN The cccchhhheeeecccckkkkbbbbuuuuttttttttoooonnnn command creates a new window (given by the _p_a_t_h_N_a_m_e argument) and makes it into a check-button widget. Additional options, described above, may be specified on the command line or in the option database to configure aspects of the check button such as its colors, font, text, and initial relief. The cccchhhheeeecccckkkkbbbbuuuuttttttttoooonnnn command returns its _p_a_t_h_N_a_m_e argument. At the time this command is invoked, there must not exist a window named _p_a_t_h_N_a_m_e, but _p_a_t_h_N_a_m_e's parent must exist. A check button is a widget that displays a textual string or | bitmap and a square called a _s_e_l_e_c_t_o_r. A check button has | all of the behavior of a simple button, including the | following: it can display itself in either of three | different ways, according to the ssssttttaaaatttteeee option; it can be made to appear raised, sunken, or flat; it can be made to flash; and it invokes a Tcl command whenever mouse button 1 is clicked over the check button. In addition, check buttons can be _s_e_l_e_c_t_e_d. If a check button is selected then a special highlight appears in the selector, and a Tcl variable associated with the check button is set to a particular value (normally 1). If the check button is not selected, then the selector is drawn in a different fashion and the associated variable is set to a different value (typically 0). By default, the name of the variable associated with a check button is the same as the _n_a_m_e used to create the check button. The variable name, and the ``on'' and ``off'' values stored in it, may be modified with options on the command line or in the option database. By default a check button is configured to select and deselect itself on alternate button clicks. In | addition, each check button monitors its associated variable | and automatically selects and deselects itself when the | variables value changes to and from the button's ``on'' | value. WWWWIIIIDDDDGGGGEEEETTTT CCCCOOOOMMMMMMMMAAAANNNNDDDD The cccchhhheeeecccckkkkbbbbuuuuttttttttoooonnnn command creates a new Tcl command whose name is _p_a_t_h_N_a_m_e. This command may be used to invoke various operations on the widget. It has the following general form: _p_a_t_h_N_a_m_e _o_p_t_i_o_n ?_a_r_g _a_r_g ...? _O_p_t_i_o_n and the _a_r_gs determine the exact behavior of the command. The following commands are possible for check button widgets: _p_a_t_h_N_a_m_e aaaaccccttttiiiivvvvaaaatttteeee Change the check button's state to aaaaccccttttiiiivvvveeee and redisplay Page 3 (printed 7/23/95) cccchhhheeeecccckkkkbbbbuuuuttttttttoooonnnn((((nnnn)))) TTTTkkkk (((( )))) cccchhhheeeecccckkkkbbbbuuuuttttttttoooonnnn((((nnnn)))) the button using its active foreground and background colors instead of normal colors. This command is | ignored if the check button's state is ddddiiiissssaaaabbbblllleeeedddd. This | command is obsolete and will eventually be removed; use | ``_p_a_t_h_N_a_m_e ccccoooonnnnffffiiiigggguuuurrrreeee ----ssssttttaaaatttteeee aaaaccccttttiiiivvvveeee'' instead. _p_a_t_h_N_a_m_e ccccoooonnnnffffiiiigggguuuurrrreeee ?_o_p_t_i_o_n? ?_v_a_l_u_e _o_p_t_i_o_n _v_a_l_u_e ...? Query or modify the configuration options of the widget. If no _o_p_t_i_o_n is specified, returns a list describing all of the available options for _p_a_t_h_N_a_m_e (see TTTTkkkk____CCCCoooonnnnffffiiiigggguuuurrrreeeeIIIInnnnffffoooo for information on the format of this list). If _o_p_t_i_o_n is specified with no _v_a_l_u_e, then the command returns a list describing the one named option (this list will be identical to the corresponding sublist of the value returned if no _o_p_t_i_o_n is specified). If one or more _o_p_t_i_o_n-_v_a_l_u_e pairs are specified, then the command modifies the given widget option(s) to have the given value(s); in this case the command returns an empty string. _O_p_t_i_o_n may have any of the values accepted by the cccchhhheeeecccckkkkbbbbuuuuttttttttoooonnnn command. _p_a_t_h_N_a_m_e ddddeeeeaaaaccccttttiiiivvvvaaaatttteeee Change the check button's state to nnnnoooorrrrmmmmaaaallll and redisplay the button using its normal foreground and background colors. This command is ignored if the check button's | state is ddddiiiissssaaaabbbblllleeeedddd. This command is obsolete and will | eventually be removed; use ``_p_a_t_h_N_a_m_e ccccoooonnnnffffiiiigggguuuurrrreeee ----ssssttttaaaatttteeee | nnnnoooorrrrmmmmaaaallll'' instead. _p_a_t_h_N_a_m_e ddddeeeesssseeeelllleeeecccctttt Deselect the check button: redisplay it without a highlight in the selector and set the associated variable to its ``off'' value. _p_a_t_h_N_a_m_e ffffllllaaaasssshhhh Flash the check button. This is accomplished by redisplaying the check button several times, alternating between active and normal colors. At the end of the flash the check button is left in the same normal/active state as when the command was invoked. | This command is ignored if the check button's state is | ddddiiiissssaaaabbbblllleeeedddd. _p_a_t_h_N_a_m_e iiiinnnnvvvvooookkkkeeee Does just what would have happened if the user invoked | the check button with the mouse: toggle the selection | state of the button and invoke the Tcl command | associated with the check button, if there is one. The | return value is the return value from the Tcl command, | or an empty string if there is no command associated | with the check button. This command is ignored if the | Page 4 (printed 7/23/95) cccchhhheeeecccckkkkbbbbuuuuttttttttoooonnnn((((nnnn)))) TTTTkkkk (((( )))) cccchhhheeeecccckkkkbbbbuuuuttttttttoooonnnn((((nnnn)))) check button's state is ddddiiiissssaaaabbbblllleeeedddd. _p_a_t_h_N_a_m_e sssseeeelllleeeecccctttt Select the check button: display it with a highlighted selector and set the associated variable to its ``on'' value. _p_a_t_h_N_a_m_e ttttoooogggggggglllleeee Toggle the selection state of the button, redisplaying it and modifying its associated variable to reflect the new state. BBBBIIIINNNNDDDDIIIINNNNGGGGSSSS Tk automatically creates class bindings for check buttons | that give them the following default behavior: | [1] || The check button activates whenever the mouse passes | over it and deactivates whenever the mouse leaves the | check button. | [2] || The check button's relief is changed to sunken whenever | mouse button 1 is pressed over it, and the relief is | restored to its original value when button 1 is later | released. | [3] || If mouse button 1 is pressed over the check button and | later released over the check button, the check button | is invoked (i.e. its selection state toggles and the | command associated with the button is invoked, if there | is one). However, if the mouse is not over the check | button when button 1 is released, then no invocation | occurs. | If the check button's state is ddddiiiissssaaaabbbblllleeeedddd then none of the | above actions occur: the check button is completely non- | responsive. | The behavior of check buttons can be changed by defining new | bindings for individual widgets or by redefining the class | bindings. KKKKEEEEYYYYWWWWOOOORRRRDDDDSSSS check button, widget Page 5 (printed 7/23/95)