Initial commit of OpenSPARC T2 design and verification files.
[OpenSPARC-T2-DV] / tools / perl-5.8.0 / man / man3 / Tk::Mwm.3
CommitLineData
86530b38
AT
1.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sh \" Subsection heading
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
13.de Sp \" Vertical space (when we can't use .PP)
14.if t .sp .5v
15.if n .sp
16..
17.de Vb \" Begin verbatim text
18.ft CW
19.nf
20.ne \\$1
21..
22.de Ve \" End verbatim text
23.ft R
24.fi
25..
26.\" Set up some character translations and predefined strings. \*(-- will
27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28.\" double quote, and \*(R" will give a right double quote. | will give a
29.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31.\" expand to `' in nroff, nothing in troff, for use with C<>.
32.tr \(*W-|\(bv\*(Tr
33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34.ie n \{\
35. ds -- \(*W-
36. ds PI pi
37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
39. ds L" ""
40. ds R" ""
41. ds C` ""
42. ds C' ""
43'br\}
44.el\{\
45. ds -- \|\(em\|
46. ds PI \(*p
47. ds L" ``
48. ds R" ''
49'br\}
50.\"
51.\" If the F register is turned on, we'll generate index entries on stderr for
52.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53.\" entries marked with X<> in POD. Of course, you'll have to process the
54.\" output yourself in some meaningful fashion.
55.if \nF \{\
56. de IX
57. tm Index:\\$1\t\\n%\t"\\$2"
58..
59. nr % 0
60. rr F
61.\}
62.\"
63.\" For nroff, turn off justification. Always turn off hyphenation; it makes
64.\" way too many mistakes in technical documents.
65.hy 0
66.if n .na
67.\"
68.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69.\" Fear. Run. Save yourself. No user-serviceable parts.
70. \" fudge factors for nroff and troff
71.if n \{\
72. ds #H 0
73. ds #V .8m
74. ds #F .3m
75. ds #[ \f1
76. ds #] \fP
77.\}
78.if t \{\
79. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80. ds #V .6m
81. ds #F 0
82. ds #[ \&
83. ds #] \&
84.\}
85. \" simple accents for nroff and troff
86.if n \{\
87. ds ' \&
88. ds ` \&
89. ds ^ \&
90. ds , \&
91. ds ~ ~
92. ds /
93.\}
94.if t \{\
95. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
101.\}
102. \" troff and (daisy-wheel) nroff accents
103.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110.ds ae a\h'-(\w'a'u*4/10)'e
111.ds Ae A\h'-(\w'A'u*4/10)'E
112. \" corrections for vroff
113.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115. \" for low resolution devices (crt and lpr)
116.if \n(.H>23 .if \n(.V>19 \
117\{\
118. ds : e
119. ds 8 ss
120. ds o a
121. ds d- d\h'-1'\(ga
122. ds D- D\h'-1'\(hy
123. ds th \o'bp'
124. ds Th \o'LP'
125. ds ae ae
126. ds Ae AE
127.\}
128.rm #[ #] #H #V #F C
129.\" ========================================================================
130.\"
131.IX Title "MWM 1"
132.TH MWM 1 "2000-12-30" "perl v5.8.0" "User Contributed Perl Documentation"
133.SH "NAME"
134Tk::Mwm \- Communicate with the Motif(tm) window manager.
135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS"
137\&\ \fBuse Tk::Mwm;\fR
138.PP
139\&\ \fI$toplevel\fR\->\fBmwm\fR\fIOption\fR?(\fIargs\fR)?
140.PP
141\&\ \fI$toplevel\fR\->\fBmwm\fR(\fIoption\fR ?,\fIargs\fR?)
142.SH "DESCRIPTION"
143.IX Header "DESCRIPTION"
144Interface to special extentions supported by mwm.
145.SH "METHODS"
146.IX Header "METHODS"
147.IP "\fI$toplevel\fR\->\fBmwmDecoration\fR?(?option??=>value? ?,...?)?" 4
148.IX Item "$toplevel->mwmDecoration?(?option??=>value? ?,...?)?"
149When no options are given, this method returns the values of all the
150decorations options for the toplevel window with the \fI$toplevel\fR.
151When only one option is given without specifying the value, the
152current value of that option is returned.
153When more than one \*(L"option\-value\*(R" pairs are passed to this method,
154the specified values will be assigned to the corresponding options. As
155a result, the appearance of the Motif decorations around the toplevel
156window will be changed.
157Possible options are: \fB\-border\fR, \fB\-menu\fR, \fB\-maximize\fR,
158\&\fB\-minimize\fR, \fB\-resizeh\fR and \fB\-title\fR. The value must be a
159Boolean value. The values returned by this command are undefined when
160the window is not managed by mwm.
161.IP "\fI$toplevel\fR\->\fBmwmIsmwmrunning\fR" 4
162.IX Item "$toplevel->mwmIsmwmrunning"
163This returns value is true if mwm is running on the screen where the specified
164window is located, false otherwise.
165.IP "\fI$toplevel\fR\->\fBmwmProtocol\fR" 4
166.IX Item "$toplevel->mwmProtocol"
167When no additional options are given, this method returns all
168protocols associated with this toplevel window.
169.IP "\fI$toplevel\fR\->\fBmwmProtocol\fR(\fBactivate\fR => \fIprotocol_name\fR)" 4
170.IX Item "$toplevel->mwmProtocol(activate => protocol_name)"
171Activate the mwm protocol message in mwm's menu.
172.IP "\fI$toplevel\fR\->\fBMwmProtocol\fR(\fBadd\fR => \fIprotocol_name\fR, \fImenu_message\fR)" 4
173.IX Item "$toplevel->MwmProtocol(add => protocol_name, menu_message)"
174Add a new mwm protocol message for this toplevel window. The
175message is identified by the string name specified in
176\&\fIprotocol_name\fR. A menu item will be added into mwm's menu as
177specified by \fImenu_message\fR. Once a new mwm protocol message is
178added to a toplevel, it can be caught by the \s-1TK\s0 \fBprotocol\fR
179method. Here is an example:
180.Sp
181\&\ \fI$toplevel\fR\->\fBmwmProtocol\fR(\fB'add'\fR => '\s-1MY_PRINT_HELLO\s0', '\*(L"Print Hello\*(R" _H Ctrl<Key>H');
182.Sp
183\&\ \fI$toplevel\fR\->\fBprotocol\fR(\fB'\s-1MY_PRINT_HELLO\s0'\fR => sub {print \*(L"Hello\*(R"});
184.IP "\fI$toplevel\fR\->\fBmwmProtocol\fR(\fB'deactivate'\fR => \fIprotocol_name\fR)" 4
185.IX Item "$toplevel->mwmProtocol('deactivate' => protocol_name)"
186Deactivate the mwm protocol message in mwm's menu.
187.IP "\fI$toplevel\fR\->\fBmwmProtocol\fR(\fB'delete'\fR => \fIprotocol_name\fR)" 4
188.IX Item "$toplevel->mwmProtocol('delete' => protocol_name)"
189Delete the mwm protocol message from mwm's menu. Please note that the
190window manager protocol handler associated with this protocol (by the
191\&\fBprotocol\fR method) is not deleted automatically. You have to
192delete the protocol handle explicitly. E.g.:
193.Sp
194\&\ \fI$mw\fR\->\fBmwmProtocol\fR(\fB'delete'\fR => '\s-1MY_PRINT_HELLO\s0');
195.Sp
196\&\ \fI$mw\fR\->\fBprotocol\fR(\fB'\s-1MY_PRINT_HELLO\s0'\fR => '');
197.SH "BUGS"
198.IX Header "BUGS"
199This is a Tix extension which perl/Tk has adopted. It has not been
200tested as perl/Tk's author has not got round to installing a Motif Window
201Manager.
202.PP
203On some versions of mwm, the \fB\-border\fR will not disappear unless
204\&\fB\-resizeh\fR is turned off. Also, the \fB\-title\fR will not disappear
205unless all of \fB\-title\fR, \fB\-menu\fR, \fB\-maximize\fR and
206\&\fB\-minimize\fR are turned off.
207.SH "SEE ALSO"
208.IX Header "SEE ALSO"
209Tk::Wm
210Tk::tixWm
211Tk::Toplevel
212.SH "KEYWORDS"
213.IX Header "KEYWORDS"
214window manager, mwm, \s-1TIX\s0
215.SH "AUTHOR"
216.IX Header "AUTHOR"
217Ioi Kim Lam \- ioi@graphics.cis.upenn.edu