DESIGN (xvforms) functions


LIBRARY ROUTINE

xvf_get_xvobject - return desired xvobject component of kformstruct

LIBRARY CALL

xvobject xvf_get_xvobject(
    kform_struct *kformstruct,
    int          item_part,
    int          create)

INPUT

OUTPUT

none

RETURN VALUE

The xvobject associated with the kformstruct on success. If 'create' is TRUE, NULL is returned only on failure; If 'create' is FALSE, NULL is returned when the xvobject has not yet been created.

DESCRIPTION

Given a pointer to a kformstruct, and an "item_part" indicator, returns the desired xvobject associated with the selection represented by the kformstruct, so that the application may make changes to its GUI items using xvw_set_attributes() which may not be supported by xvf_set_attributes().

NOTE: Please see xvf_set_attributes() before using this more difficult method of implementing GUI changes.

Depending on the type of GUI item, it may be made up of one or many xvobjects. For example, an action button consists only of a button GUI object. A Float selection, however, will have at least a backplane, a label object, and a text object. If it is optional, it will also have a small button object that serves as the optional box; if it is "live", it will have a pixmap object to display the stylized <cr> sign, and it may also contain a scrollbar object. The "item_part" argument is used to specify which part of the GUI item is desired.

For example, when passed a kformstruct associated with an Action Button and an "item_part" of XVF_BUTTON_OBJ, xvf_get_xvobject() will return the xvobject which is the GUI button object. When passed a kformstruct associated with an InputFile selection, and an "item_part" of XVF_BACKPLANE, xvf_get_xvobject() will return the xvobject which serves as the backplane for the InputFile selection. If an "item_part" is requested which does not exist in the GUI item represented by the kformstruct, an error message will be printed and NULL will be returned.

Legal Item Parts Include:

XVF_BACKPLANE : The backplane of the GUI item. XVF_OPT_OBJ : The optional box of a GUI item (optional selection only). XVF_BUTTON_OBJ : The button on a GUI item (GUI buttons, cycles, lists, etc) XVF_LABEL_OBJ : The label on a GUI item XVF_TEXT_OBJ : The text box of a GUI selection XVF_SCROLL_OBJ : Scrollbar of a Float, Integer, or Double selection XVF_PIXMAP_OBJ : Stylized <cr> pixmap of a "live" selection

ADDITIONAL INFORMATION

none

EXAMPLES

none

SIDE EFFECTS

none

RESTRICTIONS

none

MODIFICATION

none

FILES

$DESIGN/objects/library/xvforms/src/get.c

SEE ALSO

xvforms(3)

COPYRIGHT

Copyright (C) 1993 - 1997, Khoral Research, Inc. ("KRI") All rights reserved.