197 lines
10 KiB
HTML
197 lines
10 KiB
HTML
<HTML><HEAD><TITLE>Tk Built-In Commands - message manual page</TITLE></HEAD><BODY>
|
|
<DL>
|
|
<DD><A HREF="message.htm#M2" NAME="L791">NAME</A>
|
|
<DL><DD>message - Create and manipulate message widgets</DL>
|
|
<DD><A HREF="message.htm#M3" NAME="L792">SYNOPSIS</A>
|
|
<DL>
|
|
<DD><B>message</B> <I>pathName </I>?<I>options</I>?
|
|
</DL>
|
|
<DD><A HREF="message.htm#M4" NAME="L793">STANDARD OPTIONS</A>
|
|
<DL>
|
|
<DD><A HREF="options.htm#M-anchor">-anchor, anchor, Anchor</A>
|
|
<DD><A HREF="options.htm#M-background">-background or -bg, background, Background</A>
|
|
<DD><A HREF="options.htm#M-borderwidth">-borderwidth or -bd, borderWidth, BorderWidth</A>
|
|
<DD><A HREF="options.htm#M-cursor">-cursor, cursor, Cursor</A>
|
|
<DD><A HREF="options.htm#M-font">-font, font, Font</A>
|
|
<DD><A HREF="options.htm#M-foreground">-foreground or -fg, foreground, Foreground</A>
|
|
<DD><A HREF="options.htm#M-highlightbackground">-highlightbackground, highlightBackground, HighlightBackground</A>
|
|
<DD><A HREF="options.htm#M-highlightcolor">-highlightcolor, highlightColor, HighlightColor</A>
|
|
<DD><A HREF="options.htm#M-highlightthickness">-highlightthickness, highlightThickness, HighlightThickness</A>
|
|
<DD><A HREF="options.htm#M-padx">-padx, padX, Pad</A>
|
|
<DD><A HREF="options.htm#M-pady">-pady, padY, Pad</A>
|
|
<DD><A HREF="options.htm#M-relief">-relief, relief, Relief</A>
|
|
<DD><A HREF="options.htm#M-takefocus">-takefocus, takeFocus, TakeFocus</A>
|
|
<DD><A HREF="options.htm#M-text">-text, text, Text</A>
|
|
<DD><A HREF="options.htm#M-textvariable">-textvariable, textVariable, Variable</A>
|
|
<DD><A HREF="options.htm#M-width">-width</A>
|
|
</DL>
|
|
<DD><A HREF="message.htm#M6" NAME="L795">WIDGET-SPECIFIC OPTIONS</A>
|
|
<DL>
|
|
<DD><A HREF="message.htm#M7" NAME="L796">-aspect, aspect, Aspect</A>
|
|
<DD><A HREF="message.htm#M8" NAME="L797">-justify, justify, Justify</A>
|
|
<DD><A HREF="message.htm#M9" NAME="L798">-width, width, Width</A>
|
|
</DL>
|
|
<DD><A HREF="message.htm#M10" NAME="L799">DESCRIPTION</A>
|
|
<DD><A HREF="message.htm#M11" NAME="L800">WIDGET COMMAND</A>
|
|
<DL>
|
|
<DD><A HREF="message.htm#M12" NAME="L801"><I>pathName </I><B>cget</B> <I>option</I></A>
|
|
<DD><A HREF="message.htm#M13" NAME="L802"><I>pathName </I><B>configure</B> ?<I>option</I>? ?<I>value option value ...</I>?</A>
|
|
</DL>
|
|
<DD><A HREF="message.htm#M14" NAME="L803">DEFAULT BINDINGS</A>
|
|
<DD><A HREF="message.htm#M15" NAME="L804">BUGS</A>
|
|
<DD><A HREF="message.htm#M16" NAME="L805">KEYWORDS</A>
|
|
</DL><HR>
|
|
<H3><A NAME="M2">NAME</A></H3>
|
|
message - Create and manipulate message widgets
|
|
<H3><A NAME="M3">SYNOPSIS</A></H3>
|
|
<B>message</B> <I>pathName </I>?<I>options</I>?<BR>
|
|
<H3><A NAME="M4">STANDARD OPTIONS</A></H3>
|
|
<DL>
|
|
<DT><B><A HREF="options.htm#M-anchor">-anchor, anchor, Anchor</A></B>
|
|
<DT><B><A HREF="options.htm#M-background">-background or -bg, background, Background</A></B>
|
|
<DT><B><A HREF="options.htm#M-borderwidth">-borderwidth or -bd, borderWidth, BorderWidth</A></B>
|
|
<DT><B><A HREF="options.htm#M-cursor">-cursor, cursor, Cursor</A></B>
|
|
<DT><B><A HREF="options.htm#M-font">-font, font, Font</A></B>
|
|
<DT><B><A HREF="options.htm#M-foreground">-foreground or -fg, foreground, Foreground</A></B>
|
|
<DT><B><A HREF="options.htm#M-highlightbackground">-highlightbackground, highlightBackground, HighlightBackground</A></B>
|
|
<DT><B><A HREF="options.htm#M-highlightcolor">-highlightcolor, highlightColor, HighlightColor</A></B>
|
|
<DT><B><A HREF="options.htm#M-highlightthickness">-highlightthickness, highlightThickness, HighlightThickness</A></B>
|
|
<DT><B><A HREF="options.htm#M-padx">-padx, padX, Pad</A></B>
|
|
<DT><B><A HREF="options.htm#M-pady">-pady, padY, Pad</A></B>
|
|
<DT><B><A HREF="options.htm#M-relief">-relief, relief, Relief</A></B>
|
|
<DT><B><A HREF="options.htm#M-takefocus">-takefocus, takeFocus, TakeFocus</A></B>
|
|
<DT><B><A HREF="options.htm#M-text">-text, text, Text</A></B>
|
|
<DT><B><A HREF="options.htm#M-textvariable">-textvariable, textVariable, Variable</A></B>
|
|
<DT><B><A HREF="options.htm#M-width">-width</A></B>
|
|
</DL>
|
|
<H3><A NAME="M6">WIDGET-SPECIFIC OPTIONS</A></H3>
|
|
<DL>
|
|
<DT>Command-Line Name: <B><A NAME="M7">-aspect</A></B>
|
|
<DT>Database Name: <B>aspect</B>
|
|
<DT>Database Class: <B>Aspect</B>
|
|
<DD>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 <B>width</B> option
|
|
isn't specified.
|
|
Defaults to 150.
|
|
<P><DT>Command-Line Name: <B><A NAME="M8">-justify</A></B>
|
|
<DT>Database Name: <B>justify</B>
|
|
<DT>Database Class: <B>Justify</B>
|
|
<DD>Specifies how to justify lines of text.
|
|
Must be one of <B>left</B>, <B>center</B>, or <B>right</B>. Defaults
|
|
to <B>left</B>.
|
|
This option works together with the <B>anchor</B>, <B>aspect</B>,
|
|
<B>padX</B>, <B>padY</B>, and <B>width</B> options to provide a variety
|
|
of arrangements of the text within the window.
|
|
The <B>aspect</B> and <B>width</B> options determine the amount of
|
|
screen space needed to display the text.
|
|
The <B>anchor</B>, <B>padX</B>, and <B>padY</B> options determine where this
|
|
rectangular area is displayed within the widget's window, and the
|
|
<B>justify</B> option determines how each line is displayed within that
|
|
rectangular region.
|
|
For example, suppose <B>anchor</B> is <B>e</B> and <B>justify</B> is
|
|
<B>left</B>, and that the message window is much larger than needed
|
|
for the text.
|
|
The the text will displayed so that the left edges of all the lines
|
|
line up and the right edge of the longest line is <B>padX</B> from
|
|
the right side of the window; the entire text block will be centered
|
|
in the vertical span of the window.
|
|
<P><DT>Command-Line Name: <B><A NAME="M9">-width</A></B>
|
|
<DT>Database Name: <B>width</B>
|
|
<DT>Database Class: <B>Width</B>
|
|
<DD>Specifies the length of lines in the window.
|
|
The value may have any of the forms acceptable to <B><A HREF="../TclLib/GetPixels.htm">Tk_GetPixels</A></B>.
|
|
If this option has a value greater than zero then the <B>aspect</B>
|
|
option is ignored and the <B>width</B> option determines the line
|
|
length.
|
|
If this option has a value less than or equal to zero, then
|
|
the <B>aspect</B> option determines the line length.
|
|
</DL>
|
|
<H3><A NAME="M10">DESCRIPTION</A></H3>
|
|
The <B>message</B> command creates a new window (given by the
|
|
<I>pathName</I> 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 <B>message</B> command returns its
|
|
<I>pathName</I> argument. At the time this command is invoked,
|
|
there must not exist a window named <I>pathName</I>, but
|
|
<I>pathName</I>'s parent must exist.
|
|
<P>
|
|
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.
|
|
<P>
|
|
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).
|
|
<P>
|
|
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 <B>\x</B><I>hh</I> where
|
|
<I>hh</I> 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 ``0123456789abcdef\x'' then control
|
|
characters and undefined characters are not displayed at all.
|
|
|
|
<H3><A NAME="M11">WIDGET COMMAND</A></H3>
|
|
The <B>message</B> command creates a new Tcl command whose
|
|
name is <I>pathName</I>. This
|
|
command may be used to invoke various
|
|
operations on the widget. It has the following general form:
|
|
<PRE><I>pathName option </I>?<I>arg arg ...</I>?</PRE>
|
|
<I>Option</I> and the <I>arg</I>s
|
|
determine the exact behavior of the command. The following
|
|
commands are possible for message widgets:
|
|
<P>
|
|
<DL>
|
|
<P><DT><A NAME="M12"><I>pathName </I><B>cget</B> <I>option</I></A><DD>
|
|
Returns the current value of the configuration option given
|
|
by <I>option</I>.
|
|
<I>Option</I> may have any of the values accepted by the <B>message</B>
|
|
command.
|
|
<P><DT><A NAME="M13"><I>pathName </I><B>configure</B> ?<I>option</I>? ?<I>value option value ...</I>?</A><DD>
|
|
Query or modify the configuration options of the widget.
|
|
If no <I>option</I> is specified, returns a list describing all of
|
|
the available options for <I>pathName</I> (see <B><A HREF="../TclLib/ConfigWidg.htm">Tk_ConfigureInfo</A></B> for
|
|
information on the format of this list). If <I>option</I> is specified
|
|
with no <I>value</I>, 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 <I>option</I> is specified). If
|
|
one or more <I>option-value</I> 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.
|
|
<I>Option</I> may have any of the values accepted by the <B>message</B>
|
|
command.
|
|
|
|
<P></DL>
|
|
<H3><A NAME="M14">DEFAULT BINDINGS</A></H3>
|
|
When a new message is created, it has no default event bindings:
|
|
messages are intended for output purposes only.
|
|
|
|
<H3><A NAME="M15">BUGS</A></H3>
|
|
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.
|
|
|
|
<H3><A NAME="M16">KEYWORDS</A></H3>
|
|
<A href="../Keywords/M.htm#message">message</A>, <A href="../Keywords/W.htm#widget">widget</A>
|
|
<HR><PRE>
|
|
<A HREF="../copyright.htm">Copyright</A> © 1990-1994 The Regents of the University of California.
|
|
<A HREF="../copyright.htm">Copyright</A> © 1994-1996 Sun Microsystems, Inc.
|
|
<A HREF="../copyright.htm">Copyright</A> © 1995-1997 Roger E. Critchlow Jr.</PRE>
|
|
</BODY></HTML>
|