DESIGN (xvforms) library


LIBRARY NAME

xvforms - (no short description specified)

DESCRIPTION

The xvforms library (libxvf.a) provides all the functionality necessary to create and maintain the graphical user interface (GUI) of a software object, where the GUI is defined by a User Interface Specification (UIS) file.

Routines available in the xvforms library include routines to create a graphical user interface, run a graphical user interface, and change a graphical user interface during application execution.

Calls to some of the xvforms routines must be made in the main driver of every xvroutine. The required calls to these routines are generated automatically.

The xvforms library also includes other routines for modifying, maintaining, and changing the operation of the GUI of an xvroutine; calls to these routines may be added as desired. Of special interest is xvf_set_attribute(), which allows you to change the GUI of your xvroutine during execution.

Note that ONLY XVROUTINES may call routines in the xvforms library directly. Kroutines, pane objects, and script objects are limited in that they may only have their GUIs displayed by another program, that program being an xvroutine such as preview, guise, cantata, or xvrun.

LIST OF LIBRARY FUNCTIONS

xvf_add_gui_callback
add callback to a GUI item
xvf_remove_gui_callback
remove callback from GUI item
xvf_set_attributes
set multiple attributes of a GUI item
xvf_get_attributes
get multiple attributes of a GUI item
xvf_vset_attributes
set attributes of GUI items / UIS lines u sing existing variable argument list
xvf_vget_attributes
get attributes of GUI items / UIS lines u sing existing variable argument list
xvf_clear_selections
reset GUI items of xvroutine
xvf_create_form
create and map GUI of xvroutine
xvf_build_form
create and map GUI of xvroutine (New API for Khoros 2.1p1, takes UIS struct, not UIS filename)
xvf_destroy_allforms
destroy all forms
xvf_destroy_form
destroy GUI of xvroutine & free associated memory
xvf_destroy_subform
destroy subform & free associated memory
xvf_add_extra_call
add function call to GUI item
xvf_remove_extra_call
remove function call from GUI item
xvf_get_xvobject
return desired xvobject component of kformstruct
xvf_get_kformstruct
return kformstruct associated w/ xvobject
xvf_run_form
run the GUI of an xvroutine
xvf_set_attribute
set a single attribute of a GUI item
xvf_get_attribute
get a single attribute of a GUI item

ADDITIONAL INFORMATION

LOCATION OF SOURCE FILES

$DESIGN/objects/library/xvforms/src

LOCATION OF PUBLIC INCLUDE FILE

$DESIGN/include/xvforms/xvforms.h

YOU MUST INCLUDE

#include <design.h>

SEE ALSO

xvutils(3).

SEE MANUAL

The xvforms library is documented in Chapter 5, "The xvforms library" of the Khoros Program Services Manual, Volume III, "GUI & Visualization Services".

COPYRIGHT

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