home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Source Code 1993 July / THE_SOURCE_CODE_CD_ROM.iso / languages / tcl / tk3.3b1 / doc / label.n < prev    next >
Encoding:
Text File  |  1993-04-01  |  4.5 KB  |  128 lines
  1. '\"
  2. '\" Copyright (c) 1990 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\" $Header: /user6/ouster/wish/man/RCS/label.n,v 1.13 93/04/01 09:52:42 ouster Exp $ SPRITE (Berkeley)
  22. '/" 
  23. .so man.macros
  24. .HS label tk
  25. .BS
  26. '\" Note:  do not modify the .SH NAME line immediately below!
  27. .SH NAME
  28. label \- Create and manipulate label widgets
  29. .SH SYNOPSIS
  30. \fBlabel\fI \fIpathName \fR?\fIoptions\fR?
  31. .SH "STANDARD OPTIONS"
  32. .LP
  33. .nf
  34. .ta 4c 8c 12c
  35. .VS
  36. \fBanchor    \fBborderWidth\fR    \fBforeground\fR    \fBrelief\fR
  37. \fBbackground\fR    \fBcursor\fR    \fBpadX\fR    \fBtext\fR
  38. \fBbitmap\fR    \fBfont\fR    \fBpadY\fR    \fBtextVariable\fR
  39. .VE
  40. .fi
  41. .LP
  42. See the ``options'' manual entry for details on the standard options.
  43. .SH "WIDGET-SPECIFIC OPTIONS"
  44. .LP
  45. .nf
  46. .VS
  47. Name:    \fBheight\fR
  48. Class:    \fBHeight\fR
  49. Command-Line Switch:    \fB\-height\fR
  50. .fi
  51. .IP
  52. Specifies a desired height for the label.
  53. If a bitmap is being displayed in the label then the value is in
  54. screen units (i.e. any of the forms acceptable to \fBTk_GetPixels\fR);
  55. for text it is in lines of text.
  56. If this option isn't specified, the label's desired height is computed
  57. from the size of the bitmap or text being displayed in it.
  58. .LP
  59. .nf
  60. Name:    \fBwidth\fR
  61. Class:    \fBWidth\fR
  62. Command-Line Switch:    \fB\-width\fR
  63. .fi
  64. .IP
  65. Specifies a desired width for the label.
  66. If a bitmap is being displayed in the label then the value is in
  67. screen units (i.e. any of the forms acceptable to \fBTk_GetPixels\fR);
  68. for text it is in characters.
  69. If this option isn't specified, the label's desired width is computed
  70. from the size of the bitmap or text being displayed in it.
  71. .VE
  72. .BE
  73.  
  74. .SH DESCRIPTION
  75. .PP
  76. The \fBlabel\fR command creates a new window (given by the
  77. \fIpathName\fR argument) and makes it into a label widget.
  78. Additional
  79. options, described above, may be specified on the command line
  80. or in the option database
  81. to configure aspects of the label such as its colors, font,
  82. text, and initial relief.  The \fBlabel\fR command returns its
  83. \fIpathName\fR argument.  At the time this command is invoked,
  84. there must not exist a window named \fIpathName\fR, but
  85. \fIpathName\fR's parent must exist.
  86. .PP
  87. A label is a widget
  88. .VS
  89. that displays a textual string or bitmap.
  90. .VE
  91. The label can be manipulated in a few simple ways, such as
  92. changing its relief or text, using the commands described below.
  93.  
  94. .SH "WIDGET COMMAND"
  95. .PP
  96. The \fBlabel\fR command creates a new Tcl command whose
  97. name is \fIpathName\fR.  This
  98. command may be used to invoke various
  99. operations on the widget.  It has the following general form:
  100. .DS C
  101. \fIpathName option \fR?\fIarg arg ...\fR?
  102. .DE
  103. \fIOption\fR and the \fIarg\fRs
  104. determine the exact behavior of the command.  The following
  105. commands are possible for label widgets:
  106. .TP
  107. \fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR?
  108. Query or modify the configuration options of the widget.
  109. If no \fIoption\fR is specified, returns a list describing all of
  110. the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
  111. information on the format of this list).  If \fIoption\fR is specified
  112. with no \fIvalue\fR, then the command returns a list describing the
  113. one named option (this list will be identical to the corresponding
  114. sublist of the value returned if no \fIoption\fR is specified).  If
  115. one or more \fIoption\-value\fR pairs are specified, then the command
  116. modifies the given widget option(s) to have the given value(s);  in
  117. this case the command returns an empty string.
  118. \fIOption\fR may have any of the values accepted by the \fBlabel\fR
  119. command.
  120.  
  121. .SH BINDINGS
  122. .PP
  123. When a new label is created, it has no default event bindings:
  124. labels are not intended to be interactive.
  125.  
  126. .SH KEYWORDS
  127. label, widget
  128.