| 1 | # Copyright (c) 1990-1994 The Regents of the University of California. |
| 2 | # Copyright (c) 1994-1996 Sun Microsystems, Inc. |
| 3 | # See the file "license.terms" for information on usage and redistribution |
| 4 | # of this file, and for a DISCLAIMER OF ALL WARRANTIES. |
| 5 | # |
| 6 | # |
| 7 | |
| 8 | =head1 NAME |
| 9 | |
| 10 | tkvars - Variables used or set by Tk |
| 11 | |
| 12 | =for category Tk Generic Methods |
| 13 | |
| 14 | =head1 DESCRIPTION |
| 15 | |
| 16 | The following perl variables are either set or used by Tk at various times |
| 17 | in its execution. (For a list of variables used by perl see L<perlvar>.) |
| 18 | |
| 19 | =over 4 |
| 20 | |
| 21 | =item B<$Tk::library> |
| 22 | |
| 23 | This variable holds the file name for a directory containing the modules |
| 24 | related to Tk. These modules include an initialization |
| 25 | file that is normally processed whenever a Tk application starts up, |
| 26 | plus other files containing procedures that implement default behaviors |
| 27 | for widgets. |
| 28 | The initial value of B<$Tk::library> is set when Tk is added to |
| 29 | an interpreter; this is done by searching searching for a directory |
| 30 | named Tk in the directory where the file F<Tk.pm>, or the first |
| 31 | directory F<Tk> in C<@INC>. |
| 32 | |
| 33 | The B<TK_LIBRARY> environment variable used by Tcl/Tk is not |
| 34 | supported by perl/Tk. Please use L<@INC|perlvar/@INC> to change where modules |
| 35 | are searched. |
| 36 | |
| 37 | B<Note:> This is Tcl remnant. With perl it makes more sense to |
| 38 | use C<@INC> and C<%INC>). |
| 39 | |
| 40 | =item B<$Tk::patchLevel> |
| 41 | |
| 42 | Contains a decimal integer giving the current patch level for Tk. |
| 43 | The patch level is incremented for each new release or patch, and |
| 44 | it uniquely identifies an official version of Tk. |
| 45 | |
| 46 | B<Note:> this is Tcl remnant. With perl it makes more sense to |
| 47 | use B<$Tk::VERSION> described below. |
| 48 | |
| 49 | =item B<$Tk::strictMotif> |
| 50 | |
| 51 | This variable is set to zero by default. |
| 52 | If an application sets it to one, then Tk attempts to adhere as |
| 53 | closely as possible to Motif look-and-feel standards. |
| 54 | For example, active elements such as buttons and scrollbar |
| 55 | sliders will not change color when the pointer passes over them. |
| 56 | |
| 57 | =item B<$Tk::VERSION> |
| 58 | |
| 59 | The variable holds the current version number of the perl/Tk |
| 60 | release in the form I<major>.I<minor>. I<Major> and |
| 61 | I<minor> are integers. |
| 62 | |
| 63 | The I<major> version number shows on which |
| 64 | Tcl/Tk release perl/Tk is based. E.g., B<402> means based on |
| 65 | Tcls Tk 4.2. (Patchlevel of Tcls Tk are not incorporated because |
| 66 | perl/Tk tended to be ``I<ahead>'' of them on some fixes and behind on |
| 67 | others. The first digest of the major version number increases in |
| 68 | any Tk release that includes changes that are not backward compatible |
| 69 | (i.e. whenever existing perl/Tk applications and scripts may have to change to |
| 70 | work with the new release). |
| 71 | |
| 72 | The I<minor> version depends on perl/Tk only. It uses the |
| 73 | 'even'='stable', 'odd'='experimental' scheme that linux uses: |
| 74 | |
| 75 | .0xx - inherently 'alpha' |
| 76 | .1xx - experimental 'beta' |
| 77 | .2xx - stable |
| 78 | .3xx - experimental |
| 79 | .4xx - stable |
| 80 | ... |
| 81 | |
| 82 | The minor version number increases with |
| 83 | each new release of Tk, except that it resets to zero whenever the |
| 84 | major version number changes. |
| 85 | |
| 86 | =item B<$Tk::version> |
| 87 | |
| 88 | The variable holds the current version number of the Tk |
| 89 | library in the form I<major>.I<minor>. I<Major> and |
| 90 | I<minor> are integers. The major version number increases in |
| 91 | any Tk release that includes changes that are not backward compatible |
| 92 | (i.e. whenever existing Tk applications and scripts may have to change to |
| 93 | work with the new release). The minor version number increases with |
| 94 | each new release of Tk, except that it resets to zero whenever the |
| 95 | major version number changes. |
| 96 | |
| 97 | B<Note:> this is Tcl remnant. With perl it makes more sense to |
| 98 | use B<$Tk::VERSION> described above. |
| 99 | |
| 100 | =back |
| 101 | |
| 102 | =head1 KEYWORDS |
| 103 | |
| 104 | variables, version |
| 105 | |
| 106 | =cut |
| 107 | |