Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

mrmfetchwidget(3) [redhat man page]

MrmFetchWidget(library call)											      MrmFetchWidget(library call)

NAME
MrmFetchWidget -- Fetches and creates an indexed (UIL named) application widget and its children SYNOPSIS
#include <Mrm/MrmPublic.h> Cardinal MrmFetchWidget( MrmHierarchy hierarchy_id, String index, Widget parent_widget, Widget *widget, MrmType *class); DESCRIPTION
The MrmFetchWidget function fetches and creates an indexed application widget and its children. The indexed application widget is any wid- get that is named in UIL. In fetch operations, the fetched widget's subtree is also fetched and created. This widget must not appear as the child of a widget within its own subtree. MrmFetchWidget does not execute XtManageChild for the newly created widget. All widgets fetched by a call to MrmFetchWidget are not managed at the time of their creation callbacks. hierarchy_id Specifies the ID of the UID hierarchy that contains the interface definition. The value of hierarchy_id was returned in a previ- ous call to MrmOpenHierarchyPerDisplay. index Specifies the UIL name of the widget to fetch. parent_widget Specifies the parent widget ID. widget Returns the widget ID of the created widget. class This argument must be set to an actual pointer; it cannot be a NULL pointer. MrmFetchWidget sets this argument to an implementa- tion dependent value. An application can fetch any named widget in the UID hierarchy using MrmFetchWidget. MrmFetchWidget can be called at any time to fetch a widget that was not fetched at application startup. MrmFetchWidget can be used to defer fetching pop-up widgets until they are first ref- erenced (presumably in a callback), and then used to fetch them once. MrmFetchWidget can also create multiple instances of a widget (and its subtree). In this case, the UID definition functions as a template; a widget definition can be fetched any number of times. An application can use this template to make multiple instances of a widget, for example, in a dialog box box or menu. The index (UIL name) that identifies the widget must be known to the application. RETURN
This function returns one of the following status return constants: MrmSUCCESS The function executed successfully. MrmBAD_HIERARCHY The hierarchy ID was invalid. MrmNOT_FOUND The widget was not found in UID hierarchy. MrmFAILURE The function failed. RELATED
MrmOpenHierarchyPerDisplay(3), MrmFetchWidgetOverride(3). MrmFetchWidget(library call)

Check Out this Related Man Page

MrmFetchWidgetOverride(library call)									      MrmFetchWidgetOverride(library call)

NAME
MrmFetchWidgetOverride -- Fetches any indexed (UIL named) application widget. It overrides the arguments specified for this application widget in UIL SYNOPSIS
#include <Mrm/MrmPublic.h> Cardinal MrmFetchWidgetOverride( 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 limited 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 parameters. hierarchy_id Specifies the ID of the UID hierarchy that contains the interface definition. The value of hierarchy_id was returned in a previ- ous call to MrmOpenHierarchyPerDisplay. index Specifies the UIL name of the widget to fetch. parent_widget Specifies the parent widget ID. override_name Specifies the name to override the widget name. Use a NULL value if you do not want to override the widget name. override_args Specifies the override argument list, exactly as given to XtCreateWidget (conversion complete and so forth). Use a NULL value if you do not want to override the argument list. override_num_args Specifies the number of arguments in override_args. 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.h. RETURN VALUE
This function returns one of the following status return constants: MrmSUCCESS The function executed successfully. MrmBAD_HIERARCHY The hierarchy ID was invalid. MrmNOT_FOUND The widget was not found in UID hierarchy. MrmFAILURE The function failed. RELATED
MrmOpenHierarchyPerDisplay(3), MrmFetchWidget(3). MrmFetchWidgetOverride(library call)
Man Page