158 lines
8.0 KiB
HTML
158 lines
8.0 KiB
HTML
<HTML><HEAD><TITLE>Tk Built-In Commands - message manual page</TITLE></HEAD>
|
|
<BR>
|
|
<BODY bgcolor = #c3c3ff>
|
|
<H2><IMG ALIGN=BOTTOM SRC="./Img/ManPageBlue.gif"> message</H2>
|
|
<I>Create and manipulate message widgets</I><P><IMG ALIGN=TOP SRC="./Img/line-red.gif">
|
|
<H3><A NAME="M2">SYNOPSIS</A></H3>
|
|
(<B>message</B><I> widget-name </I>?<I>options</I>?)<BR>
|
|
<H3><A NAME="M3">STANDARD OPTIONS</A></H3>
|
|
<PRE>
|
|
<B><A HREF="options.n.html#M:anchor">:anchor</A></B> <B><A HREF="options.n.html#M:background">:background</A></B>
|
|
<B><A HREF="options.n.html#M:borderwidth">:borderwidth</A></B> <B><A HREF="options.n.html#M:cursor">:cursor</A></B>
|
|
<B><A HREF="options.n.html#M:font">:font</A></B> <B><A HREF="options.n.html#M:foreground">:foreground</A></B>
|
|
<B><A HREF="options.n.html#M:highlightbackground">:highlightbackground</A></B> <B><A HREF="options.n.html#M:highlightcolor">:highlightcolor</A></B>
|
|
<B><A HREF="options.n.html#M:highlightthickness">:highlightthickness</A></B> <B><A HREF="options.n.html#M:padx">:padx</A></B>
|
|
<B><A HREF="options.n.html#M:pady">:pady</A></B> <B><A HREF="options.n.html#M:relief">:relief</A></B>
|
|
<B><A HREF="options.n.html#M:takefocus">:takefocus</A></B> <B><A HREF="options.n.html#M:text">:text</A></B>
|
|
<B><A HREF="options.n.html#M:textvariable">:textvariable</A></B> <B><A HREF="options.n.html#M:width">:width</A></B>
|
|
</PRE>
|
|
<H3><A NAME="M20">WIDGET-SPECIFIC OPTIONS</A></H3>
|
|
<DL>
|
|
<P>
|
|
<DT><I>Name</I>: <B>aspect</B>
|
|
<DT><I>Class</I>: <B>Aspect</B>
|
|
<DT><I>Option keyword</I>: <B><A NAME="M21">:aspect</A></B>
|
|
<DT><I>STklos slot name</I>: <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>
|
|
<P>
|
|
<DT><I>Name</I>: <B>justify</B>
|
|
<DT><I>Class</I>: <B>Justify</B>
|
|
<DT><I>Option keyword</I>: <B><A NAME="M22">:justify</A></B>
|
|
<DT><I>STklos slot name</I>: <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>
|
|
<P>
|
|
<DT><I>Name</I>: <B>width</B>
|
|
<DT><I>Class</I>: <B>Width</B>
|
|
<DT><I>Option keyword</I>: <B><A NAME="M23">:width</A></B>
|
|
<DT><I>STklos slot name</I>: <B>width</B>
|
|
<DD>Specifies the length of lines in the window.
|
|
The value may have any of the forms acceptable to <B>Tk_GetPixels</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.
|
|
<P>
|
|
</DL>
|
|
<H3><A NAME="M24">DESCRIPTION</A></H3>
|
|
The <B>message</B> procedure creates a new window (given by the
|
|
<I>widget-name</I> argument) and makes it into a message widget.
|
|
Additional
|
|
options, described above, may be specified on the procedure 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> procedure returns its
|
|
<I>widget-name</I> argument. At the time this procedure is invoked,
|
|
there must not exist a window named <I>widget-name</I>, but
|
|
<I>widget-name</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="M25">WIDGET PROCEDURE</A></H3>
|
|
The <B>message</B> procedure creates a new STk procedure whose
|
|
name is <I>widget-name</I>. This
|
|
procedure may be used to invoke various
|
|
operations on the widget. It has the following general form:
|
|
<PRE>(<I>widget-name option </I>?<I>arg arg ...</I>?)</PRE>
|
|
<I>Option</I> and the <I>arg</I>s
|
|
determine the exact behavior of the procedure. The following
|
|
procedures are possible for message widgets:
|
|
<P>
|
|
<DL>
|
|
<DT><A NAME="M26">(<I>widget-name '</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>
|
|
procedure.
|
|
<P>
|
|
<DT><A NAME="M27">(<I>widget-name '</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>widget-name</I> (see <B>Tk_ConfigureInfo</B> for
|
|
information on the format of this list). If <I>option</I> is specified
|
|
with no <I>value</I>, then the procedure 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 procedure
|
|
modifies the given widget option(s) to have the given value(s); in
|
|
this case the procedure returns an empty string.
|
|
<I>Option</I> may have any of the values accepted by the <B>message</B>
|
|
procedure.
|
|
|
|
<P>
|
|
</DL>
|
|
<H3><A NAME="M28">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="M29">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="M30">KEYWORDS</A></H3>
|
|
message, widget
|
|
<P><IMG ALIGN=TOP SRC="./Img/line-red.gif"><P>
|
|
<A HREF=./STk-hlp.html><IMG ALIGN=BOTTOM SRC="./Img/RefBookBlue.gif"> Back to the <B>STk</B> main page</A>
|
|
</BODY></HTML>
|