message.n
上传用户:rrhhcc
上传日期:2015-12-11
资源大小:54129k
文件大小:6k
- '"
- '" Copyright (c) 1990-1994 The Regents of the University of California.
- '" Copyright (c) 1994-1996 Sun Microsystems, Inc.
- '"
- '" See the file "license.terms" for information on usage and redistribution
- '" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
- '"
- '" RCS: @(#) $Id: message.n,v 1.3.8.1 2004/10/28 10:19:29 dkf Exp $
- '"
- .so man.macros
- .TH message n 4.0 Tk "Tk Built-In Commands"
- .BS
- '" Note: do not modify the .SH NAME line immediately below!
- .SH NAME
- message - Create and manipulate message widgets
- .SH SYNOPSIS
- fBmessagefR fIpathName fR?fIoptionsfR?
- .SO
- -anchor -highlightbackground -takefocus
- -background -highlightcolor -text
- -borderwidth -highlightthickness -textvariable
- -cursor -padx -width
- -font -pady
- -foreground -relief
- .SE
- .SH "WIDGET-SPECIFIC OPTIONS"
- .OP -aspect aspect Aspect
- Specifies a non-negative integer value indicating desired
- aspect ratio for the text. The aspect ratio is specified as
- 100*width/height. 100 means the text should
- be as wide as it is tall, 200 means the text should
- be twice as wide as it is tall, 50 means the text should
- be twice as tall as it is wide, and so on.
- Used to choose line length for text if fBwidthfR option
- isn't specified.
- Defaults to 150.
- .OP -justify justify Justify
- Specifies how to justify lines of text.
- Must be one of fBleftfR, fBcenterfR, or fBrightfR. Defaults
- to fBleftfR.
- This option works together with the fBanchorfR, fBaspectfR,
- fBpadXfR, fBpadYfR, and fBwidthfR options to provide a variety
- of arrangements of the text within the window.
- The fBaspectfR and fBwidthfR options determine the amount of
- screen space needed to display the text.
- The fBanchorfR, fBpadXfR, and fBpadYfR options determine where this
- rectangular area is displayed within the widget's window, and the
- fBjustifyfR option determines how each line is displayed within that
- rectangular region.
- For example, suppose fBanchorfR is fBefR and fBjustifyfR is
- fBleftfR, and that the message window is much larger than needed
- for the text.
- The text will be displayed so that the left edges of all the lines
- line up and the right edge of the longest line is fBpadXfR from
- the right side of the window; the entire text block will be centered
- in the vertical span of the window.
- .OP -width width Width
- Specifies the length of lines in the window.
- The value may have any of the forms acceptable to fBTk_GetPixelsfR.
- If this option has a value greater than zero then the fBaspectfR
- option is ignored and the fBwidthfR option determines the line
- length.
- If this option has a value less than or equal to zero, then
- the fBaspectfR option determines the line length.
- .BE
- .SH DESCRIPTION
- .PP
- The fBmessagefR command creates a new window (given by the
- fIpathNamefR argument) and makes it into a message widget.
- Additional
- options, described above, may be specified on the command line
- or in the option database
- to configure aspects of the message such as its colors, font,
- text, and initial relief. The fBmessagefR command returns its
- fIpathNamefR argument. At the time this command is invoked,
- there must not exist a window named fIpathNamefR, but
- fIpathNamefR's parent must exist.
- .PP
- A message is a widget that displays a textual string. A message
- widget has three special features. First, it breaks up
- its string into lines in order to produce a given aspect ratio
- for the window. The line breaks are chosen at word boundaries
- wherever possible (if not even a single word would fit on a
- line, then the word will be split across lines). Newline characters
- in the string will force line breaks; they can be used, for example,
- to leave blank lines in the display.
- .PP
- The second feature of a message widget is justification. The text
- may be displayed left-justified (each line starts at the left side of
- the window), centered on a line-by-line basis, or right-justified
- (each line ends at the right side of the window).
- .PP
- The third feature of a message widget is that it handles control
- characters and non-printing characters specially. Tab characters
- are replaced with enough blank space to line up on the next
- 8-character boundary. Newlines cause line breaks. Other control
- characters (ASCII code less than 0x20) and characters not defined
- in the font are displayed as a four-character sequence fBexfIhhfR where
- fIhhfR is the two-digit hexadecimal number corresponding to
- the character. In the unusual case where the font doesn't contain
- all of the characters in ``0123456789abcdefex'' then control
- characters and undefined characters are not displayed at all.
- .SH "WIDGET COMMAND"
- .PP
- The fBmessagefR command creates a new Tcl command whose
- name is fIpathNamefR. This
- command may be used to invoke various
- operations on the widget. It has the following general form:
- .CS
- fIpathName option fR?fIarg arg ...fR?
- .CE
- fIOptionfR and the fIargfRs
- determine the exact behavior of the command. The following
- commands are possible for message widgets:
- .TP
- fIpathName fBcgetfR fIoptionfR
- Returns the current value of the configuration option given
- by fIoptionfR.
- fIOptionfR may have any of the values accepted by the fBmessagefR
- command.
- .TP
- fIpathName fBconfigurefR ?fIoptionfR? ?fIvalue option value ...fR?
- Query or modify the configuration options of the widget.
- If no fIoptionfR is specified, returns a list describing all of
- the available options for fIpathNamefR (see fBTk_ConfigureInfofR for
- information on the format of this list). If fIoptionfR is specified
- with no fIvaluefR, then the command returns a list describing the
- one named option (this list will be identical to the corresponding
- sublist of the value returned if no fIoptionfR is specified). If
- one or more fIoption-valuefR pairs are specified, then the command
- modifies the given widget option(s) to have the given value(s); in
- this case the command returns an empty string.
- fIOptionfR may have any of the values accepted by the fBmessagefR
- command.
- .SH "DEFAULT BINDINGS"
- .PP
- When a new message is created, it has no default event bindings:
- messages are intended for output purposes only.
- .SH BUGS
- .PP
- Tabs don't work very well with text that is centered or right-justified.
- The most common result is that the line is justified wrong.
- .SH KEYWORDS
- message, widget