Blob Blame History Raw
'\" t
...\" ActivP.sgm /main/10 1996/09/25 10:07:11 cdedoc $
.de P!
.fl
\!!1 setgray
.fl
\\&.\"
.fl
\!!0 setgray
.fl			\" force out current output buffer
\!!save /psv exch def currentpoint translate 0 0 moveto
\!!/showpage{}def
.fl			\" prolog
.sy sed -e 's/^/!/' \\$1\" bring in postscript file
\!!psv restore
.
.de pF
.ie     \\*(f1 .ds f1 \\n(.f
.el .ie \\*(f2 .ds f2 \\n(.f
.el .ie \\*(f3 .ds f3 \\n(.f
.el .ie \\*(f4 .ds f4 \\n(.f
.el .tm ? font overflow
.ft \\$1
..
.de fP
.ie     !\\*(f4 \{\
.	ft \\*(f4
.	ds f4\"
'	br \}
.el .ie !\\*(f3 \{\
.	ft \\*(f3
.	ds f3\"
'	br \}
.el .ie !\\*(f2 \{\
.	ft \\*(f2
.	ds f2\"
'	br \}
.el .ie !\\*(f1 \{\
.	ft \\*(f1
.	ds f1\"
'	br \}
.el .tm ? font underflow
..
.ds f1\"
.ds f2\"
.ds f3\"
.ds f4\"
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n 
.TH "XmActivateProtocol" "library call"
.SH "NAME"
\fBXmActivateProtocol\fP \(em A VendorShell function that activates a protocol
.iX "XmActivateProtocol"
.iX "VendorShell functions" "XmActivateProtocol"
.iX "protocols"
.SH "SYNOPSIS"
.PP
.nf
#include <Xm/Protocols\&.h>
\fBvoid \fBXmActivateProtocol\fP\fR(
\fBWidget \fBshell\fR\fR,
\fBAtom \fBproperty\fR\fR,
\fBAtom \fBprotocol\fR\fR);
.fi
.SH "DESCRIPTION"
.PP
\fBXmActivateProtocol\fP activates a protocol\&. It
updates the handlers and the \fIproperty\fP if
the \fIshell\fP is realized\&. It is sometimes useful to allow
a protocol\&'s state information (callback lists, and so on) to persist, even though
the client may choose to temporarily resign from the interaction\&. This is
supported by allowing a \fIprotocol\fP to be in one of two states: active or
inactive\&. If the \fIprotocol\fP is active and the \fIshell\fP is realized,
the \fIproperty\fP contains the \fIprotocol\fP \fBAtom\fP\&.
If the \fIprotocol\fP is inactive, the \fBAtom\fP is not present in
the \fIproperty\fP\&.
.PP
\fBXmActivateWMProtocol\fP is a convenience interface\&.
It calls \fBXmActivateProtocol\fP
with the property value set to the atom returned by
interning \fBWM_PROTOCOLS\fP\&.
.IP "\fIshell\fP" 10
Specifies the widget with which the protocol property is associated
.IP "\fIproperty\fP" 10
Specifies the protocol property
.IP "\fIprotocol\fP" 10
Specifies the protocol \fBAtom\fP
.PP
For a complete definition of VendorShell and its associated resources, see
\fBVendorShell\fP(3)\&.
.SH "RELATED"
.PP
\fBVendorShell\fP(3), \fBXmActivateWMProtocol\fP(3),
\fBXmRemoveProtocols\fP(3)
and \fBXmInternAtom\fP(3)\&.
...\" created by instant / docbook-to-man, Sun 22 Dec 1996, 20:17