Initial commit of OpenSPARC T2 design and verification files.
[OpenSPARC-T2-DV] / tools / perl-5.8.0 / man / man3 / Tk::Mwm.3
.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. | will give a
.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.\"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "MWM 1"
.TH MWM 1 "2000-12-30" "perl v5.8.0" "User Contributed Perl Documentation"
.SH "NAME"
Tk::Mwm \- Communicate with the Motif(tm) window manager.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\ \fBuse Tk::Mwm;\fR
.PP
\&\ \fI$toplevel\fR\->\fBmwm\fR\fIOption\fR?(\fIargs\fR)?
.PP
\&\ \fI$toplevel\fR\->\fBmwm\fR(\fIoption\fR ?,\fIargs\fR?)
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Interface to special extentions supported by mwm.
.SH "METHODS"
.IX Header "METHODS"
.IP "\fI$toplevel\fR\->\fBmwmDecoration\fR?(?option??=>value? ?,...?)?" 4
.IX Item "$toplevel->mwmDecoration?(?option??=>value? ?,...?)?"
When no options are given, this method returns the values of all the
decorations options for the toplevel window with the \fI$toplevel\fR.
When only one option is given without specifying the value, the
current value of that option is returned.
When more than one \*(L"option\-value\*(R" pairs are passed to this method,
the specified values will be assigned to the corresponding options. As
a result, the appearance of the Motif decorations around the toplevel
window will be changed.
Possible options are: \fB\-border\fR, \fB\-menu\fR, \fB\-maximize\fR,
\&\fB\-minimize\fR, \fB\-resizeh\fR and \fB\-title\fR. The value must be a
Boolean value. The values returned by this command are undefined when
the window is not managed by mwm.
.IP "\fI$toplevel\fR\->\fBmwmIsmwmrunning\fR" 4
.IX Item "$toplevel->mwmIsmwmrunning"
This returns value is true if mwm is running on the screen where the specified
window is located, false otherwise.
.IP "\fI$toplevel\fR\->\fBmwmProtocol\fR" 4
.IX Item "$toplevel->mwmProtocol"
When no additional options are given, this method returns all
protocols associated with this toplevel window.
.IP "\fI$toplevel\fR\->\fBmwmProtocol\fR(\fBactivate\fR => \fIprotocol_name\fR)" 4
.IX Item "$toplevel->mwmProtocol(activate => protocol_name)"
Activate the mwm protocol message in mwm's menu.
.IP "\fI$toplevel\fR\->\fBMwmProtocol\fR(\fBadd\fR => \fIprotocol_name\fR, \fImenu_message\fR)" 4
.IX Item "$toplevel->MwmProtocol(add => protocol_name, menu_message)"
Add a new mwm protocol message for this toplevel window. The
message is identified by the string name specified in
\&\fIprotocol_name\fR. A menu item will be added into mwm's menu as
specified by \fImenu_message\fR. Once a new mwm protocol message is
added to a toplevel, it can be caught by the \s-1TK\s0 \fBprotocol\fR
method. Here is an example:
.Sp
\&\ \fI$toplevel\fR\->\fBmwmProtocol\fR(\fB'add'\fR => '\s-1MY_PRINT_HELLO\s0', '\*(L"Print Hello\*(R" _H Ctrl<Key>H');
.Sp
\&\ \fI$toplevel\fR\->\fBprotocol\fR(\fB'\s-1MY_PRINT_HELLO\s0'\fR => sub {print \*(L"Hello\*(R"});
.IP "\fI$toplevel\fR\->\fBmwmProtocol\fR(\fB'deactivate'\fR => \fIprotocol_name\fR)" 4
.IX Item "$toplevel->mwmProtocol('deactivate' => protocol_name)"
Deactivate the mwm protocol message in mwm's menu.
.IP "\fI$toplevel\fR\->\fBmwmProtocol\fR(\fB'delete'\fR => \fIprotocol_name\fR)" 4
.IX Item "$toplevel->mwmProtocol('delete' => protocol_name)"
Delete the mwm protocol message from mwm's menu. Please note that the
window manager protocol handler associated with this protocol (by the
\&\fBprotocol\fR method) is not deleted automatically. You have to
delete the protocol handle explicitly. E.g.:
.Sp
\&\ \fI$mw\fR\->\fBmwmProtocol\fR(\fB'delete'\fR => '\s-1MY_PRINT_HELLO\s0');
.Sp
\&\ \fI$mw\fR\->\fBprotocol\fR(\fB'\s-1MY_PRINT_HELLO\s0'\fR => '');
.SH "BUGS"
.IX Header "BUGS"
This is a Tix extension which perl/Tk has adopted. It has not been
tested as perl/Tk's author has not got round to installing a Motif Window
Manager.
.PP
On some versions of mwm, the \fB\-border\fR will not disappear unless
\&\fB\-resizeh\fR is turned off. Also, the \fB\-title\fR will not disappear
unless all of \fB\-title\fR, \fB\-menu\fR, \fB\-maximize\fR and
\&\fB\-minimize\fR are turned off.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Tk::Wm
Tk::tixWm
Tk::Toplevel
.SH "KEYWORDS"
.IX Header "KEYWORDS"
window manager, mwm, \s-1TIX\s0
.SH "AUTHOR"
.IX Header "AUTHOR"
Ioi Kim Lam \- ioi@graphics.cis.upenn.edu