Museum

 MrmFetchWidgetOverride(Xm)     6 January 1993     MrmFetchWidgetOverride(Xm)


 Name

    MrmFetchWidgetOverride - fetches any indexed (UIL named) application
    widget. It overrides the arguments specified for this application widget
    in UIL

 Syntax


    #include <Mrm/MrmPublic.h>

    Cardinal MrmFetchWidgetOverride(hierarchy_id, index, parent_widget,
                                    override_name, override_args,
                                    override_num_args,
                                    widget, class)
    MrmHierarchy hierarchy_id;
    String index;
    Widget parent_widget;
    String override_name;
    ArgList override_args;
    Cardinal override_num_args;
    Widget *widget;
    MrmType *class;


 Description

    The MrmFetchWidgetOverride function is the extended version of
    MrmFetchWidget.  It is identical to MrmFetchWidget, except that it allows
    the caller to override the widget's name and any arguments that
    MrmFetchWidget would otherwise retrieve from the UID file or one of the
    defaulting mechanisms.  That is, the override argument list is not lim-
    ited to those arguments in the UID file.

    The override arguments apply only to the widget fetched and returned by
    this function. Its children (subtree) do not receive any override parame-
    ters.

    hierarchyid
            Specifies the ID of the UID hierarchy that contains the interface
            definition.  The hierarchyid was returned in a previous call to
            MrmOpenHierarchyPerDisplay.

    index   Specifies the UIL name of the widget to fetch.

    parentwidget
            Specifies the parent widget ID.

    overridename
            Specifies the name to override the widget name.  Use a NULL value
            if you do not want to override the widget name.

    overrideargs
            Specifies the override argument list, exactly as given to XtCre-
            ateWidget (conversion complete and so forth).  Use a NULL value
            if you do not want to override the argument list.

    overridenumargs
            Specifies the number of arguments in overrideargs.

    widget  Returns the widget ID of the created widget.

    class   Returns the class code identifying MRM's widget class.  Literals
            identifying MRM widget class codes are defined in the include
            file <Mrm/MrmPublic.F>.

 Return value

    This function returns one of these status return constants:

    MrmSUCCESS
            The function executed successfully.

    MrmBADHIERARCHY
            The hierarchy ID was invalid.

    MrmNOTFOUND
            The widget was not found in UID hierarchy.

    MrmFAILURE
            The function failed.

 See also

    MrmOpenHierarchyPerDisplay(Xm) and MrmFetchWidget(Xm).