Commit | Line | Data |
---|---|---|
920dae64 AT |
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 | '\" RCS: @(#) $Id: message.n,v 1.3.8.1 2004/10/28 10:19:29 dkf Exp $ | |
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 | '\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $ | |
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 | .ta \\n()Au \\n()Bu | |
85 | .ie !"\\$3"" \{\ | |
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 5.5c 11c | |
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 \-highlightbackground \-takefocus | |
255 | \-background \-highlightcolor \-text | |
256 | \-borderwidth \-highlightthickness \-textvariable | |
257 | \-cursor \-padx \-width | |
258 | \-font \-pady | |
259 | \-foreground \-relief | |
260 | .SE | |
261 | .SH "WIDGET-SPECIFIC OPTIONS" | |
262 | .OP \-aspect aspect Aspect | |
263 | Specifies a non-negative integer value indicating desired | |
264 | aspect ratio for the text. The aspect ratio is specified as | |
265 | 100*width/height. 100 means the text should | |
266 | be as wide as it is tall, 200 means the text should | |
267 | be twice as wide as it is tall, 50 means the text should | |
268 | be twice as tall as it is wide, and so on. | |
269 | Used to choose line length for text if \fBwidth\fR option | |
270 | isn't specified. | |
271 | Defaults to 150. | |
272 | .OP \-justify justify Justify | |
273 | Specifies how to justify lines of text. | |
274 | Must be one of \fBleft\fR, \fBcenter\fR, or \fBright\fR. Defaults | |
275 | to \fBleft\fR. | |
276 | This option works together with the \fBanchor\fR, \fBaspect\fR, | |
277 | \fBpadX\fR, \fBpadY\fR, and \fBwidth\fR options to provide a variety | |
278 | of arrangements of the text within the window. | |
279 | The \fBaspect\fR and \fBwidth\fR options determine the amount of | |
280 | screen space needed to display the text. | |
281 | The \fBanchor\fR, \fBpadX\fR, and \fBpadY\fR options determine where this | |
282 | rectangular area is displayed within the widget's window, and the | |
283 | \fBjustify\fR option determines how each line is displayed within that | |
284 | rectangular region. | |
285 | For example, suppose \fBanchor\fR is \fBe\fR and \fBjustify\fR is | |
286 | \fBleft\fR, and that the message window is much larger than needed | |
287 | for the text. | |
288 | The text will be displayed so that the left edges of all the lines | |
289 | line up and the right edge of the longest line is \fBpadX\fR from | |
290 | the right side of the window; the entire text block will be centered | |
291 | in the vertical span of the window. | |
292 | .OP \-width width Width | |
293 | Specifies the length of lines in the window. | |
294 | The value may have any of the forms acceptable to \fBTk_GetPixels\fR. | |
295 | If this option has a value greater than zero then the \fBaspect\fR | |
296 | option is ignored and the \fBwidth\fR option determines the line | |
297 | length. | |
298 | If this option has a value less than or equal to zero, then | |
299 | the \fBaspect\fR option determines the line length. | |
300 | .BE | |
301 | ||
302 | .SH DESCRIPTION | |
303 | .PP | |
304 | The \fBmessage\fR command creates a new window (given by the | |
305 | \fIpathName\fR argument) and makes it into a message widget. | |
306 | Additional | |
307 | options, described above, may be specified on the command line | |
308 | or in the option database | |
309 | to configure aspects of the message such as its colors, font, | |
310 | text, and initial relief. The \fBmessage\fR command returns its | |
311 | \fIpathName\fR argument. At the time this command is invoked, | |
312 | there must not exist a window named \fIpathName\fR, but | |
313 | \fIpathName\fR's parent must exist. | |
314 | .PP | |
315 | A message is a widget that displays a textual string. A message | |
316 | widget has three special features. First, it breaks up | |
317 | its string into lines in order to produce a given aspect ratio | |
318 | for the window. The line breaks are chosen at word boundaries | |
319 | wherever possible (if not even a single word would fit on a | |
320 | line, then the word will be split across lines). Newline characters | |
321 | in the string will force line breaks; they can be used, for example, | |
322 | to leave blank lines in the display. | |
323 | .PP | |
324 | The second feature of a message widget is justification. The text | |
325 | may be displayed left-justified (each line starts at the left side of | |
326 | the window), centered on a line-by-line basis, or right-justified | |
327 | (each line ends at the right side of the window). | |
328 | .PP | |
329 | The third feature of a message widget is that it handles control | |
330 | characters and non-printing characters specially. Tab characters | |
331 | are replaced with enough blank space to line up on the next | |
332 | 8-character boundary. Newlines cause line breaks. Other control | |
333 | characters (ASCII code less than 0x20) and characters not defined | |
334 | in the font are displayed as a four-character sequence \fB\ex\fIhh\fR where | |
335 | \fIhh\fR is the two-digit hexadecimal number corresponding to | |
336 | the character. In the unusual case where the font doesn't contain | |
337 | all of the characters in ``0123456789abcdef\ex'' then control | |
338 | characters and undefined characters are not displayed at all. | |
339 | ||
340 | .SH "WIDGET COMMAND" | |
341 | .PP | |
342 | The \fBmessage\fR command creates a new Tcl command whose | |
343 | name is \fIpathName\fR. This | |
344 | command may be used to invoke various | |
345 | operations on the widget. It has the following general form: | |
346 | .CS | |
347 | \fIpathName option \fR?\fIarg arg ...\fR? | |
348 | .CE | |
349 | \fIOption\fR and the \fIarg\fRs | |
350 | determine the exact behavior of the command. The following | |
351 | commands are possible for message widgets: | |
352 | .TP | |
353 | \fIpathName \fBcget\fR \fIoption\fR | |
354 | Returns the current value of the configuration option given | |
355 | by \fIoption\fR. | |
356 | \fIOption\fR may have any of the values accepted by the \fBmessage\fR | |
357 | command. | |
358 | .TP | |
359 | \fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR? | |
360 | Query or modify the configuration options of the widget. | |
361 | If no \fIoption\fR is specified, returns a list describing all of | |
362 | the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for | |
363 | information on the format of this list). If \fIoption\fR is specified | |
364 | with no \fIvalue\fR, then the command returns a list describing the | |
365 | one named option (this list will be identical to the corresponding | |
366 | sublist of the value returned if no \fIoption\fR is specified). If | |
367 | one or more \fIoption\-value\fR pairs are specified, then the command | |
368 | modifies the given widget option(s) to have the given value(s); in | |
369 | this case the command returns an empty string. | |
370 | \fIOption\fR may have any of the values accepted by the \fBmessage\fR | |
371 | command. | |
372 | ||
373 | .SH "DEFAULT BINDINGS" | |
374 | .PP | |
375 | When a new message is created, it has no default event bindings: | |
376 | messages are intended for output purposes only. | |
377 | ||
378 | .SH BUGS | |
379 | .PP | |
380 | Tabs don't work very well with text that is centered or right-justified. | |
381 | The most common result is that the line is justified wrong. | |
382 | ||
383 | .SH KEYWORDS | |
384 | message, widget |