Blob Blame History Raw
'\" t
...\" FetchWiB.sgm /main/10 1996/09/08 21:25:30 rws $
.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 "MrmFetchWidgetOverride" "library call"
.SH "NAME"
\fBMrmFetchWidgetOverride\fP \(em Fetches any indexed (UIL named) application widget\&.  It overrides the arguments specified for this application widget in UIL
.iX "MrmFetchWidgetOverride"
.iX "uil functions" "MrmFetchWidgetOverride"
.SH "SYNOPSIS"
.PP
.nf
#include <Mrm/MrmPublic\&.h>
\fBCardinal \fBMrmFetchWidgetOverride\fP\fR(
\fBMrmHierarchy \fBhierarchy_id\fR\fR,
\fBString \fBindex\fR\fR,
\fBWidget \fBparent_widget\fR\fR,
\fBString \fBoverride_name\fR\fR,
\fBArgList \fBoverride_args\fR\fR,
\fBCardinal \fBoverride_num_args\fR\fR,
\fBWidget *\fBwidget\fR\fR,
\fBMrmType *\fBclass\fR\fR);
.fi
.iX "MRM function" "MrmFetchWidgetOverride"
.iX "MrmFetchWidgetOverride" "definition"
.SH "DESCRIPTION"
.PP
The \fBMrmFetchWidgetOverride\fP function
.iX "MrmFetchWidgetOverride" "description"
is the extended version of \fBMrmFetchWidget\fP\&.
It is identical to \fBMrmFetchWidget\fP, except that it
allows the caller to override the widget\&'s name and any
arguments that \fBMrmFetchWidget\fP
would otherwise retrieve from the UID file or
one of the defaulting mechanisms\&.
That is, the override argument list is not
limited to those arguments in the UID file\&.
.PP
The override arguments apply only to the widget fetched and
returned
by this function\&.
Its children (subtree) do not receive any
override
parameters\&.
.IP "\fIhierarchy_id\fP" 10
Specifies the ID of the UID hierarchy that contains
the interface definition\&.
The value of \fIhierarchy_id\fP
was returned in a previous call to \fBMrmOpenHierarchyPerDisplay\fP\&.
.IP "\fIindex\fP" 10
Specifies the UIL name of the widget to fetch\&.
.IP "\fIparent_widget\fP" 10
Specifies the parent widget ID\&.
.IP "\fIoverride_name\fP" 10
Specifies the name to override the widget name\&.
Use a NULL value if you do not want to override the widget name\&.
.IP "\fIoverride_args\fP" 10
Specifies the override argument list, exactly as given to
\fBXtCreateWidget\fP
(conversion complete and so forth)\&.
Use a
NULL value if you do not want to override the argument list\&.
.IP "\fIoverride_num_args\fP" 10
Specifies the number of arguments in
\fIoverride_args\fP\&.
.IP "\fIwidget\fP" 10
Returns the widget ID of the created widget\&.
.IP "\fIclass\fP" 10
Returns the class code identifying MRM\&'s widget class\&.
Literals identifying MRM widget class codes are defined in
the include file \fBMrm/MrmPublic\&.h\fP\&.
.SH "RETURN VALUE"
.iX "MrmSUCCESS"
.iX "MrmBAD_HIERARCHY"
.iX "MrmNOT_FOUND"
.iX "MrmFAILURE"
.PP
This function returns one of the following status return constants:
.IP "\fBMrmSUCCESS\fP" 10
The function executed successfully\&.
.IP "\fBMrmBAD_HIERARCHY\fP" 10
The hierarchy ID was invalid\&.
.IP "\fBMrmNOT_FOUND\fP" 10
The widget was not found in UID hierarchy\&.
.IP "\fBMrmFAILURE\fP" 10
The function failed\&.
.SH "RELATED"
.PP
\fBMrmOpenHierarchyPerDisplay\fP(3),
\fBMrmFetchWidget\fP(3)\&.
...\" created by instant / docbook-to-man, Sun 22 Dec 1996, 20:17