SGI/util/SGI/man/mann/message.n

   1 '\"
   2 '\" Copyright (c) 1990-1994 The Regents of the University of California.
   3 '\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
   4 '\"
   5 '\" See the file "license.terms" for information on usage and redistribution
   6 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
   7 '\"
   8 '\" SCCS: @(#) message.n 1.32 97/10/31 12:58:50
   9 '\"
  10 '\" The definitions below are for supplemental macros used in Tcl/Tk
  11 '\" manual entries.
  12 '\"
  13 '\" .AP type name in/out ?indent?
  14 '\"     Start paragraph describing an argument to a library procedure.
  15 '\"     type is type of argument (int, etc.), in/out is either "in", "out",
  16 '\"     or "in/out" to describe whether procedure reads or modifies arg,
  17 '\"     and indent is equivalent to second arg of .IP (shouldn't ever be
  18 '\"     needed;  use .AS below instead)
  19 '\"
  20 '\" .AS ?type? ?name?
  21 '\"     Give maximum sizes of arguments for setting tab stops.  Type and
  22 '\"     name are examples of largest possible arguments that will be passed
  23 '\"     to .AP later.  If args are omitted, default tab stops are used.
  24 '\"
  25 '\" .BS
  26 '\"     Start box enclosure.  From here until next .BE, everything will be
  27 '\"     enclosed in one large box.
  28 '\"
  29 '\" .BE
  30 '\"     End of box enclosure.
  31 '\"
  32 '\" .CS
  33 '\"     Begin code excerpt.
  34 '\"
  35 '\" .CE
  36 '\"     End code excerpt.
  37 '\"
  38 '\" .VS ?version? ?br?
  39 '\"     Begin vertical sidebar, for use in marking newly-changed parts
  40 '\"     of man pages.  The first argument is ignored and used for recording
  41 '\"     the version when the .VS was added, so that the sidebars can be
  42 '\"     found and removed when they reach a certain age.  If another argument
  43 '\"     is present, then a line break is forced before starting the sidebar.
  44 '\"
  45 '\" .VE
  46 '\"     End of vertical sidebar.
  47 '\"
  48 '\" .DS
  49 '\"     Begin an indented unfilled display.
  50 '\"
  51 '\" .DE
  52 '\"     End of indented unfilled display.
  53 '\"
  54 '\" .SO
  55 '\"     Start of list of standard options for a Tk widget.  The
  56 '\"     options follow on successive lines, in four columns separated
  57 '\"     by tabs.
  58 '\"
  59 '\" .SE
  60 '\"     End of list of standard options for a Tk widget.
  61 '\"
  62 '\" .OP cmdName dbName dbClass
  63 '\"     Start of description of a specific option.  cmdName gives the
  64 '\"     option's name as specified in the class command, dbName gives
  65 '\"     the option's name in the option database, and dbClass gives
  66 '\"     the option's class in the option database.
  67 '\"
  68 '\" .UL arg1 arg2
  69 '\"     Print arg1 underlined, then print arg2 normally.
  70 '\"
  71 '\" SCCS: @(#) man.macros 1.9 97/08/22 18:50:59
  72 '\"
  73 '\"     # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
  74 .if t .wh -1.3i ^B
  75 .nr ^l \n(.l
  76 .ad b
  77 '\"     # Start an argument description
  78 .de AP
  79 .ie !"\\$4"" .TP \\$4
  80 .el \{\
  81 .   ie !"\\$2"" .TP \\n()Cu
  82 .   el          .TP 15
  83 .\}
  84 .ie !"\\$3"" \{\
  85 .ta \\n()Au \\n()Bu
  86 \&\\$1  \\fI\\$2\\fP    (\\$3)
  87 .\".b
  88 .\}
  89 .el \{\
  90 .br
  91 .ie !"\\$2"" \{\
  92 \&\\$1  \\fI\\$2\\fP
  93 .\}
  94 .el \{\
  95 \&\\fI\\$1\\fP
  96 .\}
  97 .\}
  98 ..
  99 '\"     # define tabbing values for .AP
 100 .de AS
 101 .nr )A 10n
 102 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
 103 .nr )B \\n()Au+15n
 104 .\"
 105 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
 106 .nr )C \\n()Bu+\\w'(in/out)'u+2n
 107 ..
 108 .AS Tcl_Interp Tcl_CreateInterp in/out
 109 '\"     # BS - start boxed text
 110 '\"     # ^y = starting y location
 111 '\"     # ^b = 1
 112 .de BS
 113 .br
 114 .mk ^y
 115 .nr ^b 1u
 116 .if n .nf
 117 .if n .ti 0
 118 .if n \l'\\n(.lu\(ul'
 119 .if n .fi
 120 ..
 121 '\"     # BE - end boxed text (draw box now)
 122 .de BE
 123 .nf
 124 .ti 0
 125 .mk ^t
 126 .ie n \l'\\n(^lu\(ul'
 127 .el \{\
 128 .\"     Draw four-sided box normally, but don't draw top of
 129 .\"     box if the box started on an earlier page.
 130 .ie !\\n(^b-1 \{\
 131 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 132 .\}
 133 .el \}\
 134 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 135 .\}
 136 .\}
 137 .fi
 138 .br
 139 .nr ^b 0
 140 ..
 141 '\"     # VS - start vertical sidebar
 142 '\"     # ^Y = starting y location
 143 '\"     # ^v = 1 (for troff;  for nroff this doesn't matter)
 144 .de VS
 145 .if !"\\$2"" .br
 146 .mk ^Y
 147 .ie n 'mc \s12\(br\s0
 148 .el .nr ^v 1u
 149 ..
 150 '\"     # VE - end of vertical sidebar
 151 .de VE
 152 .ie n 'mc
 153 .el \{\
 154 .ev 2
 155 .nf
 156 .ti 0
 157 .mk ^t
 158 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
 159 .sp -1
 160 .fi
 161 .ev
 162 .\}
 163 .nr ^v 0
 164 ..
 165 '\"     # Special macro to handle page bottom:  finish off current
 166 '\"     # box/sidebar if in box/sidebar mode, then invoked standard
 167 '\"     # page bottom macro.
 168 .de ^B
 169 .ev 2
 170 'ti 0
 171 'nf
 172 .mk ^t
 173 .if \\n(^b \{\
 174 .\"     Draw three-sided box if this is the box's first page,
 175 .\"     draw two sides but no top otherwise.
 176 .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
 177 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
 178 .\}
 179 .if \\n(^v \{\
 180 .nr ^x \\n(^tu+1v-\\n(^Yu
 181 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
 182 .\}
 183 .bp
 184 'fi
 185 .ev
 186 .if \\n(^b \{\
 187 .mk ^y
 188 .nr ^b 2
 189 .\}
 190 .if \\n(^v \{\
 191 .mk ^Y
 192 .\}
 193 ..
 194 '\"     # DS - begin display
 195 .de DS
 196 .RS
 197 .nf
 198 .sp
 199 ..
 200 '\"     # DE - end display
 201 .de DE
 202 .fi
 203 .RE
 204 .sp
 205 ..
 206 '\"     # SO - start of list of standard options
 207 .de SO
 208 .SH "STANDARD OPTIONS"
 209 .LP
 210 .nf
 211 .ta 4c 8c 12c
 212 .ft B
 213 ..
 214 '\"     # SE - end of list of standard options
 215 .de SE
 216 .fi
 217 .ft R
 218 .LP
 219 See the \\fBoptions\\fR manual entry for details on the standard options.
 220 ..
 221 '\"     # OP - start of full description for a single option
 222 .de OP
 223 .LP
 224 .nf
 225 .ta 4c
 226 Command-Line Name:      \\fB\\$1\\fR
 227 Database Name:  \\fB\\$2\\fR
 228 Database Class: \\fB\\$3\\fR
 229 .fi
 230 .IP
 231 ..
 232 '\"     # CS - begin code excerpt
 233 .de CS
 234 .RS
 235 .nf
 236 .ta .25i .5i .75i 1i
 237 ..
 238 '\"     # CE - end code excerpt
 239 .de CE
 240 .fi
 241 .RE
 242 ..
 243 .de UL
 244 \\$1\l'|0\(ul'\\$2
 245 ..
 246 .TH message n 4.0 Tk "Tk Built-In Commands"
 247 .BS
 248 '\" Note:  do not modify the .SH NAME line immediately below!
 249 .SH NAME
 250 message \- Create and manipulate message widgets
 251 .SH SYNOPSIS
 252 \fBmessage\fR \fIpathName \fR?\fIoptions\fR?
 253 .SO
 254 \-anchor        \-font  \-highlightthickness    \-takefocus
 255 \-background    \-foreground    \-padx  \-text
 256 \-borderwidth   \-highlightbackground   \-pady  \-textvariable
 257 \-cursor        \-highlightcolor        \-relief        \-width
 258 .SE
 259 .SH "WIDGET-SPECIFIC OPTIONS"
 260 .OP \-aspect aspect Aspect
 261 Specifies a non-negative integer value indicating desired
 262 aspect ratio for the text.  The aspect ratio is specified as
 263 100*width/height.  100 means the text should
 264 be as wide as it is tall, 200 means the text should
 265 be twice as wide as it is tall, 50 means the text should
 266 be twice as tall as it is wide, and so on.
 267 Used to choose line length for text if \fBwidth\fR option
 268 isn't specified.
 269 Defaults to 150.
 270 .OP \-justify justify Justify
 271 Specifies how to justify lines of text.
 272 Must be one of \fBleft\fR, \fBcenter\fR, or \fBright\fR.  Defaults
 273 to \fBleft\fR.
 274 This option works together with the \fBanchor\fR, \fBaspect\fR,
 275 \fBpadX\fR, \fBpadY\fR, and \fBwidth\fR options to provide a variety
 276 of arrangements of the text within the window.
 277 The \fBaspect\fR and \fBwidth\fR options determine the amount of
 278 screen space needed to display the text.
 279 The \fBanchor\fR, \fBpadX\fR, and \fBpadY\fR options determine where this
 280 rectangular area is displayed within the widget's window, and the
 281 \fBjustify\fR option determines how each line is displayed within that
 282 rectangular region.
 283 For example, suppose \fBanchor\fR is \fBe\fR and \fBjustify\fR is
 284 \fBleft\fR, and that the message window is much larger than needed
 285 for the text.
 286 The the text will displayed so that the left edges of all the lines
 287 line up and the right edge of the longest line is \fBpadX\fR from
 288 the right side of the window;  the entire text block will be centered
 289 in the vertical span of the window.
 290 .OP \-width width Width
 291 Specifies the length of lines in the window.
 292 The value may have any of the forms acceptable to \fBTk_GetPixels\fR.
 293 If this option has a value greater than zero then the \fBaspect\fR
 294 option is ignored and the \fBwidth\fR option determines the line
 295 length.
 296 If this option has a value less than or equal to zero, then
 297 the \fBaspect\fR option determines the line length.
 298 .BE
 299
 300 .SH DESCRIPTION
 301 .PP
 302 The \fBmessage\fR command creates a new window (given by the
 303 \fIpathName\fR argument) and makes it into a message widget.
 304 Additional
 305 options, described above, may be specified on the command line
 306 or in the option database
 307 to configure aspects of the message such as its colors, font,
 308 text, and initial relief.  The \fBmessage\fR command returns its
 309 \fIpathName\fR argument.  At the time this command is invoked,
 310 there must not exist a window named \fIpathName\fR, but
 311 \fIpathName\fR's parent must exist.
 312 .PP
 313 A message is a widget that displays a textual string.  A message
 314 widget has three special features.  First, it breaks up
 315 its string into lines in order to produce a given aspect ratio
 316 for the window.  The line breaks are chosen at word boundaries
 317 wherever possible (if not even a single word would fit on a
 318 line, then the word will be split across lines).  Newline characters
 319 in the string will force line breaks;  they can be used, for example,
 320 to leave blank lines in the display.
 321 .PP
 322 The second feature of a message widget is justification.  The text
 323 may be displayed left-justified (each line starts at the left side of
 324 the window), centered on a line-by-line basis, or right-justified
 325 (each line ends at the right side of the window).
 326 .PP
 327 The third feature of a message widget is that it handles control
 328 characters and non-printing characters specially.  Tab characters
 329 are replaced with enough blank space to line up on the next
 330 8-character boundary.  Newlines cause line breaks.  Other control
 331 characters (ASCII code less than 0x20) and characters not defined
 332 in the font are displayed as a four-character sequence \fB\ex\fIhh\fR where
 333 \fIhh\fR is the two-digit hexadecimal number corresponding to
 334 the character.  In the unusual case where the font doesn't contain
 335 all of the characters in ``0123456789abcdef\ex'' then control
 336 characters and undefined characters are not displayed at all.
 337
 338 .SH "WIDGET COMMAND"
 339 .PP
 340 The \fBmessage\fR command creates a new Tcl command whose
 341 name is \fIpathName\fR.  This
 342 command may be used to invoke various
 343 operations on the widget.  It has the following general form:
 344 .CS
 345 \fIpathName option \fR?\fIarg arg ...\fR?
 346 .CE
 347 \fIOption\fR and the \fIarg\fRs
 348 determine the exact behavior of the command.  The following
 349 commands are possible for message widgets:
 350 .TP
 351 \fIpathName \fBcget\fR \fIoption\fR
 352 Returns the current value of the configuration option given
 353 by \fIoption\fR.
 354 \fIOption\fR may have any of the values accepted by the \fBmessage\fR
 355 command.
 356 .TP
 357 \fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR?
 358 Query or modify the configuration options of the widget.
 359 If no \fIoption\fR is specified, returns a list describing all of
 360 the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
 361 information on the format of this list).  If \fIoption\fR is specified
 362 with no \fIvalue\fR, then the command returns a list describing the
 363 one named option (this list will be identical to the corresponding
 364 sublist of the value returned if no \fIoption\fR is specified).  If
 365 one or more \fIoption\-value\fR pairs are specified, then the command
 366 modifies the given widget option(s) to have the given value(s);  in
 367 this case the command returns an empty string.
 368 \fIOption\fR may have any of the values accepted by the \fBmessage\fR
 369 command.
 370
 371 .SH "DEFAULT BINDINGS"
 372 .PP
 373 When a new message is created, it has no default event bindings:
 374 messages are intended for output purposes only.
 375
 376 .SH BUGS
 377 .PP
 378 Tabs don't work very well with text that is centered or right-justified.
 379 The most common result is that the line is justified wrong.
 380
 381 .SH KEYWORDS
 382 message, widget