home *** CD-ROM | disk | FTP | other *** search
/ Linux Cubed Series 3: Developer Tools / Linux Cubed Series 3 - Developer Tools.iso / devel / lang / lisp / stk-3.0 / stk-3 / blt-for-STk-3.0 / blt-1.9 / man / intro.man < prev    next >
Encoding:
Text File  |  1995-07-01  |  6.2 KB  |  147 lines
  1. '\"
  2. '\" Copyright 1993-1994 by AT&T Bell Laboratories.
  3. '\"
  4. '\" Permission to use, copy, modify, and distribute this software
  5. '\" and its documentation for any purpose and without fee is hereby
  6. '\" granted, provided that the above copyright notice appear in all
  7. '\" copies and that both that the copyright notice and warranty
  8. '\" disclaimer appear in supporting documentation, and that the
  9. '\" names of AT&T Bell Laboratories any of their entities not be used
  10. '\" in advertising or publicity pertaining to distribution of the
  11. '\" software without specific, written prior permission.
  12. '\"
  13. '\" AT&T disclaims all warranties with regard to this software, including
  14. '\" all implied warranties of merchantability and fitness.  In no event
  15. '\" shall AT&T be liable for any special, indirect or consequential
  16. '\" damages or any damages whatsoever resulting from loss of use, data
  17. '\" or profits, whether in an action of contract, negligence or other
  18. '\" tortuous action, arising out of or in connection with the use or
  19. '\" performance of this software.
  20. '\"
  21. '\"
  22. .so man.macros
  23. .HS blt_intro cmds BLT Commands
  24. .BS
  25. '\" Note:  do not modify the .SH NAME line immediately below!
  26. .SH NAME
  27. blt_intro \- Introduction to the BLT library
  28. .BE
  29. .SH DESCRIPTION
  30. BLT is a library of extensions to the Tk library.  It adds new 
  31. commands and variables (all prefixed by "blt_") to the application's 
  32. interpreter.
  33. .LP
  34. .SH COMMANDS
  35. The following commands are added to the interpreter from the BLT library:
  36. .TP 15
  37. \fBblt_drag&drop\fR 
  38. Provides a drag-and-drop facility for Tk.  Information (represented
  39. by a token window) can be dragged to and from any Tk window, including
  40. those of another Tk application.  \fBblt_drag&drop\fR acts as a 
  41. coordinator, directing Tk \fBsend\fR commands between (or within) TCL/Tk 
  42. applications. 
  43. .TP 15
  44. \fBblt_htext\fR 
  45. A simple hypertext widget. Combines text and Tk widgets into a single 
  46. scroll-able window.  Tcl commands can be embedded into text, which are 
  47. invoked as the text is parsed.  In addition, Tk widgets can be appended 
  48. to the window at the current point in the text.  \fBblt_htext\fR can
  49. be also used to create scrolled windows of Tk widgets.  
  50. .TP 15
  51. \fBblt_graph\fR 
  52. A 2D plotting widget.  Plots two variable data in a window with an optional 
  53. legend and annotations.   It has of several components; coordinate axes, 
  54. crosshairs, a legend, and a collection of elements and tags.
  55. .TP 15
  56. \fBblt_barchart\fR 
  57. A barchart widget.  Plots two-variable data as rectangular bars in a 
  58. window.  The x-coordinate values designate the position of the bar along 
  59. the x-axis, while the y-coordinate values designate the magnitude.
  60. The \fBblt_barchart\fR widget has of several components; coordinate axes, 
  61. crosshairs, a legend, and a collection of elements and tags.
  62. .TP 15
  63. \fBblt_table\fR 
  64. A table geometry manager for Tk.  You specify window placements as table 
  65. row,column positions and windows can also span multiple rows or columns. 
  66. It also has many options for setting and/or bounding window sizes.
  67. .TP 15
  68. \fBblt_bitmap\fR 
  69. Reads and writes bitmaps from Tcl.  New X bitmaps can be defined
  70. on-the-fly from Tcl, obviating the need to copy around bitmap files.  
  71. Other options query loaded X bitmap's dimensions and data.
  72. .TP 15
  73. \fBblt_bgexec\fR 
  74. Like Tcl's \fBexec\fR command, \fBblt_bgexec\fR runs a pipeline of Unix 
  75. commands in the background.  Unlike \fBexec\fR, the output of the last
  76. process is collected and a global Tcl variable is set upon its completion.
  77. \fBblt_bgexec\fR can be used with \fBtkwait\fR to wait for Unix commands
  78. to finish while still handling expose events.  Intermediate output is
  79. also available while the pipeline is active.
  80. .TP 15
  81. \fBblt_busy\fR 
  82. Creates a "busy window" which prevents user-interaction when an
  83. application is busy.  The busy window also provides an easy way 
  84. to have temporary busy cursors (such as a watch or hourglass).
  85. .TP 15
  86. \fBblt_win\fR 
  87. Raise, lower, map, or, unmap any window.  The raise and lower functions
  88. are useful for stacking windows above or below "busy windows".
  89. .TP 15
  90. \fBblt_watch\fR 
  91. Arranges for Tcl procedures to be called before and/or after the execution
  92. of every Tcl command. This command
  93. may be used in the logging, profiling, or tracing of Tcl code.
  94. .TP 15
  95. \fBblt_debug\fR 
  96. A simple Tcl command tracing facility useful for debugging Tcl code.  
  97. Displays each Tcl command before and after substitution along its level 
  98. in the interpreter on standard error.
  99. .TP 15
  100. \fBblt_bell\fR 
  101. Rings the keyboard bell.  This is useful when the application can't
  102. write to a tty.
  103. .TP 15
  104. \fBblt_cutbuffer\fR 
  105. Manipulates X cutbuffer properties. This is useful for communicating with
  106. other X applications that don't properly use X selections.
  107. .SH VARIABLES
  108. .PP
  109. The following Tcl variables are either set or used by BLT at various times
  110. in its execution:
  111. .TP 15
  112. \fBblt_library\fR
  113. This variable contains the name of a directory containing a library
  114. of Tcl scripts and other files related to BLT.  Currently, this 
  115. directory contains the \fBblt_drag&drop\fR protocol scripts and the 
  116. PostScript prolog
  117. used by \fBblt_graph\fR and \fBblt_barchart\fR.
  118. The value of this variable is taken from the BLT_LIBRARY environment
  119. variable, if one exists, or else from a default value compiled into
  120. the \fBBLT\fR library.
  121. .TP 15
  122. \fBblt_versions\fR 
  123. This variable is set in the interpreter for each application. It is an 
  124. array of the current version numbers for each 
  125. of the BLT commands in the form \fImajor\fR.\fIminor\fR.  \fIMajor\fR and
  126. \fIminor\fR are integers.  The major version number increases in
  127. any command that includes changes that are not backward compatible
  128. (i.e. whenever existing applications and scripts may have to change to
  129. work with the new release).  The minor version number increases with
  130. each new release of a command, except that it resets to zero whenever the
  131. major version number changes.  The array is indexed by the individual 
  132. command name.
  133. .SH ADDING BLT TO YOUR APPLICATIONS
  134. It's easy to add BLT to an existing Tk application.  BLT requires no 
  135. patches or edits to the Tcl or Tk libraries.  To add BLT, simply add the 
  136. following code snippet to your application's tkAppInit.c file.  
  137. .DS
  138. \fCif (Blt_Init(interp) != TCL_OK) {
  139.     return TCL_ERROR;
  140. }\fR
  141. .DE
  142. Recompile and link with the BLT library (libBLT.a) and that's it.
  143. .SH BUGS
  144. Send bug reports, correspondence, etc. to george.howlett@att.com
  145. .SH KEYWORDS
  146. BLT
  147.